Skip to content
Scaffold out a node module
JavaScript
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app
.editorconfig
.gitattributes
.gitignore
.npmrc
.travis.yml
license
package.json
readme.md
screenshot.png
test.js

readme.md

generator-nm Build Status

Scaffold out a node module

Optionally with a CLI.

This is what I use for my own modules.

Install

$ npm install --global yo generator-nm

Usage

With yo:

$ yo nm

There are multiple command-line options available:

$ yo nm --help

  Usage:
    yo nm [options]

  Options:
    --help          # Print the generator's options and usage
    --skip-cache    # Do not remember prompt answers                      Default: false
    --skip-install  # Do not automatically install dependencies           Default: false
    --org           # Publish to a GitHub organization account
    --cli           # Add a CLI
    --coverage      # Add code coverage with nyc
    --codecov       # Upload coverage to codecov.io (implies --coverage)

The --org option takes a string value (i.e. --org=avajs). All others are boolean flags and can be negated with the no prefix (i.e. --no-codecov). You will be prompted for any options not passed on the command-line.

Tip

Use chalk if you want colors in your CLI.

You can’t perform that action at this time.