Create a Node.js module

Node Generator

generator-node creates a base template to start a new Node.js module.

It is also easily composed into your own generators so you can only target your efforts at your generator's specific features.

Maintained by Hemanth.HM.

$ npm install --global generator-node
$ yo node

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.

That'll generate a project with all the common tools setup. This includes:

Once the project is scaffolded, inside the project folder run:

$ npm test

You can also directly use mocha to run test on single files:

$ npm -g install mocha
$ mocha test/name.js

Once you're tests are passing (ideally with a Travis CI green run), you might be ready to publish your code to npm. We recommend you using npm version to tag release correctly.

$ npm version major
$ git push --follow-tags
# ATTENTION: There is no turning back here.
$ npm publish

First of all, make sure you're comfortable with Yeoman composability feature. Then in your own generator:

module.exports = generators.Base.extend({
  defaultfunction () {
    this.composeWith('node:app', {
      options: {/* provide the options you want */}
    }, {
      local: require.resolve('generator-node/generators/app')

Here's a list of our supported options:

  • travis (Boolean, default true) include or not a .travis.yml file.
  • boilerplate (Boolean, default true) include or not the boilerplate files (lib/index.js, test/index.js)

If you don't need all the features provided by the main generator, you can still use a limited set of features by composing with our sub generators directly.

Remember you can see the options of each sub generators by running yo node:sub --help.

  • node:boilerplate
  • node:editorconfig
  • node:git
  • node:gulp
  • node:jscs
  • node:jshint
  • node:readme
  • node:travis

MIT © Yeoman team (