Imported from teamchrisfromthelc/wp-preset (AGENTS.md). Install upstream with npx skills add teamchrisfromthelc/wp-preset. Copyright stays with the author.

WP Preset

This repository is the scaffold — it is not a WordPress plugin or theme. Files here are templates copied into other projects by setup.sh.

Layout

Placeholders

Templates use these, and setup.sh rewrites them. Order matters in the sed chain — uppercase and StudlyCase before the lowercase forms.

wp-project · wp_project · WP_PROJECT_ · WpProject · WP Project

Working on this repo

• Don't run the linters here. composer.json and phpcs.xml.dist are templates for scaffolded projects; this repo has no vendor/.
• Verify by scaffolding. Any change to a template must be checked by running setup.sh into a temp dir, installing, and running every gate: composer test, phpcs, phpstan, npm run lint:js, lint:css, format:check, and composer build. Several past bugs passed a syntax check and only failed on a real install. .github/workflows/scaffold.yml does all of this on every push, across macOS and Linux — read it before adding a check by hand, and add new assertions there rather than to a throwaway script.
• composer check needs Docker, so CI asserts its wiring rather than running it. Run it by hand against a scaffolded plugin when touching bin/check.sh, bin/build.sh, or plugin/readme.txt.
• Three kinds, not two. --theme alone is not runnable non-interactively: it prompts on a TTY and exits otherwise. Test --plugin, --theme --block, and --theme --classic — which is what CI's matrix does.
• setup.sh never overwrites. Existing files in a target are skipped.
• When adding a file that should reach projects, add it to the copy list in setup.sh, the rename list too if it contains placeholders, and an exclude in bin/build.sh if it must not ship in a release zip. That rsync list is, in the script's own words, the single source of truth for what ships — a new dev file lands in every user's release without one.