Skip to content

Include required tooling and structure in generated block plugins #55

Closed

Description

@krugazul

Outcome

Ensure generated projects contain the required development configuration, testing setup, documentation and folder structure. These requirements apply to generated output, not merely the scaffold repository.

Requirements and acceptance criteria

  • Review the referenced develop branches: shared .github/.claude, and ThisOneTimeOnAcidCom’s .agents, .claude, .specify, .github and guidelines folders. Adapt relevant roles, skills and instructions for generated output.
  • Identify required Mustache placeholders and follow mustache.js conventions.
  • Include src/ and build folders, using @wordpress/build for the plugin.
  • Use WordPress packages for Prettier, ESLint, Playwright and applicable tooling; configure Node.js 24.x.
  • Adapt Playwright configuration and E2E coverage from the supplied reference, placing tests in test/e2e/ rather than root e2e/.
  • Copy or adapt postcss.config.mjs, jest.config.js, .code-workspace, .coderabbit.yml, .gitignore and .gitattributes.
  • Include initial PHPUnit configuration, PHPStan checks and a working, tested Composer setup.
  • Follow Gutenberg coding guidelines, WordPress Coding Standards and BEM for CSS.
  • Include all required root files: LICENSE, README.md, SECURITY.md, CONTRIBUTING.md, changelog.txt, readme.txt.
  • Include lint configuration: .editorconfig, eslint.config.mjs, .jshintignore, prettier.config.mjs, .stylelintignore, .stylelintrc.js, .markdownlintignore, .npmpackagejsonlintrc.json, phpcs.xml.dist.
  • Include build configuration: .browserslistrc, jsconfig.json, tsconfig.json, tsconfig.build.json, webpack.config.js.
  • Include .wp-env.json, composer.json, composer.lock, package.json and package-lock.json.
  • Include phpunit/, test/unit/, test/e2e/, tools/eslint/, tools/webpack/ and project-specific docs/.
  • Review Gutenberg’s tools/ before optionally relocating additional tools there. The two explicitly required tools subfolders remain mandatory.

Scope and references

Use the supplied requirements and reference links. Check each repository’s own instructions before implementation; reference configurations are inputs to review, not verified compatibility evidence.

The source’s meeting-relative timing, Claude logger/Figma follow-up and skill-suggester instruction are excluded from these generated-output issues. No deadline is inferred.

Activity

  1. linear-code commented on Oct 28, 2026

    @linear-code
  2. self-assigned this
    on Oct 28, 2026
  3. krugazul commented on Oct 28, 2026

    @krugazul
    ContributorAuthor

    Done. Every criterion is in develop, each proven first in lightspeedwp/ls-test and then moved into plugin-template/. npm run check:generation gates the generated output in CI.

    Criterion Where
    Shared .claude and ThisOneTimeOnAcidCom's .agents, .claude, .specify and guidelines adapted for generated plugins #58 (ls-test#7)
    Mustache placeholders, following mustache.js conventions #57 (ls-test#6), registry in #59
    src/ and build folders #56. Decision: generated plugins keep @wordpress/scripts for builds, because @wordpress/build isn't stable yet. Moving to it is a separate piece of work for later.
    WordPress packages for Prettier, ESLint, Playwright and the other tools; Node.js 24 #56
    Playwright configuration and end-to-end tests in test/e2e/ #56
    postcss.config.mjs, .code-workspace, .coderabbit.yml, .gitignore, .gitattributes #56, #58. Decision: no jest.config.js. Unit tests run on Vitest through wp-scripts test-unit-js, configured in vitest.config.mjs.
    PHPUnit, PHPStan and a working Composer setup #56, PHP checks in check:generation in #61
    Gutenberg guidelines, WordPress Coding Standards, BEM #56 (Stylelint enforces BEM), guidelines/ in #58
    Root files #56
    Lint configuration #56, Prettier ignore list in #59
    Build configuration #56
    .wp-env.json, composer.json, composer.lock, package.json, package-lock.json #56, lockfiles in #60
    phpunit/, test/unit/, test/e2e/, tools/eslint/, tools/webpack/, docs/ #56
    Gutenberg's tools/ reviewed #56 (only the two required subfolders were needed)

    Not in scope here: the same work for the theme scaffold (lightspeedwp/block-theme-scaffold#20).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Fields

Priority

Urgent

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions