mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2026-08-12 04:50:18 +00:00
Merge pull request #14283 from jeffkenney/yargs-6.6.0
yargs: update for 6.6.0
This commit is contained in:
Arthur Ozga
@@ -0,0 +1,5 @@
|
||||
[*.ts]
|
||||
indent_style = space
|
||||
indent_size = 4
|
||||
end_of_line = lf
|
||||
charset = utf-8
|
||||
Vendored
+23
-3
@@ -1,6 +1,6 @@
|
||||
// Type definitions for yargs 6.5.0
|
||||
// Type definitions for yargs 6.6.0
|
||||
// Project: https://github.com/chevex/yargs
|
||||
// Definitions by: Martin Poelstra <https://github.com/poelstra>, Mizunashi Mana <https://github.com/mizunashi-mana>, Jeffery Grajkowski <https://github.com/pushplay>
|
||||
// Definitions by: Martin Poelstra <https://github.com/poelstra>, Mizunashi Mana <https://github.com/mizunashi-mana>, Jeffery Grajkowski <https://github.com/pushplay>, Jeff Kenney <https://github.com/jeffkenney>
|
||||
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
||||
|
||||
declare namespace yargs {
|
||||
@@ -28,6 +28,9 @@ declare namespace yargs {
|
||||
default(key: string, value: any, description?: string): Argv;
|
||||
default(defaults: { [key: string]: any }, description?: string): Argv;
|
||||
|
||||
/**
|
||||
* @deprecated since version 6.6.0
|
||||
*/
|
||||
demand(key: string, msg: string): Argv;
|
||||
demand(key: string, required?: boolean): Argv;
|
||||
demand(keys: string[], msg: string): Argv;
|
||||
@@ -36,6 +39,15 @@ declare namespace yargs {
|
||||
demand(positionals: number, msg: string): Argv;
|
||||
demand(positionals: number, max: number, msg?: string): Argv;
|
||||
|
||||
demandCommand(min: number, minMsg?: string): Argv;
|
||||
demandCommand(min: number, max?: number, minMsg?: string, maxMsg?: string): Argv;
|
||||
|
||||
demandOption(key: string | string[], msg?: string): Argv;
|
||||
demandOption(key: string | string[], demand?: boolean): Argv;
|
||||
|
||||
/**
|
||||
* @deprecated since version 6.6.0
|
||||
*/
|
||||
require(key: string, msg: string): Argv;
|
||||
require(key: string, required: boolean): Argv;
|
||||
require(keys: number[], msg: string): Argv;
|
||||
@@ -43,6 +55,9 @@ declare namespace yargs {
|
||||
require(positionals: number, required: boolean): Argv;
|
||||
require(positionals: number, msg: string): Argv;
|
||||
|
||||
/**
|
||||
* @deprecated since version 6.6.0
|
||||
*/
|
||||
required(key: string, msg: string): Argv;
|
||||
required(key: string, required: boolean): Argv;
|
||||
required(keys: number[], msg: string): Argv;
|
||||
@@ -103,6 +118,9 @@ declare namespace yargs {
|
||||
config(key: string, parseFn: (configPath: string) => Object): Argv;
|
||||
config(keys: string[], parseFn: (configPath: string) => Object): Argv;
|
||||
|
||||
conflicts(key: string, value: string): Argv;
|
||||
conflicts(conflicts: { [key: string]: string }): Argv;
|
||||
|
||||
wrap(columns: number): Argv;
|
||||
|
||||
strict(): Argv;
|
||||
@@ -147,7 +165,7 @@ declare namespace yargs {
|
||||
|
||||
fail(func: (msg: string, err: Error) => any): Argv;
|
||||
|
||||
coerce<T, U>(key: string|string[], func: (arg: T) => U): Argv;
|
||||
coerce<T, U>(key: string | string[], func: (arg: T) => U): Argv;
|
||||
coerce<T, U>(opts: { [key: string]: (arg: T) => U; }): Argv;
|
||||
|
||||
getCompletion(args: string[], done: (completions: string[]) => void): Argv;
|
||||
@@ -186,7 +204,9 @@ declare namespace yargs {
|
||||
count?: boolean;
|
||||
default?: any;
|
||||
defaultDescription?: string;
|
||||
/** @deprecated since version 6.6.0 */
|
||||
demand?: boolean | string;
|
||||
demandOption?: boolean | string;
|
||||
desc?: string;
|
||||
describe?: string;
|
||||
description?: string;
|
||||
|
||||
+391
-360
@@ -12,539 +12,539 @@ const stringVal = 'string';
|
||||
|
||||
// With yargs, the options be just a hash!
|
||||
function xup() {
|
||||
var argv = yargs.argv;
|
||||
var argv = yargs.argv;
|
||||
|
||||
if (argv.rif - 5 * argv.xup > 7.138) {
|
||||
console.log('Plunder more riffiwobbles!');
|
||||
}
|
||||
else {
|
||||
console.log('Drop the xupptumblers!');
|
||||
}
|
||||
if (argv.rif - 5 * argv.xup > 7.138) {
|
||||
console.log('Plunder more riffiwobbles!');
|
||||
}
|
||||
else {
|
||||
console.log('Drop the xupptumblers!');
|
||||
}
|
||||
}
|
||||
|
||||
// And non-hyphenated options too! Just use argv._!
|
||||
function nonopt() {
|
||||
var argv = yargs.argv;
|
||||
console.log('(%d,%d)', argv.x, argv.y);
|
||||
console.log(argv._);
|
||||
var argv = yargs.argv;
|
||||
console.log('(%d,%d)', argv.x, argv.y);
|
||||
console.log(argv._);
|
||||
}
|
||||
|
||||
// Yargs even counts your booleans!
|
||||
function count() {
|
||||
var argv = yargs
|
||||
.count('verbose')
|
||||
.alias('v', 'verbose')
|
||||
.argv;
|
||||
var argv = yargs
|
||||
.count('verbose')
|
||||
.alias('v', 'verbose')
|
||||
.argv;
|
||||
|
||||
var VERBOSE_LEVEL: number = argv.verbose;
|
||||
var VERBOSE_LEVEL: number = argv.verbose;
|
||||
|
||||
function WARN() { VERBOSE_LEVEL >= 0 && console.log.apply(console, arguments); }
|
||||
function INFO() { VERBOSE_LEVEL >= 1 && console.log.apply(console, arguments); }
|
||||
function DEBUG() { VERBOSE_LEVEL >= 2 && console.log.apply(console, arguments); }
|
||||
function WARN() { VERBOSE_LEVEL >= 0 && console.log.apply(console, arguments); }
|
||||
function INFO() { VERBOSE_LEVEL >= 1 && console.log.apply(console, arguments); }
|
||||
function DEBUG() { VERBOSE_LEVEL >= 2 && console.log.apply(console, arguments); }
|
||||
}
|
||||
|
||||
// Tell users how to use yer options and make demands.
|
||||
function divide() {
|
||||
var argv = yargs
|
||||
.usage('Usage: $0 -x [num] -y [num]')
|
||||
.demand(['x', 'y'])
|
||||
.argv;
|
||||
var argv = yargs
|
||||
.usage('Usage: $0 -x [num] -y [num]')
|
||||
.demand(['x', 'y'])
|
||||
.argv;
|
||||
|
||||
console.log(argv.x / argv.y);
|
||||
console.log(argv.x / argv.y);
|
||||
}
|
||||
|
||||
// After yer demands have been met, demand more! Ask for non-hypenated arguments!
|
||||
function demand_count() {
|
||||
var argv = yargs
|
||||
.demand(2)
|
||||
.demand(2, false)
|
||||
.demand(2, 2)
|
||||
.demand(2, 2, "message")
|
||||
.argv;
|
||||
console.dir(argv);
|
||||
var argv = yargs
|
||||
.demand(2)
|
||||
.demand(2, false)
|
||||
.demand(2, 2)
|
||||
.demand(2, 2, "message")
|
||||
.argv;
|
||||
console.dir(argv);
|
||||
}
|
||||
|
||||
// EVEN MORE SHIVER ME TIMBERS!
|
||||
function default_singles() {
|
||||
var argv = yargs
|
||||
.default('x', 10)
|
||||
.default('y', 10)
|
||||
.argv
|
||||
;
|
||||
console.log(argv.x + argv.y);
|
||||
var argv = yargs
|
||||
.default('x', 10)
|
||||
.default('y', 10)
|
||||
.argv
|
||||
;
|
||||
console.log(argv.x + argv.y);
|
||||
}
|
||||
function default_hash() {
|
||||
var argv = yargs
|
||||
.default({ x: 10, y: 10 })
|
||||
.argv
|
||||
;
|
||||
console.log(argv.x + argv.y);
|
||||
var argv = yargs
|
||||
.default({ x: 10, y: 10 })
|
||||
.argv
|
||||
;
|
||||
console.log(argv.x + argv.y);
|
||||
}
|
||||
|
||||
// And if you really want to get all descriptive about it...
|
||||
function boolean_single() {
|
||||
var argv = yargs
|
||||
.boolean('v')
|
||||
.argv
|
||||
;
|
||||
console.dir(argv.v);
|
||||
console.dir(argv._);
|
||||
var argv = yargs
|
||||
.boolean('v')
|
||||
.argv
|
||||
;
|
||||
console.dir(argv.v);
|
||||
console.dir(argv._);
|
||||
}
|
||||
function boolean_double() {
|
||||
var argv = yargs
|
||||
.boolean(['x', 'y', 'z'])
|
||||
.argv
|
||||
;
|
||||
console.dir([argv.x, argv.y, argv.z]);
|
||||
console.dir(argv._);
|
||||
var argv = yargs
|
||||
.boolean(['x', 'y', 'z'])
|
||||
.argv
|
||||
;
|
||||
console.dir([argv.x, argv.y, argv.z]);
|
||||
console.dir(argv._);
|
||||
}
|
||||
|
||||
// Yargs is here to help you...
|
||||
function line_count() {
|
||||
var argv = yargs
|
||||
.usage('Count the lines in a file.\nUsage: $0')
|
||||
.example('$0 -f', 'count the lines in the given file')
|
||||
.demand('f')
|
||||
.alias('f', 'file')
|
||||
.describe('f', 'Load a file')
|
||||
.argv
|
||||
;
|
||||
var argv = yargs
|
||||
.usage('Count the lines in a file.\nUsage: $0')
|
||||
.example('$0 -f', 'count the lines in the given file')
|
||||
.demand('f')
|
||||
.alias('f', 'file')
|
||||
.describe('f', 'Load a file')
|
||||
.argv
|
||||
;
|
||||
}
|
||||
|
||||
// Below are tests for individual methods.
|
||||
// Not all methods are covered yet, and neither are all possible invocations of methods.
|
||||
|
||||
function Argv_parsing() {
|
||||
var argv1 = yargs.argv;
|
||||
var argv2 = yargs(['-x', '1', '-y', '2']).argv;
|
||||
var argv3 = yargs.parse(['-x', '1', '-y', '2']);
|
||||
console.log(argv1.x, argv2.x, argv3.x);
|
||||
var argv1 = yargs.argv;
|
||||
var argv2 = yargs(['-x', '1', '-y', '2']).argv;
|
||||
var argv3 = yargs.parse(['-x', '1', '-y', '2']);
|
||||
console.log(argv1.x, argv2.x, argv3.x);
|
||||
}
|
||||
|
||||
function Argv$options() {
|
||||
var argv1 = yargs
|
||||
.options('f', {
|
||||
alias: 'file',
|
||||
default: '/etc/passwd',
|
||||
defaultDescription: 'The /etc/passwd file',
|
||||
group: 'files',
|
||||
normalize: true,
|
||||
global: false,
|
||||
array: true,
|
||||
nargs: 3
|
||||
})
|
||||
.argv
|
||||
;
|
||||
var argv1 = yargs
|
||||
.options('f', {
|
||||
alias: 'file',
|
||||
default: '/etc/passwd',
|
||||
defaultDescription: 'The /etc/passwd file',
|
||||
group: 'files',
|
||||
normalize: true,
|
||||
global: false,
|
||||
array: true,
|
||||
nargs: 3
|
||||
})
|
||||
.argv
|
||||
;
|
||||
|
||||
var argv2 = yargs
|
||||
.alias('f', 'file')
|
||||
.default('f', '/etc/passwd')
|
||||
.argv
|
||||
;
|
||||
var argv2 = yargs
|
||||
.alias('f', 'file')
|
||||
.default('f', '/etc/passwd')
|
||||
.argv
|
||||
;
|
||||
}
|
||||
|
||||
function Argv$global() {
|
||||
var argv = yargs
|
||||
.global('foo')
|
||||
.global(['bar', 'baz', 'fizz', 'buzz'])
|
||||
var argv = yargs
|
||||
.global('foo')
|
||||
.global(['bar', 'baz', 'fizz', 'buzz'])
|
||||
}
|
||||
|
||||
function Argv$group() {
|
||||
var argv = yargs
|
||||
.group('foo', 'foogroup')
|
||||
.group(['bing', 'bang', 'buzz'], 'onomatopoeia')
|
||||
var argv = yargs
|
||||
.group('foo', 'foogroup')
|
||||
.group(['bing', 'bang', 'buzz'], 'onomatopoeia')
|
||||
}
|
||||
|
||||
function Argv$env() {
|
||||
var argv = yargs
|
||||
.env('YARGS_PREFIX_')
|
||||
.env()
|
||||
.env(true);
|
||||
var argv = yargs
|
||||
.env('YARGS_PREFIX_')
|
||||
.env()
|
||||
.env(true);
|
||||
}
|
||||
|
||||
function Argv$array() {
|
||||
var argv = yargs
|
||||
.array('foo')
|
||||
.array(['bar', 'baz'])
|
||||
var argv = yargs
|
||||
.array('foo')
|
||||
.array(['bar', 'baz'])
|
||||
}
|
||||
|
||||
function Argv$nargs() {
|
||||
var argv = yargs
|
||||
.nargs('foo', 12)
|
||||
.nargs({ 'bing': 3, 'bang': 2, 'buzz': 4 })
|
||||
var argv = yargs
|
||||
.nargs('foo', 12)
|
||||
.nargs({ 'bing': 3, 'bang': 2, 'buzz': 4 })
|
||||
}
|
||||
|
||||
function Argv$choices() {
|
||||
// example from documentation
|
||||
var argv = yargs
|
||||
.alias('i', 'ingredient')
|
||||
.describe('i', 'choose your sandwich ingredients')
|
||||
.choices('i', ['peanut-butter', 'jelly', 'banana', 'pickles'])
|
||||
.help('help')
|
||||
.argv
|
||||
// example from documentation
|
||||
var argv = yargs
|
||||
.alias('i', 'ingredient')
|
||||
.describe('i', 'choose your sandwich ingredients')
|
||||
.choices('i', ['peanut-butter', 'jelly', 'banana', 'pickles'])
|
||||
.help('help')
|
||||
.argv
|
||||
}
|
||||
|
||||
function command() {
|
||||
var argv = yargs
|
||||
.usage('npm <command>')
|
||||
.command('install', 'tis a mighty fine package to install')
|
||||
.command('publish', 'shiver me timbers, should you be sharing all that', yargs =>
|
||||
yargs.option('f', {
|
||||
alias: 'force',
|
||||
description: 'yar, it usually be a bad idea'
|
||||
})
|
||||
.help('help')
|
||||
)
|
||||
.command("build", "arghh, build it mate", {
|
||||
tag: {
|
||||
default: true,
|
||||
demand: true,
|
||||
description: "Tag the build, mate!"
|
||||
},
|
||||
publish: {
|
||||
default: false,
|
||||
description:"Should i publish?"
|
||||
}
|
||||
})
|
||||
.command({
|
||||
command: "test",
|
||||
describe: "test package",
|
||||
builder: {
|
||||
mateys: {
|
||||
demand: false
|
||||
}
|
||||
},
|
||||
handler: (args: any) => {
|
||||
/* handle me mateys! */
|
||||
}
|
||||
})
|
||||
.command("test", "test mateys", {
|
||||
handler: (args: any) => {
|
||||
/* handle me mateys! */
|
||||
}
|
||||
})
|
||||
.help('help')
|
||||
.argv;
|
||||
var argv = yargs
|
||||
.usage('npm <command>')
|
||||
.command('install', 'tis a mighty fine package to install')
|
||||
.command('publish', 'shiver me timbers, should you be sharing all that', yargs =>
|
||||
yargs.option('f', {
|
||||
alias: 'force',
|
||||
description: 'yar, it usually be a bad idea'
|
||||
})
|
||||
.help('help')
|
||||
)
|
||||
.command("build", "arghh, build it mate", {
|
||||
tag: {
|
||||
default: true,
|
||||
demand: true,
|
||||
description: "Tag the build, mate!"
|
||||
},
|
||||
publish: {
|
||||
default: false,
|
||||
description:"Should i publish?"
|
||||
}
|
||||
})
|
||||
.command({
|
||||
command: "test",
|
||||
describe: "test package",
|
||||
builder: {
|
||||
mateys: {
|
||||
demand: false
|
||||
}
|
||||
},
|
||||
handler: (args: any) => {
|
||||
/* handle me mateys! */
|
||||
}
|
||||
})
|
||||
.command("test", "test mateys", {
|
||||
handler: (args: any) => {
|
||||
/* handle me mateys! */
|
||||
}
|
||||
})
|
||||
.help('help')
|
||||
.argv;
|
||||
|
||||
yargs
|
||||
.command('get', 'make a get HTTP request', function (yargs) {
|
||||
return yargs.option('url', {
|
||||
alias: 'u',
|
||||
default: 'http://yargs.js.org/'
|
||||
})
|
||||
})
|
||||
.help()
|
||||
.argv
|
||||
yargs
|
||||
.command('get', 'make a get HTTP request', function (yargs) {
|
||||
return yargs.option('url', {
|
||||
alias: 'u',
|
||||
default: 'http://yargs.js.org/'
|
||||
})
|
||||
})
|
||||
.help()
|
||||
.argv
|
||||
|
||||
yargs
|
||||
.command(
|
||||
'get',
|
||||
'make a get HTTP request',
|
||||
function (yargs) {
|
||||
return yargs.option('u', {
|
||||
alias: 'url',
|
||||
describe: 'the URL to make an HTTP request to'
|
||||
})
|
||||
},
|
||||
function (argv: { url: string }) {
|
||||
console.dir(argv.url)
|
||||
}
|
||||
)
|
||||
.help()
|
||||
.argv
|
||||
yargs
|
||||
.command(
|
||||
'get',
|
||||
'make a get HTTP request',
|
||||
function (yargs) {
|
||||
return yargs.option('u', {
|
||||
alias: 'url',
|
||||
describe: 'the URL to make an HTTP request to'
|
||||
})
|
||||
},
|
||||
function (argv: { url: string }) {
|
||||
console.dir(argv.url)
|
||||
}
|
||||
)
|
||||
.help()
|
||||
.argv
|
||||
}
|
||||
|
||||
function completion_sync() {
|
||||
var argv = yargs
|
||||
.completion('completion', (current, argv) => {
|
||||
// 'current' is the current command being completed.
|
||||
// 'argv' is the parsed arguments so far.
|
||||
// simply return an array of completions.
|
||||
return [
|
||||
'foo',
|
||||
'bar'
|
||||
];
|
||||
})
|
||||
.argv;
|
||||
var argv = yargs
|
||||
.completion('completion', (current, argv) => {
|
||||
// 'current' is the current command being completed.
|
||||
// 'argv' is the parsed arguments so far.
|
||||
// simply return an array of completions.
|
||||
return [
|
||||
'foo',
|
||||
'bar'
|
||||
];
|
||||
})
|
||||
.argv;
|
||||
}
|
||||
|
||||
function completion_async() {
|
||||
var argv = yargs
|
||||
.completion('completion', (current: string, argv: any, done: (completion: string[]) => void) => {
|
||||
setTimeout(function () {
|
||||
done([
|
||||
'apple',
|
||||
'banana'
|
||||
]);
|
||||
}, 500);
|
||||
})
|
||||
.argv;
|
||||
var argv = yargs
|
||||
.completion('completion', (current: string, argv: any, done: (completion: string[]) => void) => {
|
||||
setTimeout(function () {
|
||||
done([
|
||||
'apple',
|
||||
'banana'
|
||||
]);
|
||||
}, 500);
|
||||
})
|
||||
.argv;
|
||||
}
|
||||
|
||||
function Argv$help() {
|
||||
var argv = yargs
|
||||
.usage("$0 -operand1 number -operand2 number -operation [add|subtract]")
|
||||
.help()
|
||||
.argv;
|
||||
var argv = yargs
|
||||
.usage("$0 -operand1 number -operand2 number -operation [add|subtract]")
|
||||
.help()
|
||||
.argv;
|
||||
}
|
||||
|
||||
function Argv$showHelpOnFail() {
|
||||
var argv = yargs
|
||||
.usage('Count the lines in a file.\nUsage: $0')
|
||||
.demand('f')
|
||||
.alias('f', 'file')
|
||||
.describe('f', 'Load a file')
|
||||
.showHelpOnFail(false, "Specify --help for available options")
|
||||
.argv;
|
||||
var argv = yargs
|
||||
.usage('Count the lines in a file.\nUsage: $0')
|
||||
.demand('f')
|
||||
.alias('f', 'file')
|
||||
.describe('f', 'Load a file')
|
||||
.showHelpOnFail(false, "Specify --help for available options")
|
||||
.argv;
|
||||
}
|
||||
|
||||
function Argv$showHelp() {
|
||||
var yargs1 = yargs
|
||||
.usage("$0 -operand1 number -operand2 number -operation [add|subtract]");
|
||||
yargs1.showHelp();
|
||||
var yargs1 = yargs
|
||||
.usage("$0 -operand1 number -operand2 number -operation [add|subtract]");
|
||||
yargs1.showHelp();
|
||||
}
|
||||
|
||||
function Argv$version() {
|
||||
var argv1 = yargs
|
||||
.version();
|
||||
var argv1 = yargs
|
||||
.version();
|
||||
|
||||
var argv2 = yargs
|
||||
.version('1.0.0');
|
||||
var argv2 = yargs
|
||||
.version('1.0.0');
|
||||
|
||||
var argv3 = yargs
|
||||
.version('1.0.0', '--version');
|
||||
var argv3 = yargs
|
||||
.version('1.0.0', '--version');
|
||||
|
||||
var argv4 = yargs
|
||||
.version('1.0.0', '--version', 'description');
|
||||
var argv4 = yargs
|
||||
.version('1.0.0', '--version', 'description');
|
||||
|
||||
var argv5 = yargs
|
||||
.version(function () { return '1.0.0'; }, '--version', 'description');
|
||||
var argv5 = yargs
|
||||
.version(function () { return '1.0.0'; }, '--version', 'description');
|
||||
}
|
||||
|
||||
function Argv$wrap() {
|
||||
var argv1 = yargs
|
||||
.wrap(null);
|
||||
var argv1 = yargs
|
||||
.wrap(null);
|
||||
|
||||
var argv2 = yargs
|
||||
.wrap(yargs.terminalWidth());
|
||||
var argv2 = yargs
|
||||
.wrap(yargs.terminalWidth());
|
||||
}
|
||||
|
||||
function Argv$locale() {
|
||||
var argv = yargs
|
||||
.usage('./$0 - follow ye instructions true')
|
||||
.option('option', {
|
||||
alias: 'o',
|
||||
describe: "'tis a mighty fine option",
|
||||
demand: true
|
||||
})
|
||||
.command('run', "Arrr, ya best be knowin' what yer doin'")
|
||||
.example('$0 run foo', "shiver me timbers, here's an example for ye")
|
||||
.help('help')
|
||||
.wrap(70)
|
||||
.locale('pirate')
|
||||
.argv
|
||||
var argv = yargs
|
||||
.usage('./$0 - follow ye instructions true')
|
||||
.option('option', {
|
||||
alias: 'o',
|
||||
describe: "'tis a mighty fine option",
|
||||
demand: true
|
||||
})
|
||||
.command('run', "Arrr, ya best be knowin' what yer doin'")
|
||||
.example('$0 run foo', "shiver me timbers, here's an example for ye")
|
||||
.help('help')
|
||||
.wrap(70)
|
||||
.locale('pirate')
|
||||
.argv
|
||||
}
|
||||
|
||||
function Argv$epilogue() {
|
||||
var argv = yargs
|
||||
.epilogue('for more information, find our manual at http://example.com');
|
||||
var argv = yargs
|
||||
.epilogue('for more information, find our manual at http://example.com');
|
||||
}
|
||||
|
||||
function Argv$reset() {
|
||||
var ya = yargs
|
||||
.usage('$0 command')
|
||||
.command('hello', 'hello command')
|
||||
.command('world', 'world command')
|
||||
.demand(1, 'must provide a valid command'),
|
||||
argv = yargs.argv,
|
||||
command = argv._[0];
|
||||
var ya = yargs
|
||||
.usage('$0 command')
|
||||
.command('hello', 'hello command')
|
||||
.command('world', 'world command')
|
||||
.demand(1, 'must provide a valid command'),
|
||||
argv = yargs.argv,
|
||||
command = argv._[0];
|
||||
|
||||
if (command === 'hello') {
|
||||
ya.reset()
|
||||
.usage('$0 hello')
|
||||
.help('h')
|
||||
.example('$0 hello', 'print the hello message!')
|
||||
.argv
|
||||
if (command === 'hello') {
|
||||
ya.reset()
|
||||
.usage('$0 hello')
|
||||
.help('h')
|
||||
.example('$0 hello', 'print the hello message!')
|
||||
.argv
|
||||
|
||||
console.log('hello!');
|
||||
} else if (command === 'world') {
|
||||
ya.reset()
|
||||
.usage('$0 world')
|
||||
.help('h')
|
||||
.example('$0 world', 'print the world message!')
|
||||
.argv
|
||||
console.log('hello!');
|
||||
} else if (command === 'world') {
|
||||
ya.reset()
|
||||
.usage('$0 world')
|
||||
.help('h')
|
||||
.example('$0 world', 'print the world message!')
|
||||
.argv
|
||||
|
||||
console.log('world!');
|
||||
} else {
|
||||
ya.showHelp();
|
||||
}
|
||||
console.log('world!');
|
||||
} else {
|
||||
ya.showHelp();
|
||||
}
|
||||
}
|
||||
|
||||
// http://yargs.js.org/docs/#methods-commanddirdirectory-opts
|
||||
function Argv$commandDir() {
|
||||
var ya = yargs
|
||||
.commandDir('.')
|
||||
.argv
|
||||
var ya = yargs
|
||||
.commandDir('.')
|
||||
.argv
|
||||
}
|
||||
|
||||
|
||||
// http://yargs.js.org/docs/#methods-commanddirdirectory-opts
|
||||
function Argv$commandDirWithOptions() {
|
||||
var ya = yargs
|
||||
.commandDir('.', {
|
||||
recurse: false,
|
||||
extensions: ['js'],
|
||||
visit: (commandObject: any, pathToFile: string, filename: string) => { },
|
||||
include: /.*\.js$/,
|
||||
exclude: /.*\.spec.js$/,
|
||||
})
|
||||
.argv
|
||||
var ya = yargs
|
||||
.commandDir('.', {
|
||||
recurse: false,
|
||||
extensions: ['js'],
|
||||
visit: (commandObject: any, pathToFile: string, filename: string) => { },
|
||||
include: /.*\.js$/,
|
||||
exclude: /.*\.spec.js$/,
|
||||
})
|
||||
.argv
|
||||
}
|
||||
|
||||
function Argv$normalize() {
|
||||
var ya = yargs
|
||||
.normalize('path')
|
||||
.normalize(['user', 'group'])
|
||||
.argv
|
||||
var ya = yargs
|
||||
.normalize('path')
|
||||
.normalize(['user', 'group'])
|
||||
.argv
|
||||
}
|
||||
|
||||
// From http://yargs.js.org/docs/#methods-coercekey-fn
|
||||
function Argv$coerce() {
|
||||
var ya = yargs
|
||||
.coerce('file', function (arg: string) {
|
||||
return fs.readFileSync(arg, 'utf8');
|
||||
})
|
||||
.argv
|
||||
var ya = yargs
|
||||
.coerce('file', function (arg: string) {
|
||||
return fs.readFileSync(arg, 'utf8');
|
||||
})
|
||||
.argv
|
||||
}
|
||||
function Argv$coerces() {
|
||||
var ya = yargs
|
||||
.coerce({
|
||||
date: Date.parse,
|
||||
json: JSON.parse
|
||||
})
|
||||
.argv
|
||||
var ya = yargs
|
||||
.coerce({
|
||||
date: Date.parse,
|
||||
json: JSON.parse
|
||||
})
|
||||
.argv
|
||||
}
|
||||
function Argv$coerceWithKeys() {
|
||||
var ya = yargs
|
||||
.coerce(['src', 'dest'], path.resolve)
|
||||
.argv
|
||||
var ya = yargs
|
||||
.coerce(['src', 'dest'], path.resolve)
|
||||
.argv
|
||||
}
|
||||
|
||||
// From http://yargs.js.org/docs/#methods-failfn
|
||||
function Argv$fail() {
|
||||
var ya = yargs
|
||||
.fail(function (msg, err) {
|
||||
if (err) throw err // preserve stack
|
||||
console.error('You broke it!')
|
||||
console.error(msg)
|
||||
process.exit(1)
|
||||
})
|
||||
.argv
|
||||
var ya = yargs
|
||||
.fail(function (msg, err) {
|
||||
if (err) throw err // preserve stack
|
||||
console.error('You broke it!')
|
||||
console.error(msg)
|
||||
process.exit(1)
|
||||
})
|
||||
.argv
|
||||
}
|
||||
|
||||
function Argv$implies() {
|
||||
var ya = yargs
|
||||
.implies('foo', 'snuh')
|
||||
.implies({
|
||||
x: 'y'
|
||||
})
|
||||
.argv
|
||||
var ya = yargs
|
||||
.implies('foo', 'snuh')
|
||||
.implies({
|
||||
x: 'y'
|
||||
})
|
||||
.argv
|
||||
}
|
||||
|
||||
function Argv$count() {
|
||||
var ya = yargs
|
||||
.count('size')
|
||||
.count(['w', 'h'])
|
||||
.argv
|
||||
var ya = yargs
|
||||
.count('size')
|
||||
.count(['w', 'h'])
|
||||
.argv
|
||||
}
|
||||
|
||||
function Argv$number() {
|
||||
var ya = yargs
|
||||
.number('n')
|
||||
.number(['width', 'height'])
|
||||
.argv
|
||||
var ya = yargs
|
||||
.number('n')
|
||||
.number(['width', 'height'])
|
||||
.argv
|
||||
}
|
||||
|
||||
function Argv$updateStrings() {
|
||||
var ya = yargs
|
||||
.command('run', 'the run command')
|
||||
.help('help')
|
||||
.updateStrings({
|
||||
'Commands:': 'My Commands -->\n'
|
||||
})
|
||||
.wrap(null)
|
||||
.argv
|
||||
var ya = yargs
|
||||
.command('run', 'the run command')
|
||||
.help('help')
|
||||
.updateStrings({
|
||||
'Commands:': 'My Commands -->\n'
|
||||
})
|
||||
.wrap(null)
|
||||
.argv
|
||||
}
|
||||
|
||||
function Argv$default() {
|
||||
var ya = yargs
|
||||
.default('random', function randomValue() {
|
||||
return Math.random() * 256;
|
||||
})
|
||||
.argv
|
||||
var ya = yargs
|
||||
.default('random', function randomValue() {
|
||||
return Math.random() * 256;
|
||||
})
|
||||
.argv
|
||||
}
|
||||
|
||||
function Argv$configObject() {
|
||||
var ya = yargs
|
||||
.config({foo: 1, bar: 2})
|
||||
.argv
|
||||
var ya = yargs
|
||||
.config({foo: 1, bar: 2})
|
||||
.argv
|
||||
}
|
||||
|
||||
function Argv$configParseFunction() {
|
||||
var ya = yargs
|
||||
.config('settings', function (configPath) {
|
||||
return JSON.parse(fs.readFileSync(configPath, 'utf-8'))
|
||||
})
|
||||
.config('settings', 'description', function (configPath) {
|
||||
return JSON.parse(fs.readFileSync(configPath, 'utf-8'))
|
||||
})
|
||||
.argv
|
||||
var ya = yargs
|
||||
.config('settings', function (configPath) {
|
||||
return JSON.parse(fs.readFileSync(configPath, 'utf-8'))
|
||||
})
|
||||
.config('settings', 'description', function (configPath) {
|
||||
return JSON.parse(fs.readFileSync(configPath, 'utf-8'))
|
||||
})
|
||||
.argv
|
||||
}
|
||||
|
||||
function Argv$helpDescriptionExplicit() {
|
||||
var ya = yargs
|
||||
.help('help', 'description', true)
|
||||
.argv
|
||||
var ya = yargs
|
||||
.help('help', 'description', true)
|
||||
.argv
|
||||
}
|
||||
|
||||
function Argv$showHelpConsoleLevel() {
|
||||
yargs.showHelp("log"); //prints to stdout using console.log()
|
||||
yargs.showHelp("log"); //prints to stdout using console.log()
|
||||
}
|
||||
|
||||
function Argv$getCompletion() {
|
||||
var ya = yargs
|
||||
.option('foobar', {})
|
||||
.option('foobaz', {})
|
||||
.completion()
|
||||
.getCompletion(['./test.js', '--foo'], function (completions) {
|
||||
console.log(completions)
|
||||
})
|
||||
.argv
|
||||
var ya = yargs
|
||||
.option('foobar', {})
|
||||
.option('foobaz', {})
|
||||
.completion()
|
||||
.getCompletion(['./test.js', '--foo'], function (completions) {
|
||||
console.log(completions)
|
||||
})
|
||||
.argv
|
||||
}
|
||||
|
||||
function Argv$pkgConf() {
|
||||
var ya = yargs
|
||||
.pkgConf(['key1', 'key2'], 'configFile.json')
|
||||
.argv
|
||||
var ya = yargs
|
||||
.pkgConf(['key1', 'key2'], 'configFile.json')
|
||||
.argv
|
||||
}
|
||||
|
||||
function Argv$recommendCommands() {
|
||||
var ya = yargs
|
||||
.recommendCommands()
|
||||
.argv
|
||||
var ya = yargs
|
||||
.recommendCommands()
|
||||
.argv
|
||||
}
|
||||
|
||||
function Argv$showCompletionScript() {
|
||||
var ya = yargs
|
||||
.showCompletionScript()
|
||||
.argv
|
||||
var ya = yargs
|
||||
.showCompletionScript()
|
||||
.argv
|
||||
}
|
||||
|
||||
function Argv$skipValidation() {
|
||||
var ya = yargs
|
||||
.skipValidation('arg1')
|
||||
.skipValidation(['arg2', 'arg3'])
|
||||
.argv
|
||||
var ya = yargs
|
||||
.skipValidation('arg1')
|
||||
.skipValidation(['arg2', 'arg3'])
|
||||
.argv
|
||||
}
|
||||
|
||||
function Argv$commandObject() {
|
||||
@@ -562,6 +562,7 @@ function Argv$commandObject() {
|
||||
default: "myvalue",
|
||||
defaultDescription: "description",
|
||||
demand: true,
|
||||
demandOption: true,
|
||||
desc: "desc",
|
||||
describe: "describe",
|
||||
description: "description",
|
||||
@@ -577,3 +578,33 @@ function Argv$commandObject() {
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
function Argv$demandCommand() {
|
||||
var ya = yargs
|
||||
.demandCommand(1)
|
||||
.demandCommand(1, 'at least 1 command required')
|
||||
.demandCommand(1, 2)
|
||||
.demandCommand(1, 2, 'at least 1 command required')
|
||||
.demandCommand(1, 2, 'at least 1 command required', 'at most 2 commands required')
|
||||
.argv;
|
||||
}
|
||||
|
||||
function Argv$demandOption() {
|
||||
var ya = yargs
|
||||
.demandOption('a')
|
||||
.demandOption('a', 'a is required')
|
||||
.demandOption('a', true)
|
||||
.demandOption(['a', 'b'])
|
||||
.demandOption(['a', 'b'], 'a and b are required')
|
||||
.demandOption(['a', 'b'], true)
|
||||
.argv;
|
||||
}
|
||||
|
||||
function Argv$conflicts() {
|
||||
var ya = yargs
|
||||
.conflicts('a', 'b')
|
||||
.conflicts({
|
||||
a: 'b'
|
||||
})
|
||||
.argv;
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user