generator-plum

Plum generator

Yeoman generator for plum.

Getting Started

• Install with NPM - npm install -g generator-plum

Usage

1. Run yo plum at the root of your css directory to initialize a new plum application.
2. Run any of the available generators inside of your css directory.

Generators

Available generators:

• plum (plum:app)
• plum:config
• plum:core
• plum:function
• plum:mixin
• plum:layout
• plum:vendor
• plum:module
• plum:unit
• plum:page
• plum:hotfix
• plum:export

App

Initializes a new plum application.

yo plum

Config

Generates a config files in configs/<name> and prompts to update an exports file.

yo plum:config <name>

Core

Generates core files in core/ and prompts to update an exports file.

yo plum:core <name>

Function

Generates function files in helpers/functions/<name> and prompts to update an exports file.

yo plum:function <name>

Mixin

Generates mixin files in helpers/mixins/<name> and prompts to update an exports file.

yo plum:mixin <name>

Layout

Generates layout files in layouts/<name> and prompts to update an exports file.

yo plum:layout <name>

Vendor

Generates vendor files in vendors/<name> and prompts to update an exports file.

yo plum:vendor <name>

Module

Generates module files in modules/<name>/ and prompts to update an exports file.

yo plum:module <name>

Unit

Generates unit files in units/<name> and prompts to update an exports file.

yo plum:unit <name>

Page

Generates page files in pages/<name> and prompts to update an exports file.

yo plum:page <name>

Hotfix

Generates hotfix files in hotfixes/<name> and prompts to update an exports file.

yo plum:hotfix <name>

Export

Generates export files in exports/<name>

yo plum:export <name>

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality.

License

Copyright (c) 2015 Jason Bellamy
Licensed under the MIT license.