webdevstudios/generator-plugin-wp

Yeoman WordPress Plugin Generator

generator-plugin-wp

Yeoman generator for WordPress plugins.

Getting Started

Pre-requisites: You'll need node which comes with npm.

If you don't have Yeoman installed:

npm install -g yo

To install generator-plugin-wp from npm, run:

npm install -g generator-plugin-wp

To use generator-plugin-wp, cd to your WordPress plugins folder and:

yo plugin-wp

You'll be prompted with steps for creating your plugin.

Sub-generators

Once your nifty new plugin has been generated, cd into your new plugin's directory. While in the plugin directory, you can run additional commands called sub-generators to automatically generate files to enhance your plugin.

• yo plugin-wp:include <include-name> Basic Include
• yo plugin-wp:cpt <cpt-name> Custom Post Type
• yo plugin-wp:cli <cli-command-name> WP CLI Command
• yo plugin-wp:taxonomy <taxonomy-name> Taxonomy
• yo plugin-wp:options <options-name> Option Page
• yo plugin-wp:widget <widget-name> Widget
• yo plugin-wp:endpoint <class-name> WP-API Endpoint
• yo plugin-wp:js Javascript
• yo plugin-wp:css Styles

For the names of the include, cpt, options, and widget subgenerators remember that the plugin prefix will be added to the class name so no need to include the original plugin name there. Think of it as the file name for each instead.

Tests

By default the plugin generator adds some built in tests for you to add on to as you develop your plugin. To run these tests run the install-wp-tests.sh script in the bin folder with the proper database details for your local setup.

Once you've run the install-wp-tests.sh script you can run just phpunit in the main folder of your plugin.

If you don't want tests included in your plugin when it is generated run the main generator with the --notests option.

PHP 5.2

By default PHP 5.2 is not supported in the generated plugin. To generate a plugin with PHP 5.2 support, run the main generator with the --php52 option.

CMB2

CMB2 is included by default with the options sub-generator. It can also be a useful tool with CPT and taxonomy sub-generators using the --cmb2 flag.

Adding Packages with Composer

If you chose composer as the autoloader option during the plugin's initiation, you can use composer to add additional dependencies.

Let's cd into our new plugin's directory and add CMB2:

composer require cmb2/cmb2

CMB2 will now appear under vendor

-plugins
  -wds-foo-plugin
    -vendor
      -cmb2
        -cmb2

Contributors

The following humans contributed to this awesome generator:

CamdenSegal, jtsternberg, jazzsequence, binarygary, bradp, JeffreyNaval, gregrickaby, DevNIX, JPry, RC Lations, tnorthcutt, aubreypwd, JeffMatson

generator-plugin-wp's Issues

Failed to autoload class with T_ in classname like T_WP_REST_API

Failed to autoload class with T_ in classname like T_WP_REST_API.

Generated plugin.php function autoload_classes will use wp-resapi as $filename instead of wp-rest-api

Add PageBuilder Support

Would be amazing to have auto-generating Page Builder support!

Camden wrote a pretty spiff plugin for a client today, which had well organized PB support (with custom fields even!). Would like to see this standardized going forward.

yo plugin-wp:page-builder

Translate custom post types is not possible

The constructor of the custom post type class is called before the plugin text domain is loaded. So it's impossible to translate the singular and plural of the CTP.
A solution whould be to load the plugin text domain in the plugin constructor instead in the init event.

'let' is still used, when choosing basic JS

This triggers error, introduced in 793f05f.

generator-plugin-wp requires a peer of yo but none was installed.

[email protected] requires a peer of yo@>=1.0.0 but none was installed.

I tried installing that and I think i've got the right version..

Undefined static method dir() in base class

Ran the plugin this morning, found this little gem.

Using basic auto loader.

After generating a widget, it doesn't display, unless you require the file outside main plugin class.

The widget sub-generator adds the following to require to the plugin_classes() method.

require( self::dir( 'includes/class-foo-widget.php' ) );

When you move this outside the main plugin class, the widget shows up.

