µGulp Ready
Enhanced for µGulp. CLI compatible.
µGulp Ready means that a project, package or reusable Gulp building block intentionally adds useful µGulp-specific interaction or output, while keeping its underlying workflow usable through ordinary Gulp or a documented CLI. Merely running an ordinary Gulpfile in µGulp does not qualify.
Products and projects
Projects and libraries
| Logo | Product / package | Short description | Link |
|---|---|---|---|
![]() |
µGulp | Interactive Gulp dashboard for IDEs. | Website |
![]() |
microCSS | CSS, skins, sprite atlases and image processing. | GitHub |
| µLib™ | Modular JavaScript library for web interfaces. | GitHub | |
![]() |
microPhotoFrame | Wi-Fi e-ink photo frame with album management. | GitHub |
| BlueShift | Bridges classic Bluetooth and BLE. | GitHub | |
| ESP][ | Apple II emulator project for ESP32. | GitHub | |
| Extended Watchy Starfield | E-paper watch firmware for Watchy. | GitHub | |
| micro3D | Blender-based 3D editor in development. | GitHub | |
| i18x | Platform-independent translation format; µGulp integration in preparation. | GitHub |
npm
| Logo | Product / package | Short description | Link |
|---|---|---|---|
![]() |
gulp-mu-css | µCSS compiler and skin generation. | npm |
| gulp-mu-ps | PSD processing, image sequences and sprite atlases. | npm | |
| gulp-mu-au | Audio processing and sound atlases. | npm | |
| gulp-mu-ft | Icon fonts and webfont packages. | npm | |
| gulp-mu-build-filter | Source filters for build and product variants. | npm |
Ready claims cover repository development and build workflows, not runtime integration. They are supplied by maintainers. Entries marked as in preparation are not completed Ready integrations. GitHub and npm entries may belong to the same project.
Request a listing
Other developers are welcome. Send the product name, a public link, a one-sentence description, an optional project logo and a link to the documented µGulp integration to support@microgulp.dev. Suitable projects can be listed free of charge after review.
Minimum requirements
- Provide at least one meaningful integration. Use one of the features below in a real workflow. A badge, an installed API dependency, a cosmetic icon or a renamed task alone is not sufficient.
- Keep a documented CLI path. Explain how to run the underlying operation without the µGulp application, including prerequisites, inputs, defaults and output. The open task API may remain a dependency. A dashboard-only convenience may be unavailable on the CLI, but must not lock away the underlying operation.
- Verify the claim yourself. Run the documented example in µGulp and through the CLI; check a representative failure or cancellation and, where supported, noninteractive operation. Record the tested project/API/µGulp versions, host and date in your own documentation. Claim only the scope and platforms you checked.
- Identify the integration. Tell users which tasks or example provide it and how to reproduce the result. If the badge covers a repository's development tasks rather than the installed package, say so next to the badge or in a linked integration section.
- Follow the badge rules below and keep the claim current when the workflow changes.
Qualifying integration examples
- Parameters and forms: declare
µParametersand consume the values withGetParameter()/GetParameters(), or useRequestForm()to collect useful task inputs. - Task-reported progress and results: use
ReportProgress()for meaningful stages or progress; emit an artifact report throughLogTable(),LogTree(),LogKeyValue()or another supported structured-output helper. µGulp displays what the task reports; it does not infer build progress. - Interaction during a task: use
ShowModalMessage()orShowConfirmMessage()where the workflow benefits from an explanation or decision, with an explicit safe CLI path. - Watch and operational metadata: provide a useful
µWatchconfiguration, or actionable task behavior such asµEnabledwithµDisabledTooltip. Descriptive metadata can explain this behavior; decorative labels alone do not qualify. Gulp CLI ignores these properties, so document a normal task command or a separate CLI watch command where needed.
One useful integration is enough. No mandatory collection of all features, specific IDE, paid edition, API import for metadata-only integrations, or new package is required. Feature names describe existing interfaces; refer to the task API documentation and µGulp documentation for their full contracts.
CLI, CI and no lock-in
Keep exported Gulp task names callable. Use µ-prefixed display metadata instead of changing a CLI task's name just for presentation. Document a command such as npx gulp BUILD with the actual task name and prerequisites of your project.
GetParameter(id, fallback) reads MICROGULP_PARAMS or MICROGULP_PARAM_<ID> and then the explicit fallback. Plain Gulp does not apply a task's µParameters defaults for you. Flat environment values are strings: validate/coerce them in task code instead of treating the string "false" as a Boolean. Do not log passwords or secrets.
Progress and structured-output helpers have console fallbacks. Forms use terminal input when supported and declared defaults in non-TTY execution; document required inputs and fail clearly when they are missing. Visual parity is not required, but necessary results must remain accessible.
A modal is not a CLI approval gate. In the current API, ShowModalMessage() falls back to console output and returns { button: 'ok' }; ShowConfirmMessage() wraps it. An OK/Cancel confirmation therefore must not silently authorize publishing, deletion or another consequential action outside the dashboard. Detect the context with IsMicroGulp() and require an explicit CLI option/environment value or abort. Test this path without a TTY.
Self-certification and badge usage
This is maintainer self-certification, with no application, fee, registration or prior review. It is not an independent audit, security assessment, warranty, endorsement or official certification. Do not describe a project as “officially certified” or imply that the µGulp team reviewed it.
Developers whose project meets these published requirements may use the official µGulp Ready badge free of charge in README files, documentation, websites and package descriptions, including commercial projects. This permission covers the badge artwork for this purpose; it does not change the software's license or grant rights to other brand assets.
Use the supplied artwork without changing the logo, colors, wording or proportions. Scale it uniformly and keep it legible. Link it to this Ready page so readers can check its meaning. State the actual integration scope, avoid misleading claims, and remove or correct the badge if the requirements cease to be met. The µGulp maintainer reserves the right to object to misleading use and request correction or removal. Report concerns to support@microgulp.dev.
Optional package metadata may use "microgulp": { "ready": true }. This is a maintainer declaration, not an approval record or a registry listing. Legacy certifiedSince fields are historical labels, not proof of review; no metadata field or registry submission is required.
Add the badge
Use the original high-resolution PNG. It is the existing official artwork, unchanged. The recommended GitHub/npm README treatment is a small centered image, 110 pixels wide, with no fixed height. This preserves its aspect ratio. Other proportionate, legible sizes are allowed for websites, documentation and project cards.
<p align="center">
<a href="https://microgulp.dev/en/ready/">
<img src="https://microgulp.dev/assets/media/microgulp-ready.png" alt="µGulp Ready" width="110">
</a>
</p>
HTML works inside a Markdown README and is recommended when the renderer supports it. Download the HTML snippet.
For renderers that only support Markdown:
[](https://microgulp.dev/en/ready/)
Plain Markdown does not constrain the image width and may display the full 491-pixel image. Download the Markdown snippet. Use the absolute HTTPS image URL in npm descriptions. The stable English reference is /en/ready/; the German page is an equivalent localized target.
µGulp


