generator-node-gulp
v0.7.5
Published
A node generator for Yeoman
Downloads
32
Readme
Based on generator-node
This generator creates a new Node.js module, generating all the boilerplate you need to get started with best-of-breed from the gulp ecosystem. The generator also optionally installs additional gulp plugins, see the list below.
Installation
Install the generator by running: npm install -g generator-node-gulp
.
Options
--test-framework=[framework]
Defaults to
mocha
. Can be switched to another supported testing framework likejasmine
.--skip-install
Skips the automatic execution of
bower
andnpm
after scaffolding has finished.
Features
- Customize the dependencies prompt by editing the
settings.json
file see. - Prefills prompt with the last used values for
- GitHub username
- Author's Name
- Author's Email
- Author's Homepage
devDependencies
- Mocha Unit Testing with gulp-mocha
- Automagically lint your code with gulp-jshint
- Optional – Check JavaScript code style with gulp-jscs
- Optional – Measuring code coverage with gulp-istanbul
- Optional – Upload LCOV data to coveralls.io with coveralls
- Optional – Bump npm versions with gulp-bump
- Optional - Jasmine Unit Testing with gulp-jasmine
dependencies
You can customize the dependencies prompt by editing the settings.json
. The file is located in the root of the generator-node-gulp /usr/local/lib/node_modules/generator-node-gulp/
.
settings.json
By default, the file looks something like this.
{
"meta": {
"githubUsername": "stefanbuck",
"authorName": "Stefan Buck",
"authorEmail": "[email protected]",
"authorUrl": "www.stefanbuck.com"
},
"dependencies": [
{
"name": "lodash",
"description": "A utility library"
},
{
"name": "q",
"description": "A library for promises"
},
{
"name": "debug",
"description": "tiny node.js debugging utility"
}
]
}
Usage
At the command-line, cd into an empty directory, run this command and follow the prompts.
yo node-gulp
Note that this template will generate files in the current directory, so be sure to change to a new directory first if you don't want to overwrite existing files.
Support
Should you have any problems or wishes for improvements, feel free to open an issue.
Articles
Some recommended articles to get you started with node.
Team
License
Logo by Koji Wakayama