generate-snapdragon    

> Scaffold out a new snapdragon plugin project.

Install

Install with npm:

``sh
$ npm install --save generate-snapdragon
`

CLI usage

Once both generate and generate-snapdragon are installed globally, run the following command to run this generator's default task:

`sh
$ gen snapdragon
`

Available tasks

All tasks beside the default task are run by appending the task name to snapdragon:.

$3

Run the generator's default task to scaffold out a new snapdragon plugin project.

Example

`sh
$ gen snapdragon
`

$3

Generate only the index.js file for a snapdragon plugin. Use --stem to change the file name.

Example

`sh
$ gen snapdragon:plugin-only
$ gen snapdragon:plugin-only --stem foo.js
`

$3

Scaffold out a complete project for a snapdragon compiler plugin.

Example

`sh
$ gen snapdragon:compiler
`

$3

Generate only the index.js file for a compiler plugin. Use --stem to change the file name.

Example

`sh
$ gen snapdragon:compiler-only
$ gen snapdragon:compiler-only --stem foo.js
`

$3

Scaffold out a complete project for a snapdragon parser plugin.

Example

`sh
$ gen snapdragon:parser
`

$3

Generate only the index.js file for a snapdragon parser plugin. Use --stem to change the file name.

Example

`sh
$ gen snapdragon:parser-only
$ gen snapdragon:parser-only --stem foo.js
`

API usage

To extend your own generator with the tasks and functionality of generate-snapdragon, inside your generator add the following line of code:

`js
app.use(require('generate-snapdragon'));
`

About

$3

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

$3

_(This document was generated by verb-generate-readme (a verb generator), please don't edit the readme directly. Any changes to the readme must be made in .verb.md.)_

To generate the readme and API documentation with verb:

`sh
$ npm install -g verb verb-generate-readme && verb
`

$3

Install dev dependencies:

`sh
$ npm install -d && npm test
``

$3

Jon Schlinkert

* github/jonschlinkert
* twitter/jonschlinkert

$3

Copyright © 2017, Jon Schlinkert.
Released under the MIT license.

*

_This file was generated by verb-generate-readme, v0.4.1, on January 20, 2017._