generator-node-mdl

Create a Node.js module with ease

See node-mdl-starter, it is an example of what you get using this generator and it is automatically generated with every new release of this generator.

Why

• Generates a simple but ready to start project
• Includes only necessary tools
• Monitors repo quality through helpful badges
• Supports ES2015+ using Babel 7
• Jest testing framework
• Sensible ESLint config extends standard and Prettier
• Automates code reformatting using Prettier
• Build your documentations using esdoc (optional)
• Travis CI configuration (optional)
• Coveralls configuration (optional)
• Automatically deploy to npm registry with Travis CI (optional)
• Automates versioning releases with semantic-release and commitizen (optional)
• Friendly for contributions using Issue, Pull Request, and Contributing templates and some extras (optional)

Installation

npm install --global yo generator-node-mdl

Usage

yo node-mdl
# answer questions

With the most basic options, youʼll get a project structured like this:

$ tree
.
├── .github
│   ├── issue_template.md
│   └── pull_request_template.md
├── other
│   ├── code_of_conduct.md
│   ├── examples.md
│   └── roadmap.md
├── src
│   ├── index.js
│   └── index.test.js
├── .babelrc
├── .editorconfig
├── .esdoc.json
├── .eslintignore
├── .eslintrc
├── .gitattributes
├── .gitignore
├── .npmignore
├── .travis.yml
├── contributing.md
├── license
├── package.json
├── readme.md
└── yarn.lock

Less boilerplate 🎉

Options

There are 2 ways to supply your data to this generator. The obvious way is runnin yo node-mdl and answer all questions. You can bypass questions by passing options as arguments.

Run yo node-mdl --help to see the different options.

About passwords and tokens

This project contain some features that will make your life easier when setting up a new open-source project. Based on your choices, you may be asked to supply some of your accounts usernames and passwords (github, npm, etc...) so this project will automatically produce tokens for those accounts and save them to your TravisCI as secured enviorment variables if needed. You can bypass those questions by manually creating tokens and supply them using options as arguments.

1. --npmToken my-token is needed when using with --npmDeploy.

   Your token will end up in TravisCI as a secured enviorment variables called NPM_TOKEN.

   creating and viewing npm authentication tokens

2. --githubToken my-token is needed when using with --createGithubRepository or with --travisCI.

   creating and viewing github authentication tokens

   • When using with --createGithubRepository your token doesn't need to contain any scope.

   • When using with --travisCI but without --semanticRelease your token doesn't need to contain any scope.

   • When using with --travisCI and with --semanticRelease your token need to contain the following scopes:

     • repo
     • read:org
     • user:email
     • repo_deployment
     • repo:status
     • write:repo_hook

FAQ

How to upgrade existing project scaffolded with Yeoman?

Read how to do it here.

Forked from

generator-oss － Supports ES2015+ and XO by default

Related

• generator-bunny － Supports ES2015+ and Flow by default
• generator-kcd-oss － Lots of features but many things left untouched
• generator-nm － A way simpler Yeoman generator

License

MIT © Avi Sharvit