require_once( 'includes/class-foo-widget.php' );

Check if existing plugin folder exists in location

http://b.ustin.co/1ltO0

Descriptions with "quotes" will break includes and throw errors

npm ERR! install Couldn't read dependencies
npm ERR! Darwin 14.3.0
npm ERR! argv "node" "/usr/local/bin/npm" "install"
npm ERR! node v0.12.2
npm ERR! npm  v2.7.4
npm ERR! file /Users/jazzsequence/vagrant-local/www/roadkill/htdocs/wp-content/plugins/roadkill-featured-articles/package.json
npm ERR! code EJSONPARSE

npm ERR! Failed to parse json
npm ERR! Unexpected token 'e' at 5:73
npm ERR! escription": "A simple plugin that allows various post types to be "featured"."
npm ERR!                                                                      ^
npm ERR! File: /Users/jazzsequence/vagrant-local/www/roadkill/htdocs/wp-content/plugins/roadkill-featured-articles/package.json
npm ERR! Failed to parse package.json data.
npm ERR! package.json must be actual JSON, not just JavaScript.
npm ERR! 
npm ERR! This is not a bug in npm.
npm ERR! Tell the package author to fix their package.json file. JSON.parse

npm ERR! Please include the following file with any support request:
npm ERR!     /Users/jazzsequence/vagrant-local/www/roadkill/htdocs/wp-content/plugins/roadkill-featured-articles/npm-debug.log
bower EMALFORMED    Failed to read /Users/jazzsequence/vagrant-local/www/roadkill/htdocs/wp-content/plugins/roadkill-featured-articles/bower.json

Additional error details:
Unexpected token f

plugin is actually generated at this point, but trying to include additional classes or running other subgenerators will throw an error and fail:

 yo plugin-wp:include cmb
undefined:3
escription": "A simple plugin that allows various post types to be "featured".
                                                                    ^
SyntaxError: Unexpected token f
    at Object.parse (native)
    at EditionInterface.module.exports [as readJSON] (/Users/jazzsequence/.node/lib/node_modules/generator-plugin-wp/node_modules/yeoman-generator/node_modules/mem-fs-editor/actions/read-json.js:5:17)
    at Base.determineAppname (/Users/jazzsequence/.node/lib/node_modules/generator-plugin-wp/node_modules/yeoman-generator/lib/base.js:735:25)
    at Base (/Users/jazzsequence/.node/lib/node_modules/generator-plugin-wp/node_modules/yeoman-generator/lib/base.js:150:23)
    at new module.exports.base.extend.constructor (/Users/jazzsequence/.node/lib/node_modules/generator-plugin-wp/include/index.js:8:28)
    at Environment.instantiate (/Users/jazzsequence/.node/lib/node_modules/yo/node_modules/yeoman-environment/lib/environment.js:282:10)
    at Environment.create (/Users/jazzsequence/.node/lib/node_modules/yo/node_modules/yeoman-environment/lib/environment.js:259:15)
    at Environment.run (/Users/jazzsequence/.node/lib/node_modules/yo/node_modules/yeoman-environment/lib/environment.js:318:24)
    at /Users/jazzsequence/.node/lib/node_modules/yo/lib/cli.js:99:9
    at Environment.resolver.lookup (/Users/jazzsequence/.node/lib/node_modules/yo/node_modules/yeoman-environment/lib/resolver.js:50:12)

Consider switching to LibSass

Instead of grunt-contrib-sass we should use grunt-sass. It'll will cut compilation time by 80%.

https://github.com/sindresorhus/grunt-sass

Note: You will need to update Gruntfile.js accordingly...

Get latest version of Sass (package.json)

Swap out the version number for "latest".

Error plugin-wp:taxonomy test-taxonomy

Error plugin-wp:taxonomy test-taxonomy 

You don't seem to have a generator with the name plugin-wp:taxonomy installed.
You can see available generators with npm search yeoman-generator and then install them with npm install [name].
To see the 7 registered generators run yo with the `--help` option.

