devrix/scaffold

DevriX: Scaffold

Maintainers

Details

github.com/DevriX/dx-scaffold

Homepage

Source

Issues

Installs: 32

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 3

Forks: 0

Open Issues: 0

1.0.2 2022-10-06 14:31 UTC

Requires

MIT 2cdcef27952772b33c5f41108f7acd557a48a610

cliscaffolddevrix

This package is auto-updated.

Last update: 2024-05-06 18:21:09 UTC

README

This is a CLI tool to scaffold a new plugin based on the DevriX plugin boilerplate.

Installation

composer global require devrix/scaffold

Note: Make sure to place the ~/.composer/vendor/bin directory (or the equivalent directory for your OS) in your PATH so the dx-scaffold executable can be located by your system.

export PATH="$PATH:$HOME/.config/composer/vendor/bin"

Usage

After installing the composer package cd to the wp-content/plugins directory.

Then run the following command to start the interactive CLI:

dx-scaffold plugin new

You can predefine the plugin attributes by specifying them as arguments:

  • name="" - The name of the plugin.
  • slug="" - The slug of the plugin.
  • class="" - The main class of the plugin.
  • namespace="" - The namespace of the plugin.
  • abbr="" - The abbreviation to use for global variables.

Example usage:

dx-scaffold name="DevriX" slug="devrix" class="Devrix" namespace="DX" abbr="DX"

You can also skip parts of the interactive CLI by specifying a --skip flag.

  • --skip-clone - Skips the git clone step.
  • --skip-rename - Skips the renaming/search-replace step.
  • --skip-npm - Skips npm install and npm run prod.

License

MIT DevriX