README.md

Plugin Skeleton D

What's included

• Automation:
  • Sensible dependabot.yml for automated dependency updates.
  • Reusable GitHub workflows for CI (README.md)
• Tooling & Testing:
  • ESlint
  • PHP_CodeSniffer
  • PHPStan
  • Prettier
  • Stylelint
  • Typescript
  • Enforcement with lefthook and lint-staged
• Testing:
  • PHPUnit
  • Jest
  • Playwright
  • Coverage reports with codecov
• Environment & Build:
  • @wordpress/env support with a pre-configured wp-env.json
  • Release demos and PR previews with WP Playground using the included blueprint.json
  • @wordpress/scripts for build and dev tooling.
  • Automated release PRs with release-please using the included release-please-config.json

Docs

Getting Started

• Scaffolding Steps

Contributing

• docs/DEVELOPMENT.md for development and contribution guidelines.
• docs/CONTRIBUTING.md for contribution guidelines.
• docs/CODE_OF_CONDUCT.md for the code of conduct.
• docs/SECURITY.md for security policies and reporting.

References

• Action Hooks
• Filter Hooks
• Constants
• WP-CLI Commands

To do

• GitHub workflows for private runners.
• docs/ARCHITECTURE.md
• Scaffold scripts (search/replace strings, delete examples and unused deps etc)

Scaffold Steps

1. Create a new project from this repo.
2. Do a find and replace for the skeleton placeholder strings:
   • plugin-skeleton-d (slug)
   • Plugin Skeleton D (title)
   • PLUGIN_SKELETON_D (constant prefix)
   • pluginSkeletonD (camelCase reference)
   • PluginSkeletonD (PascalCase reference)
3. Update the plugin metadata in:
   • .phpcs.xml.dist (testVersion, minimum_wp_version)
   • composer.json (config.platform.php, require.php)
   • phpstan.neon.dist (phpVersion)
   • plugin-skeleton-d.php
   • readme.txt
   • readme.md
4. Remove and replace example TS entrypoints, and blocks if not needed:
   • src/ Then, update the references to them in:
   • webpack.config.js (entry)
   • inc/Core/Assets.php
5. Update and replace the .github/workflows with the relevant CI for your project.
   • PHP Version in ci.yml and release.yml (latest supported)
   • PHPUnit test matrix in ci.yml
6. Search for @todo comments and resolve them as needed.
7. Remove all remaining example code from inc and src as needed, along with any relevant tests, unused dependencies, and references.