diff options
Diffstat (limited to 'flags/tests')
| -rwxr-xr-x | flags/tests/all_bool.ts | 32 | ||||
| -rwxr-xr-x | flags/tests/bool.ts | 158 | ||||
| -rwxr-xr-x | flags/tests/dash.ts | 28 | ||||
| -rwxr-xr-x | flags/tests/default_bool.ts | 32 | ||||
| -rwxr-xr-x | flags/tests/dotted.ts | 19 | ||||
| -rwxr-xr-x | flags/tests/kv_short.ts | 12 | ||||
| -rwxr-xr-x | flags/tests/long.ts | 25 | ||||
| -rwxr-xr-x | flags/tests/num.ts | 34 | ||||
| -rw-r--r-- | flags/tests/parse.ts | 182 | ||||
| -rwxr-xr-x | flags/tests/short.ts | 57 | ||||
| -rwxr-xr-x | flags/tests/stop_early.ts | 14 | ||||
| -rwxr-xr-x | flags/tests/unknown.ts | 96 | ||||
| -rwxr-xr-x | flags/tests/whitespace.ts | 6 |
13 files changed, 695 insertions, 0 deletions
diff --git a/flags/tests/all_bool.ts b/flags/tests/all_bool.ts new file mode 100755 index 000000000..de696dda6 --- /dev/null +++ b/flags/tests/all_bool.ts @@ -0,0 +1,32 @@ +import { test, assertEqual } from "https://deno.land/x/testing/testing.ts"; +import parseArgs from "../index.ts"; + +// flag boolean true (default all --args to boolean) +test(function flagBooleanTrue() { + const argv = parseArgs(['moo', '--honk', 'cow'], { + boolean: true + }); + + assertEqual(argv, { + honk: true, + _: ['moo', 'cow'] + }); + + assertEqual(typeof argv.honk, 'boolean'); +}); + +// flag boolean true only affects double hyphen arguments without equals signs +test(function flagBooleanTrueOnlyAffectsDoubleDash() { + var argv = parseArgs(['moo', '--honk', 'cow', '-p', '55', '--tacos=good'], { + boolean: true + }); + + assertEqual(argv, { + honk: true, + tacos: 'good', + p: 55, + _: ['moo', 'cow'] + }); + + assertEqual(typeof argv.honk, 'boolean'); +}); diff --git a/flags/tests/bool.ts b/flags/tests/bool.ts new file mode 100755 index 000000000..b2b96dfed --- /dev/null +++ b/flags/tests/bool.ts @@ -0,0 +1,158 @@ +import { test, assertEqual } from "https://deno.land/x/testing/testing.ts"; +import parseArgs from "../index.ts"; + +test(function flagBooleanDefaultFalse() { + const argv = parseArgs(['moo'], { + boolean: ['t', 'verbose'], + default: { verbose: false, t: false } + }); + + assertEqual(argv, { + verbose: false, + t: false, + _: ['moo'] + }); + + assertEqual(typeof argv.verbose, 'boolean'); + assertEqual(typeof argv.t, 'boolean'); +}); + +test(function booleanGroups() { + const argv = parseArgs([ '-x', '-z', 'one', 'two', 'three' ], { + boolean: ['x','y','z'] + }); + + assertEqual(argv, { + x : true, + y : false, + z : true, + _ : [ 'one', 'two', 'three' ] + }); + + assertEqual(typeof argv.x, 'boolean'); + assertEqual(typeof argv.y, 'boolean'); + assertEqual(typeof argv.z, 'boolean'); +}); + +test(function booleanAndAliasWithChainableApi() { + const aliased = [ '-h', 'derp' ]; + const regular = [ '--herp', 'derp' ]; + const opts = { + herp: { alias: 'h', boolean: true } + }; + const aliasedArgv = parseArgs(aliased, { + boolean: 'herp', + alias: { h: 'herp' } + }); + const propertyArgv = parseArgs(regular, { + boolean: 'herp', + alias: { h: 'herp' } + }); + const expected = { + herp: true, + h: true, + '_': [ 'derp' ] + }; + + assertEqual(aliasedArgv, expected); + assertEqual(propertyArgv, expected); +}); + +test(function booleanAndAliasWithOptionsHash() { + const aliased = [ '-h', 'derp' ]; + const regular = [ '--herp', 'derp' ]; + const opts = { + alias: { 'h': 'herp' }, + boolean: 'herp' + }; + const aliasedArgv = parseArgs(aliased, opts); + const propertyArgv = parseArgs(regular, opts); + const expected = { + herp: true, + h: true, + '_': [ 'derp' ] + }; + assertEqual(aliasedArgv, expected); + assertEqual(propertyArgv, expected); +}); + +test(function booleanAndAliasArrayWithOptionsHash() { + const aliased = [ '-h', 'derp' ]; + const regular = [ '--herp', 'derp' ]; + const alt = [ '--harp', 'derp' ]; + const opts = { + alias: { 'h': ['herp', 'harp'] }, + boolean: 'h' + }; + const aliasedArgv = parseArgs(aliased, opts); + const propertyArgv = parseArgs(regular, opts); + const altPropertyArgv = parseArgs(alt, opts); + const expected = { + harp: true, + herp: true, + h: true, + '_': [ 'derp' ] + }; + assertEqual(aliasedArgv, expected); + assertEqual(propertyArgv, expected); + assertEqual(altPropertyArgv, expected); +}); + +test(function booleanAndAliasUsingExplicitTrue() { + const aliased = [ '-h', 'true' ]; + const regular = [ '--herp', 'true' ]; + const opts = { + alias: { h: 'herp' }, + boolean: 'h' + }; + const aliasedArgv = parseArgs(aliased, opts); + const propertyArgv = parseArgs(regular, opts); + const expected = { + herp: true, + h: true, + '_': [ ] + }; + + assertEqual(aliasedArgv, expected); + assertEqual(propertyArgv, expected); +}); + +// regression, see https://github.com/substack/node-optimist/issues/71 +// boolean and --x=true +test(function booleanAndNonBoolean() { + const parsed = parseArgs(['--boool', '--other=true'], { + boolean: 'boool' + }); + + assertEqual(parsed.boool, true); + assertEqual(parsed.other, 'true'); + + const parsed2 = parseArgs(['--boool', '--other=false'], { + boolean: 'boool' + }); + + assertEqual(parsed2.boool, true); + assertEqual(parsed2.other, 'false'); +}); + +test(function booleanParsingTrue() { + const parsed = parseArgs(['--boool=true'], { + default: { + boool: false + }, + boolean: ['boool'] + }); + + assertEqual(parsed.boool, true); +}); + +test(function booleanParsingFalse() { + const parsed = parseArgs(['--boool=false'], { + default: { + boool: true + }, + boolean: ['boool'] + }); + + assertEqual(parsed.boool, false); +}); diff --git a/flags/tests/dash.ts b/flags/tests/dash.ts new file mode 100755 index 000000000..87b3ab480 --- /dev/null +++ b/flags/tests/dash.ts @@ -0,0 +1,28 @@ +import { test, assertEqual } from "https://deno.land/x/testing/testing.ts"; +import parseArgs from "../index.ts"; + +test(function hyphen() { + assertEqual(parseArgs([ '-n', '-' ]), { n: '-', _: [] }); + assertEqual(parseArgs([ '-' ]), { _: [ '-' ] }); + assertEqual(parseArgs([ '-f-' ]), { f: '-', _: [] }); + assertEqual( + parseArgs([ '-b', '-' ], { boolean: 'b' }), + { b: true, _: [ '-' ] } + ); + assertEqual( + parseArgs([ '-s', '-' ], { string: 's' }), + { s: '-', _: [] } + ); +}); + +test(function doubleDash() { + assertEqual(parseArgs([ '-a', '--', 'b' ]), { a: true, _: [ 'b' ] }); + assertEqual(parseArgs([ '--a', '--', 'b' ]), { a: true, _: [ 'b' ] }); + assertEqual(parseArgs([ '--a', '--', 'b' ]), { a: true, _: [ 'b' ] }); +}); + +test(function moveArgsAfterDoubleDashIntoOwnArray() { + assertEqual( + parseArgs([ '--name', 'John', 'before', '--', 'after' ], { '--': true }), + { name: 'John', _: [ 'before' ], '--': [ 'after' ] }); +}); diff --git a/flags/tests/default_bool.ts b/flags/tests/default_bool.ts new file mode 100755 index 000000000..92684ad7b --- /dev/null +++ b/flags/tests/default_bool.ts @@ -0,0 +1,32 @@ +import { test, assertEqual } from "https://deno.land/x/testing/testing.ts"; +import parseArgs from "../index.ts"; + +test(function booleanDefaultTrue() { + const argv = parseArgs([], { + boolean: 'sometrue', + default: { sometrue: true } + }); + assertEqual(argv.sometrue, true); +}); + +test(function booleanDefaultFalse() { + const argv = parseArgs([], { + boolean: 'somefalse', + default: { somefalse: false } + }); + assertEqual(argv.somefalse, false); +}); + +test(function booleanDefaultNull() { + const argv = parseArgs([], { + boolean: 'maybe', + default: { maybe: null } + }); + assertEqual(argv.maybe, null); + const argv2 = parseArgs(['--maybe'], { + boolean: 'maybe', + default: { maybe: null } + }); + assertEqual(argv2.maybe, true); + +}) diff --git a/flags/tests/dotted.ts b/flags/tests/dotted.ts new file mode 100755 index 000000000..aea03dd7c --- /dev/null +++ b/flags/tests/dotted.ts @@ -0,0 +1,19 @@ +import { test, assertEqual } from "https://deno.land/x/testing/testing.ts"; +import parseArgs from "../index.ts"; + +test(function dottedAlias() { + const argv = parseArgs(['--a.b', '22'], {default: {'a.b': 11}, alias: {'a.b': 'aa.bb'}}); + assertEqual(argv.a.b, 22); + assertEqual(argv.aa.bb, 22); +}); + +test(function dottedDefault() { + const argv = parseArgs('', {default: {'a.b': 11}, alias: {'a.b': 'aa.bb'}}); + assertEqual(argv.a.b, 11); + assertEqual(argv.aa.bb, 11); +}); + +test(function dottedDefaultWithNoAlias() { + const argv = parseArgs('', {default: {'a.b': 11}}); + assertEqual(argv.a.b, 11); +}); diff --git a/flags/tests/kv_short.ts b/flags/tests/kv_short.ts new file mode 100755 index 000000000..10b4154e0 --- /dev/null +++ b/flags/tests/kv_short.ts @@ -0,0 +1,12 @@ +import { test, assertEqual } from "https://deno.land/x/testing/testing.ts"; +import parseArgs from "../index.ts"; + +test(function short() { + const argv = parseArgs([ '-b=123' ]); + assertEqual(argv, { b: 123, _: [] }); +}); + +test(function multiShort() { + const argv = parseArgs([ '-a=whatever', '-b=robots' ]); + assertEqual(argv, { a: 'whatever', b: 'robots', _: [] }); +}); diff --git a/flags/tests/long.ts b/flags/tests/long.ts new file mode 100755 index 000000000..876e6af2b --- /dev/null +++ b/flags/tests/long.ts @@ -0,0 +1,25 @@ +import { test, assertEqual } from "https://deno.land/x/testing/testing.ts"; +import parseArgs from "../index.ts"; + +test(function longOpts() { + assertEqual( + parseArgs([ '--bool' ]), + { bool : true, _ : [] }, + ); + assertEqual( + parseArgs([ '--pow', 'xixxle' ]), + { pow : 'xixxle', _ : [] }, + ); + assertEqual( + parseArgs([ '--pow=xixxle' ]), + { pow : 'xixxle', _ : [] }, + ); + assertEqual( + parseArgs([ '--host', 'localhost', '--port', '555' ]), + { host : 'localhost', port : 555, _ : [] }, + ); + assertEqual( + parseArgs([ '--host=localhost', '--port=555' ]), + { host : 'localhost', port : 555, _ : [] }, + ); +}); diff --git a/flags/tests/num.ts b/flags/tests/num.ts new file mode 100755 index 000000000..85efa76a6 --- /dev/null +++ b/flags/tests/num.ts @@ -0,0 +1,34 @@ +import { test, assertEqual } from "https://deno.land/x/testing/testing.ts"; +import parseArgs from "../index.ts"; + +test(function nums() { + const argv = parseArgs([ + '-x', '1234', + '-y', '5.67', + '-z', '1e7', + '-w', '10f', + '--hex', '0xdeadbeef', + '789' + ]); + assertEqual(argv, { + x : 1234, + y : 5.67, + z : 1e7, + w : '10f', + hex : 0xdeadbeef, + _ : [ 789 ] + }); + assertEqual(typeof argv.x, 'number'); + assertEqual(typeof argv.y, 'number'); + assertEqual(typeof argv.z, 'number'); + assertEqual(typeof argv.w, 'string'); + assertEqual(typeof argv.hex, 'number'); + assertEqual(typeof argv._[0], 'number'); +}); + +test(function alreadyNumber() { + const argv = parseArgs([ '-x', 1234, 789 ]); + assertEqual(argv, { x : 1234, _ : [ 789 ] }); + assertEqual(typeof argv.x, 'number'); + assertEqual(typeof argv._[0], 'number'); +}); diff --git a/flags/tests/parse.ts b/flags/tests/parse.ts new file mode 100644 index 000000000..3e85f58ef --- /dev/null +++ b/flags/tests/parse.ts @@ -0,0 +1,182 @@ +import { test, assertEqual } from "https://deno.land/x/testing/testing.ts"; +import parseArgs from "../index.ts"; + + +test(function _arseArgs() { + assertEqual( + parseArgs([ '--no-moo' ]), + { moo : false, _ : [] }, + ); + assertEqual( + parseArgs([ '-v', 'a', '-v', 'b', '-v', 'c' ]), + { v : ['a','b','c'], _ : [] }, + ); +}); + +test(function comprehensive() { + assertEqual( + parseArgs([ + '--name=meowmers', 'bare', '-cats', 'woo', + '-h', 'awesome', '--multi=quux', + '--key', 'value', + '-b', '--bool', '--no-meep', '--multi=baz', + '--', '--not-a-flag', 'eek' + ]), + { + c : true, + a : true, + t : true, + s : 'woo', + h : 'awesome', + b : true, + bool : true, + key : 'value', + multi : [ 'quux', 'baz' ], + meep : false, + name : 'meowmers', + _ : [ 'bare', '--not-a-flag', 'eek' ] + } + ); +}); + +test(function flagBoolean() { + const argv = parseArgs([ '-t', 'moo' ], { boolean: 't' }); + assertEqual(argv, { t : true, _ : [ 'moo' ] }); + assertEqual(typeof argv.t, 'boolean'); +}); + +test(function flagBooleanValue() { + const argv = parseArgs(['--verbose', 'false', 'moo', '-t', 'true'], { + boolean: [ 't', 'verbose' ], + default: { verbose: true } + }); + + assertEqual(argv, { + verbose: false, + t: true, + _: ['moo'] + }); + + assertEqual(typeof argv.verbose, 'boolean'); + assertEqual(typeof argv.t, 'boolean'); +}); + +test(function newlinesInParams() { + const args = parseArgs([ '-s', "X\nX" ]) + assertEqual(args, { _ : [], s : "X\nX" }); + + // reproduce in bash: + // VALUE="new + // line" + // deno program.js --s="$VALUE" + const args2 = parseArgs([ "--s=X\nX" ]) + assertEqual(args2, { _ : [], s : "X\nX" }); +}); + +test(function strings() { + const s = parseArgs([ '-s', '0001234' ], { string: 's' }).s; + assertEqual(s, '0001234'); + assertEqual(typeof s, 'string'); + + const x = parseArgs([ '-x', '56' ], { string: 'x' }).x; + assertEqual(x, '56'); + assertEqual(typeof x, 'string'); +}); + +test(function stringArgs() { + const s = parseArgs([ ' ', ' ' ], { string: '_' })._; + assertEqual(s.length, 2); + assertEqual(typeof s[0], 'string'); + assertEqual(s[0], ' '); + assertEqual(typeof s[1], 'string'); + assertEqual(s[1], ' '); +}); + +test(function emptyStrings() { + const s = parseArgs([ '-s' ], { string: 's' }).s; + assertEqual(s, ''); + assertEqual(typeof s, 'string'); + + const str = parseArgs([ '--str' ], { string: 'str' }).str; + assertEqual(str, ''); + assertEqual(typeof str, 'string'); + + const letters = parseArgs([ '-art' ], { + string: [ 'a', 't' ] + }); + + assertEqual(letters.a, ''); + assertEqual(letters.r, true); + assertEqual(letters.t, ''); +}); + + +test(function stringAndAlias() { + const x = parseArgs([ '--str', '000123' ], { + string: 's', + alias: { s: 'str' } + }); + + assertEqual(x.str, '000123'); + assertEqual(typeof x.str, 'string'); + assertEqual(x.s, '000123'); + assertEqual(typeof x.s, 'string'); + + const y = parseArgs([ '-s', '000123' ], { + string: 'str', + alias: { str: 's' } + }); + + assertEqual(y.str, '000123'); + assertEqual(typeof y.str, 'string'); + assertEqual(y.s, '000123'); + assertEqual(typeof y.s, 'string'); +}); + +test(function slashBreak() { + assertEqual( + parseArgs([ '-I/foo/bar/baz' ]), + { I : '/foo/bar/baz', _ : [] } + ); + assertEqual( + parseArgs([ '-xyz/foo/bar/baz' ]), + { x : true, y : true, z : '/foo/bar/baz', _ : [] } + ); +}); + +test(function alias() { + const argv = parseArgs([ '-f', '11', '--zoom', '55' ], { + alias: { z: 'zoom' } + }); + assertEqual(argv.zoom, 55); + assertEqual(argv.z, argv.zoom); + assertEqual(argv.f, 11); +}); + +test(function multiAlias() { + const argv = parseArgs([ '-f', '11', '--zoom', '55' ], { + alias: { z: [ 'zm', 'zoom' ] } + }); + assertEqual(argv.zoom, 55); + assertEqual(argv.z, argv.zoom); + assertEqual(argv.z, argv.zm); + assertEqual(argv.f, 11); +}); + +test(function nestedDottedObjects() { + const argv = parseArgs([ + '--foo.bar', '3', '--foo.baz', '4', + '--foo.quux.quibble', '5', '--foo.quux.o_O', + '--beep.boop' + ]); + + assertEqual(argv.foo, { + bar : 3, + baz : 4, + quux : { + quibble : 5, + o_O : true + } + }); + assertEqual(argv.beep, { boop : true }); +});
\ No newline at end of file diff --git a/flags/tests/short.ts b/flags/tests/short.ts new file mode 100755 index 000000000..2253ac13d --- /dev/null +++ b/flags/tests/short.ts @@ -0,0 +1,57 @@ +import { test, assertEqual } from "https://deno.land/x/testing/testing.ts"; +import parseArgs from "../index.ts"; + +test(function numbericShortArgs() { + assertEqual(parseArgs([ '-n123' ]), { n: 123, _: [] }); + assertEqual( + parseArgs([ '-123', '456' ]), + { 1: true, 2: true, 3: 456, _: [] } + ); +}); + +test(function short() { + assertEqual( + parseArgs([ '-b' ]), + { b : true, _ : [] }, + ); + assertEqual( + parseArgs([ 'foo', 'bar', 'baz' ]), + { _ : [ 'foo', 'bar', 'baz' ] }, + ); + assertEqual( + parseArgs([ '-cats' ]), + { c : true, a : true, t : true, s : true, _ : [] }, + ); + assertEqual( + parseArgs([ '-cats', 'meow' ]), + { c : true, a : true, t : true, s : 'meow', _ : [] }, + ); + assertEqual( + parseArgs([ '-h', 'localhost' ]), + { h : 'localhost', _ : [] }, + ); + assertEqual( + parseArgs([ '-h', 'localhost', '-p', '555' ]), + { h : 'localhost', p : 555, _ : [] }, + ); +}); + +test(function mixedShortBoolAndCapture() { + assertEqual( + parseArgs([ '-h', 'localhost', '-fp', '555', 'script.js' ]), + { + f : true, p : 555, h : 'localhost', + _ : [ 'script.js' ] + } + ); +}); + +test(function shortAndLong() { + assertEqual( + parseArgs([ '-h', 'localhost', '-fp', '555', 'script.js' ]), + { + f : true, p : 555, h : 'localhost', + _ : [ 'script.js' ] + } + ); +}); diff --git a/flags/tests/stop_early.ts b/flags/tests/stop_early.ts new file mode 100755 index 000000000..2a62008b7 --- /dev/null +++ b/flags/tests/stop_early.ts @@ -0,0 +1,14 @@ +import { test, assertEqual } from "https://deno.land/x/testing/testing.ts"; +import parseArgs from "../index.ts"; + +// stops parsing on the first non-option when stopEarly is set +test(function stopParsing() { + const argv = parseArgs(['--aaa', 'bbb', 'ccc', '--ddd'], { + stopEarly: true + }); + + assertEqual(argv, { + aaa: 'bbb', + _: ['ccc', '--ddd'] + }); +}); diff --git a/flags/tests/unknown.ts b/flags/tests/unknown.ts new file mode 100755 index 000000000..d7c9db8d7 --- /dev/null +++ b/flags/tests/unknown.ts @@ -0,0 +1,96 @@ +import { test, assertEqual } from "https://deno.land/x/testing/testing.ts"; +import parseArgs from "../index.ts"; + +test(function booleanAndAliasIsNotUnknown() { + const unknown = []; + function unknownFn(arg) { + unknown.push(arg); + return false; + } + const aliased = [ '-h', 'true', '--derp', 'true' ]; + const regular = [ '--herp', 'true', '-d', 'true' ]; + const opts = { + alias: { h: 'herp' }, + boolean: 'h', + unknown: unknownFn + }; + const aliasedArgv = parseArgs(aliased, opts); + const propertyArgv = parseArgs(regular, opts); + + assertEqual(unknown, ['--derp', '-d']); +}); + +test(function flagBooleanTrueAnyDoubleHyphenArgumentIsNotUnknown() { + const unknown = []; + function unknownFn(arg) { + unknown.push(arg); + return false; + } + const argv = parseArgs(['--honk', '--tacos=good', 'cow', '-p', '55'], { + boolean: true, + unknown: unknownFn + }); + assertEqual(unknown, ['--tacos=good', 'cow', '-p']); + assertEqual(argv, { + honk: true, + _: [] + }); +}); + +test(function stringAndAliasIsNotUnkown() { + const unknown = []; + function unknownFn(arg) { + unknown.push(arg); + return false; + } + const aliased = [ '-h', 'hello', '--derp', 'goodbye' ]; + const regular = [ '--herp', 'hello', '-d', 'moon' ]; + const opts = { + alias: { h: 'herp' }, + string: 'h', + unknown: unknownFn + }; + const aliasedArgv = parseArgs(aliased, opts); + const propertyArgv = parseArgs(regular, opts); + + assertEqual(unknown, ['--derp', '-d']); +}); + +test(function defaultAndAliasIsNotUnknown() { + const unknown = []; + function unknownFn(arg) { + unknown.push(arg); + return false; + } + const aliased = [ '-h', 'hello' ]; + const regular = [ '--herp', 'hello' ]; + const opts = { + default: { 'h': 'bar' }, + alias: { 'h': 'herp' }, + unknown: unknownFn + }; + const aliasedArgv = parseArgs(aliased, opts); + const propertyArgv = parseArgs(regular, opts); + + assertEqual(unknown, []); +}); + +test(function valueFollowingDoubleHyphenIsNotUnknown() { + const unknown = []; + function unknownFn(arg) { + unknown.push(arg); + return false; + } + const aliased = [ '--bad', '--', 'good', 'arg' ]; + const opts = { + '--': true, + unknown: unknownFn + }; + const argv = parseArgs(aliased, opts); + + assertEqual(unknown, ['--bad']); + assertEqual(argv, { + '--': ['good', 'arg'], + '_': [] + }) +}); diff --git a/flags/tests/whitespace.ts b/flags/tests/whitespace.ts new file mode 100755 index 000000000..1af0e77d2 --- /dev/null +++ b/flags/tests/whitespace.ts @@ -0,0 +1,6 @@ +import { test, assertEqual } from "https://deno.land/x/testing/testing.ts"; +import parseArgs from "../index.ts"; + +test(function whitespaceShouldBeWhitespace() { + assertEqual(parseArgs([ '-x', '\t' ]).x, '\t'); +}); |
