Package Exports
- conventional-cli
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (conventional-cli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
conventional-cli
Simple Conventional for Command Line Interface (CLI)
Table of Contents
Background
There are a lot of CLI. This repository contains a proposal to check create interfaces and models for conventional of all CLI tools.
Installation
NPM
npm install conventional-cliUsage
import { Argument, IArgument, ArgumentTypes } from 'conventional-cli';
const argument: IArgument = new Argument();
argument.longName = '--argument';
argument.shortName = '-A';
argument.description = 'Full description of argument';
argument.additionalDescription = 'Additional description of argument';
argument.type = ArgumentTypes.enum;
argument.values = ['enum1', 'enum2', 'enum3', 'enum4'];
argument.default = 'enum2';
argument.required = false;
argument.deprecated = false;
argument.delimiter = ' ';Contribute
You may contribute in several ways like requesting new features, adding tests, fixing bugs, improving documentation or examples. Please check our contributing guidelines.