Create a Node.js module
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 your 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:
moduleexports = generatorsBaseextendthiscomposeWith'node:app'options: /* provide the options you want */local: requireresolve'generator-node/generators/app';;
Here's a list of our supported options:
boilerplate(Boolean, default true) include or not the boilerplate files (
babel(Boolean, default true) include or not a
cli(Boolean, default false) include or not a
editorconfig(Boolean, default true) include or not a
git(Boolean, default true) include or not the git files (
gulp(Boolean, default true) include or not a
license(Boolean, default true) include or not a
travis(Boolean, default true) include or not a
githubAccount(String) Account name for GitHub repo location.
readme(String) content of the
README.mdfile. Given this option, generator-node will still generate the title (with badges) and the license section.
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.
Love Yeoman work and community? Help us keep it alive by donating funds to cover project expenses!
[Become a backer]
MIT © Yeoman team (http://yeoman.io)