Wordpress Boilerplate Generator

Generates a theme or plugin boilerplate for wordpress.

These are full featured and modern boilerplates in both structure and tooling. Developer tools include docker, webpack, composer autoloading, and other custom scripts.

Installation And Usage

Clone or download the repository

npm install

npm start

Follow the prompts to fill in relavant information. Then cd into the created boilerplate.

npm install

composer install

composer dump-autoload

And to develop

docker compose up -d

npm run dev

Boilerplates

Folder Structure

All php files reside in inc. All psr-4 classes will be autoloaded via composer from the inc/app folder.

All raw js, css, and blocks reside in src. These are files that need to be built during the build process.

Webpack

Webpack and @wordpress/scripts ares set to serve js and scss. All files will be built from src to the build folder.

Docker

Docker set up to control the development environment. You must have docker and docker-compose installed.

Docker env variables for php and wordpress versions will be set in .env. The wordpress debug.log file from the docker container will be placed in the projects root directory.

Tests

You have the choice whether or not to install tests. Js testing is done with vitest and php testing is done with phpunit and the wordpress phpunit test suite.

for js run

npm run test

for php run

composer test

The wordpress testing suits are installed from https://develop.svn.wordpress.org/tags. It will be installed via custom composer repository and use whatever wordpress version you picked when running the init script.

License

This software is licensed under the GNU General Public License v2.0 or later. See LICENSE for more information.