generator-npkg

Scaffold out a node module


Keywords
yeoman-generator, plugin, boilerplate, template, scaffold, node, module, node_module, node-module, init, yogi
License
MIT
Install
npm install generator-npkg@1.1.5

Documentation

Generator nPKG pipeline status

NPM

Scaffold out a node module

Optionally with a CLI.

This is what I use for my own modules.

asciicast

Install

$ npm install --global yo generator-npkg

Usage

With yo:

$ yo npkg

There are multiple command-line options available:

$ yo npkg --help

  Usage:
    yo npkg [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 GitLab 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.

License

MIT © Yoginth