generator-lnmdeprecated

Scaffold out a linted node module

Usage no npm install needed!

<script type="module">
  import generatorLnm from 'https://cdn.skypack.dev/generator-lnm';
</script>

README

generator-lnm Build Status

Awesome Node module generator

Features

Improvements generator-lnm over generator-nm:

This is what I use for my own modules.

Install

$ npm install --global yo generator-lnm

Usage

With yo:

$ yo lnm

There are multiple command-line options available:

$ yo lnm --help

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

Related projects

  • generator-nm - generator-lnm is forked from generator-nm. lnm stands for linted node module. Reasons for forking:

    • Linted markdown files
    • License includes line breaks to improve readability.
    • Link to license file in license section

    See changelog, PR #78 and PR #79 for reference.

  • minimal-readme - Clean readme template.

License

MIT © rodrigobdz