Skip to content

Latest commit

 

History

History
143 lines (89 loc) · 3.66 KB

README.md

File metadata and controls

143 lines (89 loc) · 3.66 KB
Raw

generate-snapdragon NPM version NPM monthly downloads NPM total downloads Linux Build Status

Scaffold out a new snapdragon plugin project.

Table of Contents - [Install](#install) - [CLI usage](#cli-usage) - [Available tasks](#available-tasks) - [API usage](#api-usage) - [About](#about)

Install

Install with npm:

$ 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:

$ gen snapdragon

Available tasks

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

default task

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

Example

$ gen snapdragon

plugin-only

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

Example

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

compiler

Scaffold out a complete project for a snapdragon compiler plugin.

Example

$ gen snapdragon:compiler

compiler-only

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

Example

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

parser

Scaffold out a complete project for a snapdragon parser plugin.

Example

$ gen snapdragon:parser

parser-only

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

Example

$ 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:

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

About

Contributing

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

Building docs

(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:

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

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Jon Schlinkert

License

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

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