Document Twig block versioning in Shopware Toolbox - #2413
Open
Soner (shyim) wants to merge 1 commit into
Open
Conversation
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Developer Docs healthcheckStatus: Completed with |
Contributor
📊 Documentation Impact Analyzer
Reasons
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR extends the Shopware Toolbox documentation to explain the Twig block versioning feature of the Shopware PHPStorm plugin, including the required comment format and how to apply it across a project.
Changes:
- Added a “Twig block versioning” section explaining why the feature exists and how it works.
- Documented the
shopware-blockcomment format with an example. - Added documentation for related inspections, intentions, and the “Inspect Code” workflow to bulk-add versioning comments.
Comments suppressed due to low confidence (1)
guides/development/tooling/shopware-toolbox.md:59
- Table cells contain multi-sentence text that ends with periods. The documentation guidelines recommend not ending table sentences/cells with punctuation. Rephrase these cells so they end without punctuation (and ideally keep each cell to a single sentence).
| The upstream block has changed | Yes | The recorded hash no longer matches the upstream block. Check that your override is still correct. |
| The upstream block has been removed | Yes | The block no longer exists upstream. Check that your override is still needed. |
| Twig block is deprecated | Yes | The upstream block is marked as deprecated and will be removed in a future version. |
| Shopware versioning block comment is missing | No | A block override has no versioning comment yet. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+52
to
+55
| #### Inspections | ||
|
|
||
| | Inspection | Enabled by default | Reported when | | ||
| |---|---|---| |
somethings (lasomethingsomething)
approved these changes
Jul 30, 2026
Contributor
|
Su (@sushmangupta) Micha Hobert (@Isengo1989) Heya, could one of you give this a quick look? |
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
{# shopware-block: <hash>@<version> #}comment format with an example, the four related inspections and their defaults, the two intentions, and the Inspect Code workflow to add versioning comments to a whole project.Related links
Checklist
PageRefreferences where relevant..gitbook.yamlif pages were moved, renamed, or deleted. (No pages moved.).wordlist.txt(and sorted it) if spellcheck flags new legitimate terms. (No new terms; SHA and macOS are already listed.)Notes
Inspection display names, default states, and the comment format were verified against the plugin source (plugin.xml and TwigUtil on main), not only the blog post. Markdown lint (avtodev/markdown-lint with the repo config) passes for the changed file.
🤖 Generated with Claude Code