Skip to content

docs: explain plugin scaffolding and generator troubleshooting - #2473

Draft
somethings (lasomethingsomething) wants to merge 9 commits into
mainfrom
docs/scaffolding-q-and-a-findings
Draft

docs: explain plugin scaffolding and generator troubleshooting#2473
somethings (lasomethingsomething) wants to merge 9 commits into
mainfrom
docs/scaffolding-q-and-a-findings

Conversation

@lasomethingsomething

Copy link
Copy Markdown
Contributor

Summary

Adds a focused guide explaining how Shopware plugin scaffolding works as coordinated framework wiring rather than isolated file generation.

The guide is based on a hands-on walkthrough of current bin/console plugin:create scaffolding and cross-checked against current shopware/shopware scaffolding generators and the proposed shopware-cli extension create generator stories.

It covers:

  • namespace / PSR-4 troubleshooting
  • Symfony service tags and discovery
  • route discovery vs actual reachability
  • command verification through bin/console
  • scheduled-task registration and current Core generator behavior
  • config-field validation vs Administration visibility
  • Administration build vs module discovery
  • test generation vs existing PHPUnit infrastructure
  • a reusable troubleshooting sequence for developers and coding assistants
  • clear separation between current Core behavior and proposed Shopware CLI work (UML diagrams #1255 / Fix semicolon spacing #1280)

This is intended to fill the explanatory gap between "here are the files to create" and "here is how the pieces cooperate and how to prove the feature works."

@shopware-dev-docs-connector

shopware-dev-docs-connector Bot commented Aug 21, 2026

Copy link
Copy Markdown

Developer Docs healthcheck

Status: Completed with success.
Repository: shopware/docs
Commit: 0020d42
Preview: https://developer-documentation-51t10jjvp-shopware-frontends.vercel.app
Workflow run: #5006

Adds Storefront controller lifecycle guide explaining how controller class,
route attributes, routing import, service registration, and cache connect.

Warns about generated plugin base class name mismatches when plugin name does
not follow UpperCamelCase, which can cause PluginBaseClassNotFoundException
during installation even when plugin:refresh succeeds.

Links lifecycle guides from index pages and remaining documentation.

Aligns all lifecycle pages with repo formatting conventions (frontmatter
blank lines, consistent command formatting, improved phrasing).

Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.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.

2 participants