Sprout based Node/CommonJS package generator.
Installation / Usage
npm install -g sproutsprout add commonjs-lib https://github.com/wilmoore/sprout-commonjs-libsprout init commonjs-lib my-new-lib
NOTE: You may pass a relative path (as depicted above) or a full path as the last parameter to
- Green test suite via tape & npm test.
- Run tests automatically on file change via nodemon.
- CI via Travis CI w/ docker support enabled & node_modules cached.
- Dependency checking via dependency-check.
- Support for npm scoped packages.
- Markdown-based README with awesome repo badges via Shields.IO.
- Changelog per Keep a CHANGELOG.
- Contributer Guidelines.
- EditorConfig support.
- MIT license.
Why use this generator over the others?
How one builds Node modules is a fairly personal and evolving process. It should also be as painless as possible. I personally prefer to use a generator that streamlines the way I build modules/packages over generators that provide a ton of options. If I find that I need those options, I'll bake them into the process.
If your module/package building process is similar to mine, then this is the right generator for you. If it is close but you feel like my process is missing something, check out the contributing doc and send over a PR.
Input-based template variables
github_user_nameGitHub user name.
github_user_emailGitHub user email.
package_nameName of the project.
repo_nameGitHub repository name (without username).
travisWhether to use Travis CI.
Derived template variables
author_full_namePackage author's full name.
export_nameDefault module export name (camelCased package name).
github_clone_urlGitHub clone URL.
simple_namepackage name with file extension removed.