https://github.com/omgimalexis/generator-q

Q - Generate a Node module
https://github.com/omgimalexis/generator-q

Last synced: 29 days ago
JSON representation

Q - Generate a Node module

• Host: GitHub
• URL: https://github.com/omgimalexis/generator-q
• Owner: OmgImAlexis
• License: mit
• Created: 2017-10-22T06:34:50.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2018-04-26T03:29:28.000Z (over 6 years ago)
• Last Synced: 2024-10-14T07:53:40.948Z (about 1 month ago)
• Language: JavaScript
• Size: 295 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

README

        
# generator-q [![Build Status](https://travis-ci.org/omgimalexis/generator-q.svg?branch=master)](https://travis-ci.org/omgimalexis/generator-q)

> Scaffold out a node module

This is what I use for [my own modules](https://www.npmjs.com/~omgimalexis).

![](screenshot.png)

## Install

```

$ npm install --global yo generator-q

```

## Usage

With [yo](https://github.com/yeoman/yo):

```

$ yo q

```

There are multiple command-line options available:

```

$ yo q --help

  Usage:

    yo q [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.

## License

MIT © [Sindre Sorhus](https://sindresorhus.com)