Skip to content

Clarify CLI formatter Docker requirements#2314

Open
Soner (shyim) wants to merge 2 commits into
mainfrom
clarify-cli-formatter-docker-dependencies
Open

Clarify CLI formatter Docker requirements#2314
Soner (shyim) wants to merge 2 commits into
mainfrom
clarify-cli-formatter-docker-dependencies

Conversation

@shyim
Copy link
Copy Markdown
Member

@shyim Soner (shyim) commented May 29, 2026

Summary

  • Explain that formatter, validation, and automatic refactoring commands use PHP and Node.js tooling under the hood
  • Clarify that Docker is recommended because the image includes those dependencies
  • Add context for the /ext and /project container mount paths versus local paths
  • Replace local validation examples that used /ext with /path/to/your/extension

Verification

  • git diff --check
  • Content assertion for expected clarification text
  • make spellcheck using Docker

Note: Two unrelated untracked talk files are present locally and were temporarily moved out before running the Docker spellcheck, then restored.

Copilot AI review requested due to automatic review settings May 29, 2026 11:37
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR clarifies the runtime/dependency expectations for the Shopware CLI formatter by explaining why Docker-based usage is recommended and how container mount paths (/ext, /project) relate to local filesystem paths.

Changes:

  • Document that the formatter relies on PHP and Node.js tooling, and that the Docker image bundles these dependencies.
  • Explain the Docker mount targets (/ext and /project) used in the formatter examples.
  • Add “without Docker” guidance to use local filesystem paths when running shopware-cli directly.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

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.

2 participants