/Generate-Custom-Plugin-from-Boilerplates

Use this to quickly create custom plugins from standard Boilerplates (WooCommerce Boilerplate Plugin example included)

Primary LanguagePHP

Custom Plugin From Boilerplate

Use this to make custom plugins from standard boilerplates, in a quick and reusable way.

The included example uses Vi Lourenco's WooCommerce Extension Plugin Boilerplate as a template.

The version with variables is in the ./template folder

  • Simply edit .DEFAULT_SETTINGS and run npm start

.DEFAULT_SETTINGS explained in 1, 2, 3, 4:
variables An list of used variables across the template
variableValues A key -> Value object used to translate the variable
templatePath folder that contains the templated files
dist the path to the desired output folder, where the finished custom plugin will be after running this. 
module.exports = {
    variables: [   // ---> These are the variables that exist in the template.
        '${PLUGIN_NAME}', // change this as you wish
        '${PLUGIN_AUTHOR}',
        '${PLUGIN_TEXT_DOMAIN}',
        '${PLUGIN_DESCRIPTION}',
        '${PLUGIN_CLASS_NAME}',
        '${PLUGIN_URL}'
    ],
    variableValues: { // ---> Add here the variable name as a KEY
        '${PLUGIN_NAME}': 'Test Plugin Name Here', // And it's value will replace the variable in the template files
        '${PLUGIN_TEXT_DOMAIN}': 'test_plugin_domain',
        '${PLUGIN_DESCRIPTION}': 'test plugin description. This is very nice.',
        '${PLUGIN_CLASS_NAME}': 'Test_Plugin_Class',
        '${PLUGIN_AUTHOR}': 'RC Dev',
        '${PLUGIN_URL}': 'http://rcdevlabs.github.io'
    },
    templatePath: './template', // --> Default template folder
    dist: '../woo-dist' // -> default output (results) folder
};