node gulp

[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-url]][daviddm-image] [![Coverage Status][coveralls-image]][coveralls-url]

> 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 like jasmine.

* --skip-install

Skips the automatic execution of bower and npm 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

$3

- 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

$3

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/`.

- debug
- Lo-Dash
- q

$3

By default, the file looks something like this.

`
{
"meta": {
"githubUsername": "stefanbuck",
"authorName": "Stefan Buck",
"authorEmail": "me@stefanbuck.com",
"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.
- Node.js require(s) best practices

Team

- Stefan Buck
- Kentaro Wakayama
- Koji Wakayama

License

MIT License

Logo by Koji Wakayama

[npm-url]: https://npmjs.org/package/generator-node-gulp
[npm-image]: https://badge.fury.io/js/generator-node-gulp.svg
[travis-url]: https://travis-ci.org/youngmountain/generator-node-gulp
[travis-image]: https://travis-ci.org/youngmountain/generator-node-gulp.svg?branch=master
[daviddm-url]: https://david-dm.org/youngmountain/generator-node-gulp.svg?theme=shields.io
[daviddm-image]: https://david-dm.org/youngmountain/generator-node-gulp
[coveralls-url]: https://coveralls.io/r/youngmountain/generator-node-gulp
[coveralls-image]: https://coveralls.io/repos/youngmountain/generator-node-gulp/badge.png