Skip to content

docs: correct shopware-cli verifier reference against source - #2499

Open
somethings (lasomethingsomething) wants to merge 7 commits into
mainfrom
cli-updates-sept3
Open

docs: correct shopware-cli verifier reference against source#2499
somethings (lasomethingsomething) wants to merge 7 commits into
mainfrom
cli-updates-sept3

Conversation

@lasomethingsomething

@lasomethingsomething somethings (lasomethingsomething) commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

Every statement changed here was checked against shopware/shopware-cli at origin/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:

  • Shop → plugin → baseline → current main
  • Validate → ignore → revalidate
  • Detect XML → fix → YAML → revalidate
  • Ugly code → dry-run → format → clean
  • Basic validate → full validate → tool selection
  • Version range → lowest → stale highest → clean highest
  • Temp copy → no-copy → working tree
  • Source → raw ZIP → CLI package → clean ZIP
  • JSON → JUnit → GitHub annotations
  • Nested dir → project validate → project fix → project format
  • Bad metadata → extension fails → project passes
  • Project → local-only → local finding

What changed

  • Corrected documented flags and command behavior for validate, fix, and format.
  • Documented which verifier tools actually validate, fix, or format files.
  • Corrected project autofix composer-plugins behavior, including headless mode and token handling.
  • Clarified project discovery, validation options, runtime requirements, and fixer behavior.
  • Fixed several stale details, including MJML error handling, Symfony Flex migration wording, Go requirements, SBOM duplication, and broken cross-references.

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.

🤖 Generated with Claude Code; reviewed and edited by a human

@shopware-dev-docs-connector

shopware-dev-docs-connector Bot commented Sep 3, 2026

Copy link
Copy Markdown

Developer Docs healthcheck

Status: Completed with success.
Repository: shopware/docs
Commit: f71bcdd
Preview: https://developer-documentation-65zufc7d3-shopware-frontends.vercel.app
Workflow run: #5224

@lasomethingsomething
somethings (lasomethingsomething) marked this pull request as ready for review September 4, 2026 19:22
Copilot AI lite review requested due to automatic review settings September 4, 2026 19:22
@github-actions

github-actions Bot commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

📢 Developer Announcement Recommendation

Recommendation: ❌ No Announcement Recommended

No developer announcement signals were detected.

This PR does not appear to introduce developer-facing changes that require a community announcement.

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.

🟡 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, and project format documentation 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.

Comment thread guides/development/testing/store/content-and-translations.md Outdated
Comment thread products/tools/cli/project-commands/build.md Outdated
Comment thread products/tools/cli/validation.md
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants