Boilermaker

Boilerplate configurator for modern JS.

Features

• develop in es2015+ code
• linting
• unit testing with ava
• code coverage
• generate documentation
• repl with current project context

Install

npm install pori/boilermaker

Then, in a Makefile in the root of your project:

include node_modules/boilermaker/Makefile

Usage

   build      - compile es2015+ code for distribution
   lint       - validate source code
   test       - run tests (lints, builds first)
   test-cov   - run tests with code coverage
   doc        - generate documentation (md by default)
   repl       - start node repl with built code automatically required
   help       - you're looking at it

Options

Set these before loading in the Makefile.

• BIN_DIR - location of babel, ava, eslint, and nyc binaries
• BUILD_DIR - destination for built es2015 code
• SRC_DIR - destination of source code
• BUILD_FLAGS - babel options
• LINT_FLAGS - eslint options
• TEST_FLAGS - ava options
• DOC_FLAGS - options for documentation.js

License

MIT

---

pori.io  ·  GitHub @pori  ·  Twitter @pori_alex