This is currently intended to be cloned as a starter template for a new node module. It was created to serve as a utility/backup for my module template experiments and is a bit outdated now.
git clone https://github.com/mdelucchi/originator.git your-module-name
watch - starts file watcher
lint - runs eslint on
test - runs tests and formats piped TAP output with tap-spec.
ci - Travis CI integration + zuul multi-framework & browser tests
cover - generates code coverage text-summary report in terminal
report - generates code coverage html report and opens it in browser
coveralls - runs code coverage and sends report to coveralls
zuul - runs browser tests via zuul at
babel-eslint - ESLint using Babel as the parser
babel-istanbul - excellent coverage tool
babelify - Browserify transform for Babel. Used in multi-framework testing with zuul.
blue-tape - substack's tape test runner with promise support
coveralls - test coverage and history statistics support for node.js
eslint-config-xo - ESLint shareable config for XO
eslint-plugin-babel - an eslint rule plugin companion to babel-eslint
nsp - check for vulnerabilities
rimraf - remove stuff
tap-spec - formatted TAP output
Travis CI / Sauce Connect Configuration
If you plan to use Sauce Connect in your new module, be sure to sign up with Sauce Labs if you haven’t already (it’s free for Open Source projects), and get your access key from your account page.
Then you'll want to replace the secured access key in
.travis.yml with your own. See the Getting Started guide on Travis for more info on setting this up.
Best bet if you're a new Travis and/or Sauce Labs user is to follow their steps to create a new
When you are ready to publish a new version of your module, the following steps can be used:
- add and commit your changes via git
npm version patch -m "Ugrade message..."
If publish is a success, the
postpublish npm script will run
git push origin master --follow-tags, pushing up and tagging your code properly.
If you run
npm version patch before committing your changes, you'll get a message like
npm ERR! Git working directory not clean.. Commit and retry.