Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/generate/generate-snapdragon
Scaffold out a new snapdragon plugin project.
https://github.com/generate/generate-snapdragon
create generate generator init new plugin project scaffold scaffolding snapdragon yeoman yo
Last synced: about 1 month ago
JSON representation
Scaffold out a new snapdragon plugin project.
- Host: GitHub
- URL: https://github.com/generate/generate-snapdragon
- Owner: generate
- License: mit
- Created: 2017-01-21T04:16:44.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-01-21T11:14:47.000Z (almost 8 years ago)
- Last Synced: 2024-08-09T13:14:04.732Z (5 months ago)
- Topics: create, generate, generator, init, new, plugin, project, scaffold, scaffolding, snapdragon, yeoman, yo
- Language: JavaScript
- Size: 10.7 KB
- Stars: 4
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# generate-snapdragon [](https://www.npmjs.com/package/generate-snapdragon) [](https://npmjs.org/package/generate-snapdragon) [](https://npmjs.org/package/generate-snapdragon) [](https://travis-ci.org/generate/generate-snapdragon)
> 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](https://www.npmjs.com/):
```sh
$ npm install --save generate-snapdragon
```
## CLI usage
Once both [generate](https://github.com/generate/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:`.
### [default task](generator.js#L34)
Run the generator's default task to scaffold out a new snapdragon plugin project.
**Example**
```sh
$ gen snapdragon
```
### [plugin-only](generator.js#L48)
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
```
### [compiler](generator.js#L60)
Scaffold out a complete project for a snapdragon **compiler** plugin.
**Example**
```sh
$ gen snapdragon:compiler
```
### [compiler-only](generator.js#L74)
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
```
### [parser](generator.js#L86)
Scaffold out a complete project for a snapdragon parser plugin.
**Example**
```sh
$ gen snapdragon:parser
```
### [parser-only](generator.js#L100)
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
### Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
### Building docs
_(This document was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme) (a [verb](https://github.com/verbose/verb) generator), please don't edit the readme directly. Any changes to the readme must be made in [.verb.md](.verb.md).)_
To generate the readme and API documentation with [verb](https://github.com/verbose/verb):
```sh
$ npm install -g verb verb-generate-readme && verb
```
### Running tests
Install dev dependencies:
```sh
$ npm install -d && npm test
```
### Author
**Jon Schlinkert**
* [github/jonschlinkert](https://github.com/jonschlinkert)
* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
### License
Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT license](LICENSE).
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.4.1, on January 20, 2017._