https://github.com/batterii/generator-ts-command

Batterii TypeScript command generator
https://github.com/batterii/generator-ts-command

Last synced: 9 days ago
JSON representation

Batterii TypeScript command generator

• Host: GitHub
• URL: https://github.com/batterii/generator-ts-command
• Owner: Batterii
• Created: 2019-06-10T15:04:36.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-05-01T08:01:38.000Z (over 1 year ago)
• Last Synced: 2024-11-07T00:07:47.732Z (13 days ago)
• Language: JavaScript
• Size: 363 KB
• Stars: 0
• Watchers: 5
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# @batterii/generator-ts-command

A [yeoman](https://yeoman.io/) generator for creating new commands in Batterii

TypeScript applications.

## Usage

```

  yo @batterii/ts-command [options]

Options:

  -h,   --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

        --force-install  # Fail on install dependencies error         Default: false

  -n,   --name           # Name of the commmand

```

## The Command Name

This generator accepts a `command` option, which will determine the name of the

command it creates. If not provided, the generator will prompt the user for it.

If a command with the provided name already exists in the project, the generator

will abort.

The command name must be dash-separated lowercase. This is not a requirement of

npm, but a useful convention.

## Modifying `package.json`

This generator will modify `package.json` at the root of the project by adding a

new entry to the `bin` field for the new command, as well as a new

`start:${command}` script for easily building and running your command during

development.

Due to this modification of an existing file, Yeoman will ask for confirmation

before proceeding. Simply type `y` and press enter to continue.

## Implementing Your Command

When the generator has finished, a new file will exist at `bin/${command}.ts`.

Implement your command here.