w00t. I've double checked that I'm using the 0.15.0 version :(

Gulp version?

Could be possible to generate a Gulp version of this project instead of Grunt?

Travis

Looks like Travis was set up for this repo when it was on your Github account, @CamdenSegal.

yo plugin:js doesn't work

redacted. typo on my end!

Fatal error upon activating plugin

I'm receiving a fatal error upon activating the plugin. There is an undefined variable $instance being used in __construct. I changed it to $this. Not sure if you were meaning to call these methods differently.

register_activation_hook can't be called in plugins_loaded

Hi and thanks for this generator.
I've found and issue tough. In the Wordpress documentation they say that register_activation_hook can't be called in plugins_loaded which is what you do in fact it is not called. I guess register_activation_hook and register_deactivation_hook can be moved in the __construct function? At least that's what I did.

Should the main plugin class be `final`?

https://github.com/WebDevStudios/generator-plugin-wp/blob/master/app/templates/plugin.php#L75

(e.g. https://github.com/jaredatch/EA-Share-Count/blob/master/ea-share-count.php)

Add option to generate basic PHPUnit testing setup if chosen.

If composer chosen as autoloader but not installed errors out

Using "Composer" as autoloader

Strip special characters from Class Name and Plugin Prefix

When adding a special character such as an ampersand (&) to the Plugin Name, the character is stripped in the plugin slug, but not in the class name and plugin prefix. This would probably not be a valid character in either case.

js sub generator yields undefined.js file

See below image:

When running the sub generator with the Basic setup ( just uglify ) the file it creates is undefined.js and does not follow the task that is created when it edits the gruntfile.

plugin_classes() loaded before check_requirements()

Hey, I'm really loving this generator. One thing I've noticed: the plugin_classes method is run in the constructor. I wonder if it would make more sense to run this from the init method, after check_requirements is run. If anyone really needs to hook earlier than init they still could manually, but right now the generator defaults to instantiating all includes before the requirements are checked.

Remove jshint comments from main.js

These parameters are better in the Grunfile.js

Use new class naming standards

Currently the include subgenerator(s) and autoloader assume your include files are named file-name.php but our current coding standards recommend classes should be named class-file-name.php. Subgenerators need to be updated to correct class- prefixed include files and the autoloader needs to be updated to support file name change when the file name and the class name don't necessarily match, e.g.: file name: class-options.php, class name: WDS_Prefix_Options.

CPT Init didn't work because of init

Add to the main final class priority zero to the init action to avoid problems with CPT init.

add_action( 'init', array( $this, 'init' ), 0 );

Make an autoloader prompt

Add an additional prompt which asks the user if they want to use an Autoloder. The choices would be composer, php, or no autoloader

deactivate_plugins is run before it is declared

If a plugin's requirements are not meet a fatal error is thrown because it trys to call deactivate_plugins before WordPress declares it.

A plugin already exists with this folder name, exiting...

Failed to create a new plugin using "yo plugin-wp".
It returns "A plugin already exists with this folder name, exiting...". I noticed that it creates the folder and then return the error.

CSS/Sass sub-generator needed

I believe @CamdenSegal has it in the works, but this is a placeholder issue for it

Limit CPT name from CPT generator to 20 characters

CPTs can only be 20 characters or else you'll get an error. The generator appends the plugin slug to the CPT name which can very easily get over 20 characters. Perhaps the plugin slug shouldn't be added and maybe there could be a check to see if what the user enters is 20 characters or less.

load_textdomain does not need to be used

the load_textdomain function does not need to e used here: https://github.com/WebDevStudios/generator-plugin-wp/blob/master/app/templates/plugin.php#L146

If we are trying to use language pack files, load_plugin_textdomain will be able to do that. See Otto's article here: http://ottopress.com/2013/language-packs-101-prepwork/

If you want to use language packs exclusively (note: WP will still check the base /wp-content/plugins directory for language files, just in case):

Text Domain: plugin-slug
load_plugin_textdomain( 'plugin-slug' );

I submitted a plugin to the repo using the generator, and although Mika said none of this will prevent the plugin from being accepted she wanted to let me know about it. She also mentioned in the area where we are using load_textdomain, it should not be using hard coded folders, as someone's weird setup may not have what we expect.

Include Sub-Generator - Automatically Appending to __get()

This can become quite large on some projects. I mean do we really need 20+ magic get properties? Maybe consider making this an option during the creation process in the sub generator, or remove it entirely and rely upon the dev to do this if he/she needs to.

Example Scenario:

CMB2 sub-generator/includer

Widget sub-generator

Make "tested up to" WP versions default to latest stable.

Not sure if possible, or how easily, but some method that doesn't rely on a hardcoded value would be awesome for this spot in readme files.

Include Sub-Generator - Lacking Parental Reference ( Docblock )

When we create an include class, the doc-block on the newly created class $plugin property is improper.

    /**
     * Parent plugin class
     *
     * @var   class
     * @since NEXT
     */
    protected $plugin = null;

Is it possible to get the main plugin's class and replace class with the right class?

Class extending WP_REST_Controller: Cannot call constructor

This happened to me using the yo plugin-wp:endpoint generator, the generated file seems to have some kind of problem.

I have to remove the parent::__construct(); line because it seems like WP_REST_Controller does not have a defined constructor.

/**
 * Constructor
 *
 * @since  NEXT
 * @param  object $plugin Main plugin object.
 * @return void
 */
public function __construct( $plugin ) {
    parent::__construct();
    $this->plugin = $plugin;
}

Fatal error: Call to a member function plugin_classes() on a non-object

Getting this error when trying to activate the plugin with WordPress. Changing lines 98 & 99 from $instance to $this fixes it...

CPT Core sub-generator/includer

add test file when new include is created

if i run yo plugin-wp:include my-class, create on test folder also test for this file eg: my-class-test.php

When generating frontend.php, it generates "undefinedFrontend" as the class name

I feel like this should take on the name of my plugin? Or at least ask me what I want to name it?

<?php
/**
 * undefined Frontend
 * @version 2.0
 * @package 
 */

class undefinedFrontend {
    /**
     * Parent plugin class
     * @var class
     */
    protected $plugin = null;

    /**
     * Constructor
     * @since 2.0
     */
    public function __construct( $plugin ) {
        $this->plugin = $plugin;
        $this->hooks();
    }

    /**
     * Initiate our hooks
     * @since 2.0
     */
    public function hooks() {
    }
}

yo plugin-wp:css doesn't work

It again asks me about the new plugin details

Options Page sub-generator

Based on new developments, we should use TGMPA to bring in CMB2

Based on developments here and here, I think we should avoid using composer or directly including CMB2 bundled into the plugin and instead depend on TGM Plugin Activation.

The TLDR of the links above:

• New frameworks are no longer allowed in the repo. CMB2 will be allowed to stay however.
• since CMB2 will be staying in the repo, other plugins cannot bundle it within their own plugins (to be accepted to the WP plugin repo), because plugins are not (any longer) allowed to bundle other plugins that exist in the repo.
• As such, the recommended practice is to require the plugin via TGMPA.

I didn't create a PR yet because I want to make sure we're all on the same page, and hear any feedback.

Update readme

Items to cover:

• CD to plugins dir, the yo generator creates its own plugin folder
• Document the generator prompts
• Has additional sub-generators
  • Need to document each and parameters they accept
  • Document the prompts for them
• Update documentation about composer.. move to a sub-section. Composer will no longer be an automatic-add

include sub-generator should use WP file-naming conventions

The file name should be "class-{$class_name_with_hyphens_and_lowercased}". See WordPress standards around file-naming.

`yo plugin-wp cpt cpt-name` does not add a CPT

Tried following the documentation for the CPT subgenerator/option but the CPT was never created: https://github.com/WebDevStudios/generator-plugin-wp/tree/master/cpt

Don't ignore Sass Maps (.gitignore)

Sass maps are being ignored in .gitignore. Can we un-ignore them?

Thanks

Update tests based on @danielbachhuber's PR

WebDevStudios/WDS-Log-Post#1