mcpField
S
shopware-admin-crud-module

shopware-admin-crud-module

github.com/friendsofshopwareDevelopment1353 installsUpdated 34w ago
Repository

About shopware-admin-crud-module

A skill for building Shopware Administration CRUD modules for DAL entities. It guides module setup, list and detail pages, ACL, search, filters, and localization files using project reference patterns.

Key features

  1. 01Module registration and file structure
  2. 02List and detail page patterns
  3. 03ACL privilege mapping
  4. 04Search and filter setup
  5. 05Localization snippet scaffolding

Use cases

  1. 01Create an admin module for a DAL entity
  2. 02Add entity list and detail pages
  3. 03Configure module ACL privileges
  4. 04Scaffold administration translations

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/friendsofshopware/agent-skills --skill shopware-admin-crud-module

After installing, type/shopware-admin-crud-modulein Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

references/
_sections.md
_template.md
acl-privileges.md
module-registration.md
module-search-configuration.md
page-detail.md
page-list.md
snippet-structure.md

Details

From the project README

Shopware Administration CRUD Module

When to Apply

  • Creating a new admin module for a Shopware DAL entity
  • Adding list, detail, and create pages for an entity in the administration
  • Setting up ACL privileges for an admin module
  • Adding search, filters, and inline editing for entity listings
  • Scaffolding administration i18n snippets for a new module

Rule Categories by Priority

PriorityCategoryPrefixDescription
CRITICALModule Setupmodule-Module registration, file structure, naming conventions
CRITICALPagespage-List page and detail/create page patterns
HIGHACL & Searchacl-ACL privilege mapping and search configuration
MEDIUMSnippets & Filterssnippet-i18n snippet structure and filter setup

How to Use

When the user invokes this skill, ask them for:

  1. The entity name (DAL entity, e.g. webhook) -- if not provided as argument
  2. Which fields to show in the list and detail (or read from the EntityDefinition PHP class automatically)
  3. The module prefix to use (default: frosh-tools-<entity>)

Then read the relevant reference files from the references/ directory and generate all files following the patterns described there. The admin source root is src/Resources/app/administration/src/.

Naming Conventions
  • Module name: frosh-tools-<entity> (hyphenated)
  • Route prefix: frosh.tools.<entity> (dotted) -- derived from module name by replacing hyphens with dots
  • ACL key: frosh_tools_<entity> (underscored)
File Structure
module/<module-name>/
  index.js                          # Module registration + search type + lazy component loading
  default-search-configuration.js   # Search ranking config
  acl/
    index.js                        # ACL privilege mapping
  snippet/
    en-GB.json
    de-DE.json
  page/
    <module-name>-list/
      index.js
      template.html.twig
    <module-name>-detail/
      index.js
      template.html.twig

Also add import './module/<module-name>'; to main.js.

External References

Comments

Markdown supported