docs: correct shopware-cli verifier reference against source - #2499
docs: correct shopware-cli verifier reference against source#2499somethings (lasomethingsomething) wants to merge 7 commits into
Conversation
Developer Docs healthcheckStatus: Completed with |
9d4e6d3 to
7068d22
Compare
d7d582c to
f69d2bd
Compare
📢 Developer Announcement RecommendationRecommendation: ❌ No Announcement Recommended No developer announcement signals were detected.
|
There was a problem hiding this comment.
🟡 Changes recommended
There are a few documentation correctness/formatting issues in the changed lines (including a mis-specified Markdown table separator and minor grammar/unit formatting) that should be fixed before approval.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
This PR updates the Shopware CLI documentation to match current shopware/shopware-cli behavior, focusing on verifier tooling flags, command semantics, and project/extension workflows so readers don’t follow outdated or incorrect guidance.
Changes:
- Updated validation docs to reflect
--format(deprecating--reporter) and clarified which verifier tools actually validate, fix, or format. - Expanded
project validate,project fix, andproject formatdocumentation around discovery behavior, options, and tool execution semantics. - Added/updated CLI runtime and environment variable requirements, plus refreshed related guidance (SBOM, MJML build-time compilation, bundle configuration).
File summaries
| File | Description |
|---|---|
| products/tools/cli/validation.md | Updates output format flag and clarifies verifier tool behavior across validate/fix/format. |
| products/tools/cli/project-commands/helper-commands.md | Aligns project validate examples/options with current CLI behavior and flags. |
| products/tools/cli/project-commands/build.md | Refreshes project ci documentation (SBOM, CI detection, MJML, build hooks, bundles). |
| products/tools/cli/project-commands/autofix.md | Clarifies project autofix composer-plugins behavior, including headless mode/token usage. |
| products/tools/cli/installation.md | Adds environment variable reference and clarifies build-from-source prerequisites. |
| products/tools/cli/index.md | Documents verifier tooling runtime requirements and when they apply. |
| products/tools/cli/formatter.md | Clarifies formatting commands, tooling, and configuration behavior. |
| products/tools/cli/automatic-refactoring.md | Reframes “refactoring” as fix commands and documents tool scope/version behavior. |
| guides/development/testing/store/content-and-translations.md | Updates Store content guidelines wording/capitalization and favicon sizing guidance. |
| .wordlist.txt | Adds newly used terms to the spellcheck wordlist. |
Review details
- Files reviewed: 10/10 changed files
- Comments generated: 3
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: lasomethingsomething <2453640+lasomethingsomething@users.noreply.github.com>
Every statement changed here was checked against
shopware/shopware-cliatorigin/main. The CLI pages had drifted from the implementation in ways that would send developers down dead ends: flags that don't exist, and tools documented as doing work they no longer do.After filing the PR I did a hands-on tour to test out how various mentioned commands work, following these flows:
What changed
validate,fix, andformat.project autofix composer-pluginsbehavior, including headless mode and token handling.Checklist
PageRefreferences where relevant..gitbook.yamlif pages were moved, renamed, or deleted..wordlist.txt(and sorted it) if spellcheck flags new legitimate terms.🤖 Generated with Claude Code; reviewed and edited by a human