create-wp-react-app's Introduction

🆕 🔥

create-wp-react-app

Create React WordPress plugin with no build configuration.

This CLI tool enables you to create a modern WordPress ReactJS plugin with no build configuration based on WP ReactJS Starter boilerplate with Babel, Webpack and more.

Installation

$ npm install -g create-wp-react-app

Create plugin

$ create-wp-react-app create my-plugin

Usage

Usage: create-wp-react-app create [options] <slug>

Create a new WP plugin with the given plugin slug

Options:

  -r, --repository [repository]  The repository URL, default is https://github.com/matzeeable/wp-reactjs-starter
  -h, --help                     output usage information

The repository options allows you to build your own forked boilerplate based on the WP ReactJS Starter boilerplate. For example you can offer your plugin users to quick-start an Add-On. For example have a look at matzeeable/wp-real-media-library-add-on.

Extensibility

If you are using your own forked boilerplate you can create a build/create-wp-react-app.js file to modify the generation process.

`prompts`

This export function allows you to add an input field to the generation process (prompts). For this, listr-input tasks are used.

/**
 * Add the minimum required Real Media Library version to the prompts.
 */
exports.prompts = ({ task, pluginCwd, createInputTask }) => {
    task.add(createInputTask({
        name: 'Minimum Real Media Library version',
        key: 'minRML',
        defaultValue: '3.0.0'
    }));
};

`phpFunctions`

Pass a function name to the functions parameter so the wprjss is replaced with your defined name.

/**
 * Add the RML admin notice for the min required RML version.
 */
exports.phpFunctions = ({ functions }) => {
    functions.push('wprjss_skip_rml_admin_notice');
};

Recommend Projects