Skip to content

[docs] Document progress reporting for validate/format/fix commands - #2660

Closed
shopware-docs-updater[bot] wants to merge 1 commit into
mainfrom
docs/progress-reporting-pr1718-b68256b0e67311a5
Closed

shopware-docs-updater[bot] wants to merge 1 commit into
mainfrom
docs/progress-reporting-pr1718-b68256b0e67311a5

Conversation

@shopware-docs-updater

Copy link
Copy Markdown
Contributor

Summary

  • shopware/shopware-cli#1718 added stderr progress reporting (Running ... / Finished ... / Failed ... lines with elapsed time) for extension validate, project validate, extension fix, project fix, extension format, and project format when using the default/summary report format. This is new user-facing CLI output behavior that was previously undocumented.
  • Added a new "Progress reporting" subsection to products/tools/cli/validation.md explaining when progress lines are printed, which stages they cover (copying files, discovering configuration, preparing tools, each checker/fixer/formatter), how failures and cancellation (Ctrl+C) are reported, and that it is suppressed for json, junit, github, gitlab, and markdown formats.
  • Added short cross-reference notes in products/tools/cli/formatter.md and products/tools/cli/automatic-refactoring.md pointing to the new section, since format and fix commands also emit this progress output.

Related links

Files changed

  • products/tools/cli/validation.md
  • products/tools/cli/formatter.md
  • products/tools/cli/automatic-refactoring.md

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. (not applicable — no pages moved)
  • I updated .wordlist.txt (and sorted it) if spellcheck flags new legitimate terms. (not applicable — no new terms introduced)
  • I listed every dependent pull request that is not merged yet under Dependent PRs below. (none — source PR is already merged)
  • Dependent changes that must be released, not only merged, before this documentation goes live have been published. (source PR is merged)
  • This pull request is ready for review.

Dependent PRs

Notes

Validation: documentation-only change; no code/tests run. Markdown style follows existing conventions in the edited files (tables, fenced code blocks, heading levels). pnpm/rumdl were not available in this sandbox to run check:markdown locally.

Generated by 📝 PR documentation check for #1718 · copilot · auto · 58.3 AIC · ⌖ 7.52 AIC · ⊞ 8.2K · ◷

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@shopware-dev-docs-connector

Copy link
Copy Markdown

Developer Docs healthcheck

Status: Running.
Repository: shopware/docs
Commit: b47322a
Preview: Waiting for workflow logs.

@MalteJanz

Copy link
Copy Markdown
Contributor

Will close this as I don't think documenting this output is helpful (its self explanatory) and it might even change again in the near future. Some additional insights / feedback:
shopware/shopware-cli#1718 (comment)

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.

1 participant