vamtiger-commandline-help
Get commandline help text.
Last updated a year ago by vamtiger-project .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install vamtiger-commandline-help 
SYNC missed versions from official npm registry.

VAMTIGER Commandline Help

Get help text.

Installation

VAMTIGER Commandline Help can be installed using npm or yarn:

npm i --save vamtiger-commandline-help

or

yarn add vamtiger-commandline-help

Once installed, VAMTIGER Commandline Help can be imported.

import getHelp from 'vamtiger-commandline-help';

or

const getHelp = require('vamtiger-commandline-help').default;

Help text can then be referenced as a string table.

const args = {
    argument: 'Argument',
    anotherArgument: 'Another'
};
const short = {
    argument: 'a',
    anotherArgument: 'A'
}
const description = {
    argument: 'Argument description',
    anotherArgument: 'Another argument description'
};
const help = getHelp({
    args,
    short,
    description
});

console.log(help);
/*
===================================================
| Argument | Short | Description                  |
===================================================
| Argument | a     | Argument description         |
---------------------------------------------------
| Another  | A     | Another argument description |
---------------------------------------------------
*/

Current Tags

  • 0.0.4                                ...           latest (a year ago)

3 Versions

  • 0.0.4                                ...           a year ago
  • 0.0.3                                ...           a year ago
  • 0.0.2                                ...           a year ago
Maintainers (1)
Downloads
Today 0
This Week 1
This Month 1
Last Day 0
Last Week 0
Last Month 3
Dependencies (1)
Dev Dependencies (12)

Copyright 2014 - 2016 © taobao.org |