Skip to content

chore: adjust shopware-cli tools docs - #2547

Merged
Su (sushmangupta) merged 10 commits into
mainfrom
chore/adjust-shopware-cli-tools-docs
Oct 9, 2026
Merged

Su (sushmangupta) merged 10 commits into
mainfrom
chore/adjust-shopware-cli-tools-docs

Conversation

@MalteJanz

@MalteJanz Malte Janz (MalteJanz) commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Update Shopware CLI validation, refactoring, and formatting docs to cover:

  • All extension checkers running by default and deprecation of --full.
  • Renaming sw-cli to builtin, including the deprecated alias.
  • Tool selection, --exclude support for extension or project fix/format, and invocation reports.
  • Migration guidance for existing CI jobs.

Based on:

Checklist

  • I reviewed affected links, code samples, and cross-references, including PageRef references where relevant.
  • I added or updated redirects in .gitbook.yaml if pages were moved, renamed, or deleted.
  • I updated .wordlist.txt (and sorted it) if spellcheck flags new legitimate terms.
  • Any required dependent changes in downstream modules have already been merged and published.
  • This pull request is ready for review.

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.

@shopware-dev-docs-connector

shopware-dev-docs-connector Bot commented Sep 25, 2026 •

Copy link
Copy Markdown

Developer Docs healthcheck

Status: Completed with success.
Repository: shopware/docs
Commit: 142c583
Preview: https://developer-documentation-n2e2rg8vc-shopware-frontends.vercel.app
Workflow run: #5545

Comment thread products/tools/cli/validation.md

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟡 Changes recommended

Several pages incorrectly document admin-twig as a registered checker, fixer, and formatter.

Review effort: Balanced
Findings: 4 Low severity

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 --full deprecation
  • Adds --exclude, invocation reporting, and builtin alias 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.

Comment thread products/tools/cli/automatic-refactoring.md
Comment thread products/tools/cli/formatter.md
Comment thread products/tools/cli/formatter.md Outdated
Comment thread products/tools/cli/validation.md Outdated
Comment thread products/tools/cli/project-commands/helper-commands.md Outdated
Comment thread products/tools/cli/validation.md Outdated
Comment thread products/tools/cli/validation.md
Comment thread products/tools/cli/validation.md Outdated
Comment thread products/tools/cli/automatic-refactoring.md Outdated
Comment thread products/tools/cli/automatic-refactoring.md Outdated
Comment thread products/tools/cli/formatter.md Outdated
Comment thread products/tools/cli/formatter.md Outdated
@moshimorschi

Copy link
Copy Markdown

quickly let claude run over it to catch the newest changes that were made in the meantime, feel free to apply.

@Isengo1989 Micha Hobert (Isengo1989) added the Blocked Block PRs from merging label Oct 2, 2026
@sushmangupta
Su (sushmangupta) merged commit 077f6c9 into main Oct 9, 2026
8 checks passed
@sushmangupta
Su (sushmangupta) deleted the chore/adjust-shopware-cli-tools-docs branch October 9, 2026 09:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants