wpbp/generator

Generator of Wordpress Plugin Boilerplate Powered

1.3.9 2024-02-06 16:09 UTC

README

License Downloads Codacy Badge

This generator (based on PHP) parse the WordPress Plugin Boilerplate Powered and remove the stuff that you don't need.

Requirements

Let's have a look on what you need and how to install it:

Debian/Ubuntu

sudo apt install php php-zip php-mbstring php-yaml

Fedora/Centos

sudo dnf install php php-zip php-mbstring php-yaml

Mac OS

brew install pkg-config zlib pecl install zip mbstring yaml (source: https://grrr.tech/posts/installing-homebrew-php-extensions-with-pecl)

Install

From here you can download the phar version or you can chose to install it with composer:

composer global require wpbp/generator:dev-master

Add this directory to your PATH in your ~/.bash_profile (or ~/.bashrc) like this:

export PATH=~/.composer/vendor/bin:$PATH

Execute

wpbp-generator --help to get a list of commands

--dark
     Use a dark theme for console output.

--dev
     Download from the master branch (the development version).

--help
     Show the help page for this command.

--json
     Generate a wpbp.json file in the current folder. Suggested to use the WordPress plugin folder.

--no-download
     Do you want to execute composer and npm manually? This is your flag!

--verbose
     Verbose output. Because this can be helpful for debugging!

wpbp.json

This file contains all the default variables that will be used to scaffold the boilerplate.