generator-canjs-plugin

CanJS Plugin Generator

A generator for Yeoman that scaffolds a CanJS plugin.

For more information read the CanJS Plugin Guide

Usage

Install Yeoman and generator-canjs-plugin

$ npm install -g yo generator-canjs-plugin

Make a new directory and cd into it:

$ mkdir my-plugin && cd my-plugin

Then run the generator to scaffold your plugin:

$ yo generator-canjs-plugin

Workflow

All source files for the plugin reside in the src directory.

Qunit tests reside in the test directory.

Distributable versions of the plugin will be placed in the dist directory.

Grunt tasks

The following Grunt tasks are available:

Runs jsbeautifier and JSHint:

$ grunt quality

Runs tests:

$ grunt test

Runs tests and generates distributable files:

$ grunt build

Register with Bower

$ bower register <plugin-name> <git-endpoint>

Bower uses git tags for versioning.

To publish a new version:

• Modify the version number in bower.json
• Tag a new version and push to origin

$ git add .
$ git commit -m 'Update to vX.Y.Z'
$ git tag -a vX.Y.Z -m 'vX.Y.Z'
$ git push --tags origin master

Changelog

0.0.1

• Initial release

License

MIT License