Magento2 breeze compat audit
Skill muon-m2/magento2-tools/skills/magento2-breeze-compat-audit
End-to-end Magento 2 engineering skills — Claude Code pluginFrom the repository description
npx -y skills add muon-m2/magento2-tools --skill magento2-breeze-compat-auditAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
One thing to look at
- 6 stars6 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.
SKILL.md
5.9 KB, as published. Nobody here has run it
Magento 2 Breeze Compatibility Audit
Static, read-only audit that tells you whether an existing module will work with a Swissup Breeze theme. Breeze replaces RequireJS/Knockout/jQuery with a Cash-based stack, so modules that lean on those APIs need either Breeze's "Better Compatibility" mode or a hand-written adapter.
Core Rules
- Static-first. Default pass uses only the source tree — no runtime, no Magento CLI required.
- Read-only. Never modifies code. Findings route to
magento2-breeze-module-adaptfor fixes. - Breeze-aware. Resolve
magento2-context; readtheme.breeze. Ifinstalledisfalse, note it (the audit still runs, but the verdict says "Breeze not installed"). - Severity by user-facing breakage. A Knockout checkout component is High; a
data-mage-inithook Breeze already supports is Info. - Concrete remediation. Every finding names the specific Breeze fix (port to a Cash
$.widget, enable Better Compatibility, move CSS tobreeze/_default.less) and whethermagento2-breeze-module-adaptcan scaffold it. - JSON + SARIF. Same shape as
magento2-module-review(outputKind=compatibility).
Workflow
Phase 0 — Context Resolution
Invoke magento2-context. Capture theme.breeze, vendor, magento_root.
Phase 1 — Scope
- Single module → scan that module subtree.
- Multiple modules / site → scan each custom module under
app/code.
Phase 2 — Static Scan
Run scripts/static-scan.sh <target> per references/breeze-compat-checklist.md:
| Check | Pattern | Severity |
|---|---|---|
| RequireJS config | requirejs-config.js present | Medium (High if mixins) |
| RequireJS mixins | mixins in requirejs-config.js | High |
| Knockout / uiComponent | 'uiComponent', Magento_Ui/js/, data-bind | High |
| jQuery widget | $.widget(, $.mage. | Medium |
| Inline require | require([...]) in .phtml | Medium |
| mage-init | data-mage-init, text/x-magento-init | Info (Breeze supports) |
| No adapter yet | ships view/frontend/web but no breeze_*/web/css/breeze | Info |
Phase 3 — Verdict & Emit
Run scripts/build-findings.sh to emit JSON + SARIF (and render the Markdown report).
Run it with DOCS_ROOT=<output_root> (the resolved --docs-root value, or .docs by
default) so both artifacts land under {output_root}/breeze-compat/. Classify:
- Compatible out-of-box — only Info findings (mage-init / no-adapter).
- Needs Better Compatibility — RequireJS/mixins/jQuery-widget findings, no Knockout.
- Needs manual adapter — Knockout/uiComponent findings present.
Point the user at magento2-breeze-module-adapt for the fix.
Inputs
/magento2-breeze-compat-audit <Vendor_Module> [--scope=module|site] [--docs-root=<path>]
Outputs
Module scope (basename uses the underscore module name, e.g. Acme_Foo):
{output_root}/breeze-compat/{Vendor}_{Module}-breeze-compat-{YYYY-MM-DD}.{json,sarif}
Site scope: {output_root}/breeze-compat/breeze-compat-{scope}-{YYYY-MM-DD}.{json,sarif}
— plus a Markdown summary sharing the same basename. Findings follow
magento2-context/references/findings-schema.md. {output_root} defaults to .docs
({ctx.docs_root}); see the --docs-root/DOCS_ROOT recipe in
magento2-context/references/artifact-layout.md.
Output root (--docs-root)
This skill accepts --docs-root=<path> (see
magento2-context/references/artifact-layout.md). When set, run the emitter with
DOCS_ROOT=<path> so artifacts land under <path>/breeze-compat/; otherwise they default
to {ctx.docs_root}/breeze-compat/. Orchestrators such as magento2-feature-implement
pass this to collect a run's artifacts under one folder.
Reference Files
references/breeze-compat-checklist.md— the full check table with patterns, severities, and Breeze remediation per row.magento2-context/references/severity.md— the shared five-point severity scale the per-row severities calibrate against.magento2-context/references/findings-schema.md— JSON findings-document structure (outputKind=compatibility).
Scripts
scripts/static-scan.sh— emits the findings array for a module subtree.scripts/build-findings.sh— aggregates and emits JSON + SARIF via the shared emitters.
Acceptance Criteria
- Produces
{Vendor}_{Module}-breeze-compat-{date}.json(module scope; site scope:breeze-compat-{scope}-{date}.json) withoutputKind=compatibility,findings[],scanner_errors[], and.sarif. - Each finding has a severity,
file:lineevidence, and a concrete Breeze remediation. - Emits a verdict (compatible / Better Compatibility / manual adapter).
- Never modifies the scanned module.
Related Skills
| Phase | Skill |
|---|---|
| 0 | magento2-context |
| (sibling) | magento2-module-review for general architecture/quality |
| (fix) | magento2-breeze-module-adapt to generate the adapter |
| (theme) | magento2-breeze-child-theme for a new Breeze theme |