bolts

An opinionated bootstrap for node.js project by Tony Lukasavage. While this can be used for any node.js project, my focus has been primarily on tooling and CLI when building on Mac OSX. The core modules and tools used to create the bootstrapped module are:

• grunt for task management
• mocha for unit testing
• should for assertions
• istanbul for test coverage
• jshint for linting

Requirements

• node.js
• git (optional)

Install

$ npm install -g bolts

Usage

Below shows all possible options when running bolts. If any required values are omitted, you will be prompted for them.

$ bolts --help

  Usage: bolts [options]

  Options:

    -h, --help                       output usage information
    -v, --version                    output the version number
    -B, --no-banner                  Disable the banner
    -c, --config <config>            Configuration file for defaults
    -d, --description <description>  Description of the project
    -f, --force                      Overwrite existing project if present
    -e, --email <email>              You email address
    -g, --github <github>            Your github username
    -n, --name <name>                Your full name
    -p, --project <project>          Name of the project
    -P, --no-prompt                  Diable prompting
    -q, --quiet                      Disable all logging output, implies --no-prompt
    -u, --url <url>                  URL of the project
    -y, --year <year>                Year to use for copyright

Testing

# run jshint and unit tests
$ grunt

# create coverage report in ./coverage/index.html
$ grunt coverage