Add typings for 'yargs'.

2026-09-09 11:13:57 +08:00 · 2014-10-22 12:20:07 +02:00
parent bd9a1922e4
commit e24d68612a
3 changed files with 274 additions and 0 deletions
@@ -0,0 +1,157 @@
+// Type definition tests for yargs
+// Project: https://github.com/chevex/yargs
+// Definitions by: Martin Poelstra <https://github.com/poelstra>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+/// <reference path="yargs.d.ts" />
+
+import yargs = require('yargs');
+
+// Examples taken from yargs website
+// https://github.com/chevex/yargs
+
+// With yargs, the options be just a hash!
+function xup() {
+	var argv = yargs.argv;
+
+	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._);
+}
+
+// Yargs even counts your booleans!
+function count() {
+	var argv = yargs
+		.count('verbose')
+		.alias('v', 'verbose')
+		.argv;
+
+	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); }
+}
+
+// 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;
+
+	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)
+		.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);
+}
+function default_hash() {
+	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._);
+}
+function boolean_double() {
+	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
+	;
+}
+
+// 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);
+}
+
+function Argv$options() {
+	var argv1 = yargs
+		.options('f', {
+			alias: 'file',
+			default: '/etc/passwd',
+		})
+		.argv
+	;
+
+	var argv2 = yargs
+		.alias('f', 'file')
+		.default('f', '/etc/passwd')
+		.argv
+	;
+}
+
+function Argv$help() {
+	var yargs1 = yargs
+		.usage("$0 -operand1 number -operand2 number -operation [add|subtract]");
+	var s: string = yargs1.help();
+}
+
+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;
+}
+
+function Argv$showHelp() {
+	var yargs1 = yargs
+		.usage("$0 -operand1 number -operand2 number -operation [add|subtract]");
+	yargs1.showHelp();
+}