https://github.com/nystudio107/generator-craftplugin

generator-craftplugin is a Yeoman generator for Craft CMS plugins
https://github.com/nystudio107/generator-craftplugin

craft-plugin craft3 craftcms yeoman

Last synced: 6 months ago
JSON representation

generator-craftplugin is a Yeoman generator for Craft CMS plugins

Host: GitHub
URL: https://github.com/nystudio107/generator-craftplugin
Owner: nystudio107
License: mit
Created: 2016-01-03T09:03:18.000Z (over 9 years ago)
Default Branch: master
Last Pushed: 2022-11-07T17:18:46.000Z (over 2 years ago)
Last Synced: 2024-12-06T03:24:27.132Z (6 months ago)
Topics: craft-plugin, craft3, craftcms, yeoman
Language: PHP
Homepage:
Size: 514 KB
Stars: 73
Watchers: 8
Forks: 30
Open Issues: 32
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

README

# generator-craftplugin

generator-craftplugin is a [Yeoman](http://yeoman.io) generator for [Craft CMS](http://www.buildwithcraft.com) plugins

Type just `yo craftplugin` and a new Craft CMS plugin tailored to your liking will be created.

You can also access the generator via the web at [pluginfactory.io](http://pluginfactory.io)

## Installation

This assumes you have `nodejs`, `npm`, and `yeoman` installed already.

1. Download & unzip the file and place the `generator-craftplugin` directory onto your dev machine
2. -OR- do a `git clone https://github.com/nystudio107/generator-craftplugin.git` directly onto your dev machine. You can then update it with `git pull`
3. On the command line, from the root of the generator-craftplugin project (in the `generator-craftplugin/` folder), type: `npm link` to install the project dependencies and symlink a global module. On some setups, you may have to do `sudo npm link --no-bin-links`
4. -OR- do an `npm -g install generator-craftplugin` to install it via npm (and thus skip the `npm link` step)
5. The generator folder should be named `generator-craftplugin`. GitHub recently started appending `-master` (the branch name) to the name of the folder for zip file downloads.

Requires Node version 8.0.0 or later.

## Usage

To create a new Craft CMS plugin and use generator-craftplugin to scaffold it:

yo craftplugin

generator-craftplugin will ask you a few questions:

* **Plugin name:** - enter the name of your plugin
* **Short description of the plugin:** - enter a short (around 120 characters or less) description of the plugin and what it does
* **Plugin initial version:** - enter the initial version of the plugin, e.g.: `1.0.0` or `0.0.1`
* **Plugin author name:** - enter the name of the author of the plugin (either an individual or a company)
* **Plugin author URL:** - enter the URL (with the `http://`) of the website of the plugin author
* **Plugin author GitHub.com name:** - enter the GitHub.com handle of the author of the plugin. If you don't have one, just leave it blank
* **Select what components your plugin will have:** - select the components you want included in your plugin, using the arrow keys to change the component, and `` to select them.

If you selected `Controllers`, `ElementTypes`, `FieldTypes`, `Models`, `Purchasables`, `Records`, `Services`, `Tasks`, or `Widgets` components, it will also ask you for a name for each one, respectively. If you want multiple components, just separate them with a , in the name input.

generator-craftplugin will then do the following for you:

1. Create the `pluginname` directory in the current directory, properly lower-cased and stripped of spaces
2. Create all of the properly named, documented files & folders for your new Craft CMS plugin

The code generated conforms to Pixel & Tonic's [Coding Standards](https://github.com/pixelandtonic/CodingStandards/blob/master/standards/PHP.md), and includes a number of other ancillary files such as `README.md`, `icon.svg`, `releases.json`, etc. to get you going.

### Sample Output

Here's an example of the output from a `yo craftplugin` generator:

## Command line options

The `craftplugin` generator can also be passed arguments via the command line, bypassing the interactive prompts. So it's possible do do something like this:

yo craftplugin --pluginComponents="controllers,consolecommands,elementtypes,fieldtypes,models,records,services,settings,tasks,tests,twigextensions,utilities,variables,widgets" --apiVersion="api_version_3_0" --pluginName="Some Plugin" --pluginDescription="Some Description" --pluginVersion="1.0.0" --pluginVendorName="Some Vendor" --pluginAuthorName="Some Author" --pluginAuthorUrl="https://SomeDomain.com" --pluginAuthorGithub="SomeGithub" --codeComments="yes" --consolecommandName="Een,Twee,Drie" --controllerName="One,Two,Three" --elementName="Neung,Song,Sam" --fieldName="Ichi,Ni,San" --modelName="Uno,Dos,Tres" --purchasableName="" --recordName="Satu,Dua,Tiga" --serviceName="Yi,Er,San" --utilityName="Eins,Zwei,Drei" --taskName="Hana,Dul,Set" --widgetName="Un,Deux,Trois"

## Adding to an existing plugin

As of version 1.3.0, the `generator-craftplugin` creates a `.craftplugin` project file in your plugin's root folder that contains all of the information needed to create the plugin scaffolding. If you have Yeoman and the `generator-craftplugin` installed locally, you can then `cd` to the directory and add components as you see fit.

Here's a video showing how that works:

[![Adding to an existing plugin video](https://img.youtube.com/vi/K-PwDHS76So/0.jpg)](https://youtu.be/K-PwDHS76So)

So to add a controller to a project that already has `controllers` we can just do:

yo craftplugin --controllerName="woofer"

If we're adding a new component type that doesn't exist in the plugin yet, we can just do:

yo craftplugin --consolecommandName="woofer" --pluginComponents="consolecommands"

Here's a list of the `pluginComponents`; if you want to add more than one, just use a comma separated list, e.g.: `--pluginComponents="controllers,consolecommands"`:

controllers
consolecommands
elementtypes
fieldtypes
models
records
services
settings
tasks
tests
twigextensions
utilities
variables
widgets

Here's a list of the parameters you can pass in to name the various components; if you want to add more than one, just use a comma separated list, e.g.: `--controllerName="One,Two,Three"`:

--consolecommandName=""
--controllerName=""
--elementName=""
--fieldName=""
--modelName=""
--purchasableName=""
--recordName=""
--serviceName=""
--utilityName=""
--taskName=""
--widgetName=""

Here's a list of meta parameters that you can also pass in, to override what is in the `.craftplugin` file:

--apiVersion=""
--pluginName=""
--pluginDescription=""
--pluginVersion=""
--pluginVendorName=""
--pluginAuthorName=""
--pluginAuthorUrl=""
--pluginAuthorGithub=""
--codeComments=""

Brought to you by [nystudio107](http://nystudio107.com)

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/nystudio107/generator-craftplugin

Awesome Lists containing this project

README