Repository navigation
chore: adjust shopware-cli tools docs - #2547
Open
Malte Janz (MalteJanz) wants to merge 8 commits into
Open
Malte Janz (MalteJanz) wants to merge 8 commits into
Malte Janz (MalteJanz) wants to merge 8 commits into
Conversation
Developer Docs healthcheckStatus: Completed with |
This was referenced Sep 30, 2026
Malte Janz (MalteJanz)
marked this pull request as ready for review
September 30, 2026 14:46
Malte Janz (MalteJanz)
requested review from
a team,
Anne (Ant1gua),
Micha Hobert (Isengo1989),
somethings (lasomethingsomething),
Lena Forlin (moshimorschi),
Soner (shyim),
Su (sushmangupta) and
Tomasz Turkowski (tturkowski)
and
a balanced review from Copilot
and removed request for
a team
September 30, 2026 14:46
Contributor
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
Several pages incorrectly document admin-twig as a registered checker, fixer, and formatter.
Review effort: Balanced
Findings: 4
Open (4)
What changed in this PR
Updates Shopware CLI documentation for revised validation defaults, tool selection, aliases, reports, and CI migration guidance.
Changes:
- Documents default execution of all extension checkers and
--fulldeprecation - Adds
--exclude, invocation reporting, andbuiltinalias guidance - Updates validation, fixing, and formatting examples
| File | Description |
|---|---|
products/tools/cli/validation.md |
Revises validation behavior and migration guidance |
products/tools/cli/project-commands/helper-commands.md |
Clarifies project checker selection |
products/tools/cli/index.md |
Updates verifier runtime requirements |
products/tools/cli/formatter.md |
Documents formatter selection and exclusion |
products/tools/cli/automatic-refactoring.md |
Documents fixer selection and exclusion |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Anne (Ant1gua)
approved these changes
Sep 30, 2026
| shopware-cli extension validate /path/to/your/extension --only builtin | ||
| ``` | ||
|
|
||
| The legacy name `sw-cli` is accepted in both `--only` and `--exclude` for extension and project validation, with a deprecation warning. Use `builtin` in new configurations. Reports, tool statuses, and selection errors use the canonical name `builtin`. |
There was a problem hiding this comment.
CI jobs that pass --only admin-twig or --exclude admin-twig fail after this release, and the changelog won't make that obvious (the removal commits are fix:/refactor: without !).
Suggested change
| The legacy name `sw-cli` is accepted in both `--only` and `--exclude` for extension and project validation, with a deprecation warning. Use `builtin` in new configurations. Reports, tool statuses, and selection errors use the canonical name `builtin`. | |
| The legacy name `sw-cli` is accepted in both `--only` and `--exclude` for extension and project validation, with a deprecation warning. Use `builtin` in new configurations. Reports, tool statuses, and selection errors use the canonical name `builtin`. | |
| The `admin-twig` tool has been removed. Remove it from `--only` and `--exclude`; both now reject it as an unknown tool. |
Contributor
Author
There was a problem hiding this comment.
Added
It also didn't do anything before.
As well to that, I hope that is correct, at least as far as I'm aware?
|
quickly let claude run over it to catch the newest changes that were made in the meantime, feel free to apply. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Update Shopware CLI validation, refactoring, and formatting docs to cover:
--full.sw-clitobuiltin, including the deprecated alias.--excludesupport for extension or project fix/format, and invocation reports.Based on:
Checklist
PageRefreferences where relevant..gitbook.yamlif pages were moved, renamed, or deleted..wordlist.txt(and sorted it) if spellcheck flags new legitimate terms.AI disclosure
Codex GPT-6-Sol did these changes next to my actual changes in the CLI. I also did a final pass with GPT-6.1-Sol to check that everything is adjusted based on all my CLI PRs.