NPM Package Boilerplate

Usage

# make a project folder
mkdir my_npm_package

# download source
curl -L https://api.github.com/repos/undirectlookable/npm-package-boilerplate/tarball/master | tar xz -C my_npm_package --strip-components 1
cd my_npm_package

# edit package.json
vi package.json

# install dependencies
npm install

Features

• ES6 - Transpiled by Babel
• Test - Jest
• Lint - ESLint
• Code Style - StandardJS
• CI - Auto tested by Travis CI
• CommonJS Module in lib/
• UMD Module in dist/ by rollup.js

Commands

• npm run clean - Remove lib/ and dist/ directory
• npm run dev - Watch files in src/ and babel into lib/
• npm run lint - Run ESLint
• npm run test - Run test tasks
• npm run coverage - Run test and generate coverage report
• npm run build - Build CommonJS and UMD Module

License

MIT