Based on generator-node-gulp
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.
Install the generator by running: npm install -g generator-node-gulp-coffee.
-
--test-framework=[framework]Defaults to
mocha. Can be switched to another supported testing framework likejasmine. -
--skip-installSkips the automatic execution of
bowerandnpmafter scaffolding has finished.
- Customize the dependencies prompt by editing the
settings.jsonfile see. - Prefills prompt with the last used values for
- GitHub username
- Author's Name
- Author's Email
- Author's Homepage
- Mocha Unit Testing with gulp-mocha
- Automagically lint your code with gulp-coffeelint
- 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
- Optional - Easy dependency injection for node.js unit testing with [rewire] (https://github.com/jhnns/rewire)
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-coffee/.
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"
}
]
}
At the command-line, cd into an empty directory, run this command and follow the prompts.
yo node-gulp-coffee
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.
Should you have any problems or wishes for improvements, feel free to open an issue.
Logo by Koji Wakayama