https://github.com/trekjs/generator-tm

Scaffold out a Trek.js module
https://github.com/trekjs/generator-tm

Last synced: 7 months ago
JSON representation

Scaffold out a Trek.js module

• Host: GitHub
• URL: https://github.com/trekjs/generator-tm
• Owner: trekjs
• License: mit
• Created: 2016-10-08T17:12:58.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2016-10-16T06:14:19.000Z (about 9 years ago)
• Last Synced: 2025-04-23T13:14:40.800Z (8 months ago)
• Language: JavaScript
• Size: 28.3 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# generator-tm

> Scaffold out a Trek.js module

Optionally with a [CLI](http://en.wikipedia.org/wiki/Command-line_interface).

Forked from [generator-nm](https://github.com/sindresorhus/generator-nm).

## Install

```

$ npm install --global yo generator-tm

```

## Usage

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

```

$ yo nm

```

There are multiple command-line options available:

```

$ yo nm --help

  Usage:

    yo tm [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      # Upload coverage to codecov.io coveralls.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-coverage`). You will be prompted for any options not passed on the command-line.

## Tip

Use [chalk](https://github.com/sindresorhus/chalk) if you want colors in your CLI.

## Badges

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

[![codecov](https://codecov.io/gh/trekjs/generator-tm/branch/master/graph/badge.svg)](https://codecov.io/gh/trekjs/generator-tm)

![](https://img.shields.io/badge/license-MIT-blue.svg)

---

> [fundon.me](https://fundon.me)  · 

> GitHub [@fundon](https://github.com/fundon)  · 

> Twitter [@_fundon](https://twitter.com/_fundon)