deno.land / std@0.224.0 / cli / parse_args_test.ts
parse_args_test.ts
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.import { assertEquals } from "../assert/mod.ts";import { type Args, parseArgs, type ParseOptions } from "./parse_args.ts";import { assertType, type IsExact } from "../testing/types.ts";
// flag boolean true (default all --args to boolean)Deno.test("parseArgs() handles true boolean flag", function () { const argv = parseArgs(["moo", "--honk", "cow"], { boolean: true, });
assertEquals(argv, { honk: true, _: ["moo", "cow"], });
assertEquals(typeof argv.honk, "boolean");});
// flag boolean true only affects double hyphen arguments without equals signsDeno.test("parseArgs() handles boolean true flag if double dashed", function () { const argv = parseArgs(["moo", "--honk", "cow", "-p", "55", "--tacos=good"], { boolean: true, });
assertEquals(argv, { honk: true, tacos: "good", p: 55, _: ["moo", "cow"], });
assertEquals(typeof argv.honk, "boolean");});
Deno.test("parseArgs() handles boolean flag default value", function () { const argv = parseArgs(["moo"], { boolean: ["t", "verbose"], default: { verbose: false, t: false }, });
assertEquals(argv, { verbose: false, t: false, _: ["moo"], });
assertEquals(typeof argv.verbose, "boolean"); assertEquals(typeof argv.t, "boolean");});
Deno.test("parseArgs() handles boolean group", function () { const argv = parseArgs(["-x", "-z", "one", "two", "three"], { boolean: ["x", "y", "z"], });
assertEquals(argv, { x: true, y: false, z: true, _: ["one", "two", "three"], });
assertEquals(typeof argv.x, "boolean"); assertEquals(typeof argv.y, "boolean"); assertEquals(typeof argv.z, "boolean");});
Deno.test("parseArgs() handles boolean and alias default values", function (): void { const argv = parseArgs([], { string: ["foo"], boolean: ["bar"], alias: { bar: "b", }, });
assertEquals(argv, { bar: false, b: false, _: [], });});
Deno.test("parseArgs() handles boolean and alias with chainable api", function () { const aliased = ["-h", "derp"]; const regular = ["--herp", "derp"]; 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"], };
assertEquals(aliasedArgv, expected); assertEquals(propertyArgv, expected);});
Deno.test("parseArgs() handles boolean and alias with options hash", function () { const aliased = ["-h", "derp"]; const regular = ["--herp", "derp"]; const opts = { alias: { h: "herp" }, boolean: "herp", } as const; const aliasedArgv = parseArgs(aliased, opts); const propertyArgv = parseArgs(regular, opts); const expected = { herp: true, h: true, _: ["derp"], }; assertEquals(aliasedArgv, expected); assertEquals(propertyArgv, expected);});
Deno.test("parseArgs() handles boolean and alias array with options hash", function () { const aliased = ["-h", "derp"]; const regular = ["--herp", "derp"]; const alt = ["--harp", "derp"]; const opts = { alias: { h: ["herp", "harp"] }, boolean: "h", } as const; const aliasedArgv = parseArgs(aliased, opts); const propertyArgv = parseArgs(regular, opts); const altPropertyArgv = parseArgs(alt, opts); const expected = { harp: true, herp: true, h: true, _: ["derp"], }; assertEquals(aliasedArgv, expected); assertEquals(propertyArgv, expected); assertEquals(altPropertyArgv, expected);});
Deno.test("parseArgs() handles boolean and alias using explicit true", function () { const aliased = ["-h", "true"]; const regular = ["--herp", "true"]; const opts = { alias: { h: "herp" }, boolean: "h", } as const; const aliasedArgv = parseArgs(aliased, opts); const propertyArgv = parseArgs(regular, opts); const expected = { herp: true, h: true, _: [], };
assertEquals(aliasedArgv, expected); assertEquals(propertyArgv, expected);});
// regression, see https://github.com/substack/node-optimist/issues/71// boolean and --x=trueDeno.test("parseArgs() handles boolean and non-boolean", function () { const parsed = parseArgs(["--boool", "--other=true"], { boolean: "boool", });
assertEquals(parsed.boool, true); assertEquals(parsed.other, "true");
const parsed2 = parseArgs(["--boool", "--other=false"], { boolean: "boool", });
assertEquals(parsed2.boool, true); assertEquals(parsed2.other, "false");});
Deno.test("parseArgs() handles boolean true parsing", function () { const parsed = parseArgs(["--boool=true"], { default: { boool: false, }, boolean: ["boool"], });
assertEquals(parsed.boool, true);});
Deno.test("parseArgs() handles boolean false parsing", function () { const parsed = parseArgs(["--boool=false"], { default: { boool: true, }, boolean: ["boool"], });
assertEquals(parsed.boool, false);});
Deno.test("parseArgs() handles boolean true-like parsing", function () { const parsed = parseArgs(["-t", "true123"], { boolean: ["t"] }); assertEquals(parsed.t, true);
const parsed2 = parseArgs(["-t", "123"], { boolean: ["t"] }); assertEquals(parsed2.t, true);
const parsed3 = parseArgs(["-t", "false123"], { boolean: ["t"] }); assertEquals(parsed3.t, true);});
Deno.test("parseArgs() handles boolean after boolean negation", function () { const parsed = parseArgs(["--foo", "--no-foo"], { boolean: ["foo"], negatable: ["foo"], }); assertEquals(parsed.foo, false);
const parsed2 = parseArgs(["--foo", "--no-foo", "123"], { boolean: ["foo"], negatable: ["foo"], }); assertEquals(parsed2.foo, false);});
Deno.test("parseArgs() handles boolean after boolean negation", function () { const parsed = parseArgs(["--no-foo", "--foo"], { boolean: ["foo"], negatable: ["foo"], }); assertEquals(parsed.foo, true);
const parsed2 = parseArgs(["--no-foo", "--foo", "123"], { boolean: ["foo"], negatable: ["foo"], }); assertEquals(parsed2.foo, true);});
Deno.test("parseArgs() handles latest flag boolean negation", function () { const parsed = parseArgs(["--no-foo", "--foo", "--no-foo"], { boolean: ["foo"], negatable: ["foo"], }); assertEquals(parsed.foo, false);
const parsed2 = parseArgs(["--no-foo", "--foo", "--no-foo", "123"], { boolean: ["foo"], negatable: ["foo"], }); assertEquals(parsed2.foo, false);});
Deno.test("parseArgs() handles latest flag boolean", function () { const parsed = parseArgs(["--foo", "--no-foo", "--foo"], { boolean: ["foo"], negatable: ["foo"], }); assertEquals(parsed.foo, true);
const parsed2 = parseArgs(["--foo", "--no-foo", "--foo", "123"], { boolean: ["foo"], negatable: ["foo"], }); assertEquals(parsed2.foo, true);});
Deno.test("parseArgs() handles hyphen", function () { assertEquals(parseArgs(["-n", "-"]), { n: "-", _: [] }); assertEquals(parseArgs(["-"]), { _: ["-"] }); assertEquals(parseArgs(["-f-"]), { f: "-", _: [] }); assertEquals(parseArgs(["-b", "-"], { boolean: "b" }), { b: true, _: ["-"] }); assertEquals(parseArgs(["-s", "-"], { string: "s" }), { s: "-", _: [] });});
Deno.test("parseArgs() handles double dash", function () { assertEquals(parseArgs(["-a", "--", "b"]), { a: true, _: ["b"] }); assertEquals(parseArgs(["--a", "--", "b"]), { a: true, _: ["b"] }); assertEquals(parseArgs(["--a", "--", "b"]), { a: true, _: ["b"] });});
Deno.test("parseArgs() moves args after double dash into own array", function () { assertEquals( parseArgs(["--name", "John", "before", "--", "after"], { "--": true }), { name: "John", _: ["before"], "--": ["after"], }, );});
Deno.test("parseArgs() handles default true boolean value", function () { const argv = parseArgs([], { boolean: "sometrue", default: { sometrue: true }, }); assertEquals(argv.sometrue, true);});
Deno.test("parseArgs() handles default true boolean value", function () { const argv = parseArgs([], { boolean: "somefalse", default: { somefalse: false }, }); assertEquals(argv.somefalse, false);});
Deno.test("parseArgs() handles default null boolean value", function () { const argv = parseArgs([], { boolean: "maybe", default: { maybe: null }, }); assertEquals(argv.maybe, null); const argv2 = parseArgs(["--maybe"], { boolean: "maybe", default: { maybe: null }, }); assertEquals(argv2.maybe, true);});
Deno.test("parseArgs() handles dotted alias", function () { const argv = parseArgs(["--a.b", "22"], { default: { "a.b": 11 }, alias: { "a.b": "aa.bb" }, }); assertEquals(argv.a.b, 22); assertEquals(argv.aa.bb, 22);});
Deno.test("parseArgs() handles dotted default value", function () { const argv = parseArgs([], { default: { "a.b": 11 }, alias: { "a.b": "aa.bb" }, }); assertEquals(argv.a.b, 11); assertEquals(argv.aa.bb, 11);});
Deno.test("parseArgs() handles dotted default with no alias", function () { const argv = parseArgs([], { default: { "a.b": 11 } }); assertEquals(argv.a.b, 11);});
Deno.test("parseArgs() handles short", function () { const argv = parseArgs(["-b=123"]); assertEquals(argv, { b: 123, _: [] });});
Deno.test("parseArgs() handles multi short", function () { const argv = parseArgs(["-a=whatever", "-b=robots"]); assertEquals(argv, { a: "whatever", b: "robots", _: [] });});
Deno.test("parseArgs() handles long opts", function () { assertEquals(parseArgs(["--bool"]), { bool: true, _: [] }); assertEquals(parseArgs(["--pow", "xixxle"]), { pow: "xixxle", _: [] }); assertEquals(parseArgs(["--pow=xixxle"]), { pow: "xixxle", _: [] }); assertEquals(parseArgs(["--host", "localhost", "--port", "555"]), { host: "localhost", port: 555, _: [], }); assertEquals(parseArgs(["--host=localhost", "--port=555"]), { host: "localhost", port: 555, _: [], });});
Deno.test("parseArgs() handles numbers", function () { const argv = parseArgs([ "-x", "1234", "-y", "5.67", "-z", "1e7", "-w", "10f", "--hex", "0xdeadbeef", "789", ]); assertEquals(argv, { x: 1234, y: 5.67, z: 1e7, w: "10f", hex: 0xdeadbeef, _: [789], }); assertEquals(typeof argv.x, "number"); assertEquals(typeof argv.y, "number"); assertEquals(typeof argv.z, "number"); assertEquals(typeof argv.w, "string"); assertEquals(typeof argv.hex, "number"); assertEquals(typeof argv._[0], "number");});
Deno.test("parseArgs() handles already number", function () { const argv = parseArgs(["-x", "1234", "789"]); assertEquals(argv, { x: 1234, _: [789] }); assertEquals(typeof argv.x, "number"); assertEquals(typeof argv._[0], "number");});
Deno.test("parseArgs() parses args", function () { assertEquals(parseArgs(["--no-moo"]), { "no-moo": true, _: [] }); assertEquals(parseArgs(["-v", "a", "-v", "b", "-v", "c"]), { v: "c", _: [], });});
Deno.test("parseArgs() handles comprehensive", function () { assertEquals( parseArgs([ "--name=meowmers", "bare", "-cats", "woo", "-h", "awesome", "--multi=quux", "--key", "value", "-b", "--bool", "--no-meep", "--multi=baz", "-f=abc=def", "--foo=---=\\n--+34-=/=", "-e==", "--", "--not-a-flag", "eek", ]), { c: true, a: true, t: true, e: "=", f: "abc=def", foo: "---=\\n--+34-=/=", s: "woo", h: "awesome", b: true, bool: true, key: "value", multi: "baz", "no-meep": true, name: "meowmers", _: ["bare", "--not-a-flag", "eek"], }, );});
Deno.test("parseArgs() handles flag boolean", function () { const argv = parseArgs(["-t", "moo"], { boolean: "t" }); assertEquals(argv, { t: true, _: ["moo"] }); assertEquals(typeof argv.t, "boolean");});
Deno.test("parseArgs() handles flag boolean value", function () { const argv = parseArgs(["--verbose", "false", "moo", "-t", "true"], { boolean: ["t", "verbose"], default: { verbose: true }, });
assertEquals(argv, { verbose: false, t: true, _: ["moo"], });
assertEquals(typeof argv.verbose, "boolean"); assertEquals(typeof argv.t, "boolean");});
Deno.test("parseArgs() handles newlines in params", function () { const args = parseArgs(["-s", "X\nX"]); assertEquals(args, { _: [], s: "X\nX" });
// reproduce in bash: // VALUE="new // line" // deno program.js --s="$VALUE" const args2 = parseArgs(["--s=X\nX"]); assertEquals(args2, { _: [], s: "X\nX" });});
Deno.test("parseArgs() handles strings", function () { const s = parseArgs(["-s", "0001234"], { string: "s" }).s; assertEquals(s, "0001234"); assertEquals(typeof s, "string");
const x = parseArgs(["-x", "56"], { string: "x" }).x; assertEquals(x, "56"); assertEquals(typeof x, "string");});
Deno.test("parseArgs() handles string args", function () { const s = parseArgs([" ", " "], { string: "_" })._; assertEquals(s.length, 2); assertEquals(typeof s[0], "string"); assertEquals(s[0], " "); assertEquals(typeof s[1], "string"); assertEquals(s[1], " ");});
Deno.test("parseArgs() handles empty strings", function () { const s = parseArgs(["-s"], { string: "s" }).s; assertEquals(s, ""); assertEquals(typeof s, "string");
const str = parseArgs(["--str"], { string: "str" }).str; assertEquals(str, ""); assertEquals(typeof str, "string");
const letters = parseArgs(["-art"], { string: ["a", "t"], });
assertEquals(letters.a, ""); assertEquals(letters.r, true); assertEquals(letters.t, "");});
Deno.test("parseArgs() handles string and alias", function () { const x = parseArgs(["--str", "000123"], { string: "s", alias: { s: "str" }, });
assertEquals(x.str, "000123"); assertEquals(typeof x.str, "string"); assertEquals(x.s, "000123"); assertEquals(typeof x.s, "string");
const y = parseArgs(["-s", "000123"], { string: "str", alias: { str: "s" }, });
assertEquals(y.str, "000123"); assertEquals(typeof y.str, "string"); assertEquals(y.s, "000123"); assertEquals(typeof y.s, "string");});
Deno.test("parseArgs() handles slash break", function () { assertEquals(parseArgs(["-I/foo/bar/baz"]), { I: "/foo/bar/baz", _: [] }); assertEquals(parseArgs(["-xyz/foo/bar/baz"]), { x: true, y: true, z: "/foo/bar/baz", _: [], });});
Deno.test("parseArgs() handles alias", function () { const argv = parseArgs(["-f", "11", "--zoom", "55"], { alias: { z: "zoom" }, }); assertEquals(argv.zoom, 55); assertEquals(argv.z, argv.zoom); assertEquals(argv.f, 11);});
Deno.test("parseArgs() handles multi alias", function () { const argv = parseArgs(["-f", "11", "--zoom", "55"], { alias: { z: ["zm", "zoom"] }, }); assertEquals(argv.zoom, 55); assertEquals(argv.z, argv.zoom); assertEquals(argv.z, argv.zm); assertEquals(argv.f, 11);});
Deno.test("parseArgs() handles nested dotted objects", function () { const argv = parseArgs([ "--foo.bar", "3", "--foo.baz", "4", "--foo.quux.quibble", "5", "--foo.quux.oO", "--beep.boop", ]);
assertEquals(argv.foo, { bar: 3, baz: 4, quux: { quibble: 5, oO: true, }, }); assertEquals(argv.beep, { boop: true });});
Deno.test("parseArgs() handles flag builtin property", function () { const argv = parseArgs(["--toString", "--valueOf", "foo"]); assertEquals(argv, { toString: true, valueOf: "foo", _: [] }); assertEquals(typeof argv.toString, "boolean"); assertEquals(typeof argv.valueOf, "string");});
Deno.test("parseArgs() handles numeric short args", function () { assertEquals(parseArgs(["-n123"]), { n: 123, _: [] }); assertEquals(parseArgs(["-123", "456"]), { 1: true, 2: true, 3: 456, _: [] });});
Deno.test("parseArgs() handles short", function () { assertEquals(parseArgs(["-b"]), { b: true, _: [] }); assertEquals(parseArgs(["foo", "bar", "baz"]), { _: ["foo", "bar", "baz"] }); assertEquals(parseArgs(["-cats"]), { c: true, a: true, t: true, s: true, _: [], }); assertEquals(parseArgs(["-cats", "meow"]), { c: true, a: true, t: true, s: "meow", _: [], }); assertEquals(parseArgs(["-h", "localhost"]), { h: "localhost", _: [] }); assertEquals(parseArgs(["-h", "localhost", "-p", "555"]), { h: "localhost", p: 555, _: [], });});
Deno.test("parseArgs() handles mixed short bool and capture", function () { assertEquals(parseArgs(["-h", "localhost", "-fp", "555", "script.js"]), { f: true, p: 555, h: "localhost", _: ["script.js"], });});
Deno.test("parseArgs() handles short and long", function () { assertEquals(parseArgs(["-h", "localhost", "-fp", "555", "script.js"]), { f: true, p: 555, h: "localhost", _: ["script.js"], });});
// stops parsing on the first non-option when stopEarly is setDeno.test("parseArgs() handles stopEarly option", function () { const argv = parseArgs(["--aaa", "bbb", "ccc", "--ddd"], { stopEarly: true, });
assertEquals(argv, { aaa: "bbb", _: ["ccc", "--ddd"], });});
Deno.test("parseArgs() handles boolean and alias that are not unknown", function () { const unknown: unknown[] = []; function unknownFn(arg: string, k?: string, v?: unknown): boolean { unknown.push({ arg, k, v }); return false; } const aliased = ["-h", "true", "--derp", "true"]; const regular = ["--herp", "true", "-d", "false"]; const opts = { alias: { h: "herp" }, boolean: "h", unknown: unknownFn, }; parseArgs(aliased, opts); parseArgs(regular, opts);
assertEquals(unknown, [ { arg: "--derp", k: "derp", v: "true" }, { arg: "-d", k: "d", v: "false" }, ]);});
Deno.test( "parseArgs() handles flag boolean true any double hyphen argument is not unknown", function () { const unknown: unknown[] = []; function unknownFn(arg: string, k?: string, v?: unknown): boolean { unknown.push({ arg, k, v }); return false; } const argv = parseArgs(["--honk", "--tacos=good", "cow", "-p", "55"], { boolean: true, unknown: unknownFn, }); assertEquals(unknown, [ { arg: "--tacos=good", k: "tacos", v: "good" }, { arg: "cow", k: undefined, v: undefined }, { arg: "-p", k: "p", v: "55" }, ]); assertEquals(argv, { honk: true, _: [], }); },);
Deno.test("parseArgs() handles string and alias is not unknown", function () { const unknown: unknown[] = []; function unknownFn(arg: string, k?: string, v?: unknown): boolean { unknown.push({ arg, k, v }); return false; } const aliased = ["-h", "hello", "--derp", "goodbye"]; const regular = ["--herp", "hello", "-d", "moon"]; const opts = { alias: { h: "herp" }, string: "h", unknown: unknownFn, }; parseArgs(aliased, opts); parseArgs(regular, opts);
assertEquals(unknown, [ { arg: "--derp", k: "derp", v: "goodbye" }, { arg: "-d", k: "d", v: "moon" }, ]);});
Deno.test("parseArgs() handles default and alias is not unknown", function () { const unknown: unknown[] = []; function unknownFn(arg: string, k?: string, v?: unknown): boolean { unknown.push({ arg, k, v }); return false; } const aliased = ["-h", "hello"]; const regular = ["--herp", "hello"]; const opts = { default: { h: "bar" }, alias: { h: "herp" }, unknown: unknownFn, }; parseArgs(aliased, opts); parseArgs(regular, opts);
assertEquals(unknown, []);});
Deno.test("parseArgs() handles value following double hyphen", function () { const unknown: unknown[] = []; function unknownFn(arg: string, k?: string, v?: unknown): boolean { unknown.push({ arg, k, v }); return false; } const aliased = ["--bad", "--", "good", "arg"]; const opts = { "--": true, unknown: unknownFn, }; const argv = parseArgs(aliased, opts);
assertEquals(unknown, [{ arg: "--bad", k: "bad", v: true }]); assertEquals(argv, { "--": ["good", "arg"], _: [], });});
Deno.test("parseArgs() handles whitespace", function () { assertEquals(parseArgs(["-x", "\t"]).x, "\t");});
Deno.test("parseArgs() handles collect args default behaviour", function () { const argv = parseArgs([ "--foo", "bar", "--foo", "baz", "--beep", "boop", "--bool", "--bool", ]);
assertEquals(argv, { foo: "baz", beep: "boop", bool: true, _: [], });});
Deno.test("parseArgs() handles collect args with default behaviour", function () { const argv = parseArgs([], { collect: ["foo"], default: { foo: ["bar", "baz"], }, });
assertEquals(argv, { foo: ["bar", "baz"], _: [], });});
Deno.test("parseArgs() handles collect unknown args", function () { const argv = parseArgs([ "--foo", "bar", "--foo", "baz", "--beep", "boop", "--bib", "--bib", "--bab", "--bab", ], { collect: ["beep", "bib"], });
assertEquals(argv, { foo: "baz", beep: ["boop"], bib: [true, true], bab: true, _: [], });});
Deno.test("parseArgs() handles collect args", function () { const argv = parseArgs([ "--bool", "--bool", "--boolArr", "--str", "foo", "--strArr", "beep", "--unknown", "--unknownArr", ], { boolean: ["bool", "boolArr"], string: ["str", "strArr"], collect: ["boolArr", "strArr", "unknownArr"], alias: { bool: "b", strArr: "S", boolArr: "B", }, });
assertEquals(argv, { bool: true, b: true, boolArr: [true], B: [true], str: "foo", strArr: ["beep"], S: ["beep"], unknown: true, unknownArr: [true], _: [], });});
Deno.test("parseArgs() handles collect negateable args", function () { const argv = parseArgs([ "--foo", "123", "-f", "456", "--no-foo", ], { string: ["foo"], collect: ["foo"], negatable: ["foo"], alias: { foo: "f", }, });
assertEquals(argv, { foo: false, f: false, _: [], });});
/** ---------------------- TYPE TESTS ---------------------- */
Deno.test("parseArgs() handles types of default options", function () { const argv = parseArgs([]); assertType< IsExact< typeof argv, // deno-lint-ignore no-explicit-any & { [x: string]: any } & { _: Array<string | number>; } > >(true);});
Deno.test("parseArgs() handles types of all boolean disabled", function () { const argv = parseArgs([], { boolean: false, }); assertType< IsExact< typeof argv, // deno-lint-ignore no-explicit-any & { [x: string]: any } & { _: Array<string | number>; } > >(true);});
Deno.test("parseArgs() handles types of all boolean disabled with defaults", function () { const argv = parseArgs([], { boolean: false, default: { bar: 123, }, }); assertType< IsExact< typeof argv, // deno-lint-ignore no-explicit-any & { [x: string]: any } & { _: Array<string | number>; } > >(true);});
Deno.test("parseArgs() handles types of all boolean disabled and string args", function () { const argv = parseArgs([], { boolean: false, string: ["foo"], }); assertType< IsExact< typeof argv, & { [x: string]: unknown } & { foo?: string | undefined; _: Array<string | number>; } > >(true);});
Deno.test("parseArgs() handles types of all boolean disabled and string args with defaults", function () { const argv = parseArgs([], { boolean: false, string: ["foo"], default: { foo: 123, bar: false, }, }); assertType< IsExact< typeof argv, & { [x: string]: unknown } & { foo: string | number; bar: unknown; _: Array<string | number>; } > >(true);});
Deno.test("parseArgs() handles types of all boolean", function () { const argv = parseArgs([], { boolean: true, }); assertType< IsExact< typeof argv, & { [x: string]: unknown } & { _: Array<string | number>; } > >(true);});
Deno.test("parseArgs() handles types of all boolean with defaults", function () { const argv = parseArgs([], { boolean: true, default: { foo: "123", bar: 123, }, }); assertType< IsExact< typeof argv, & { [x: string]: unknown } & { foo: unknown; bar: unknown; _: Array<string | number>; } > >(true);});
Deno.test("parseArgs() handles types of all boolean and string args", function () { const argv = parseArgs([], { boolean: true, string: ["foo", "bar", "foo-bar"], }); assertType< IsExact< typeof argv, & { [x: string]: unknown } & { foo?: string | undefined; bar?: string | undefined; "foo-bar"?: string | undefined; _: Array<string | number>; } > >(true);});
Deno.test("parseArgs() handles types of all boolean and string args with defaults", function () { const argv = parseArgs([], { boolean: true, string: ["foo", "bar", "foo-bar"], default: { bar: 123, baz: new Date(), }, }); assertType< IsExact< typeof argv, & { [x: string]: unknown } & { foo?: string | undefined; bar: string | number; baz: unknown; "foo-bar"?: string | undefined; _: Array<string | number>; } > >(true);});
Deno.test("parseArgs() handles types of boolean args", function () { const argv = parseArgs([], { boolean: ["foo", "bar", "foo-bar"], }); assertType< IsExact< typeof argv, & { [x: string]: unknown } & { foo: boolean; bar: boolean; "foo-bar": boolean; _: Array<string | number>; } > >(true);});
Deno.test("parseArgs() handles types of boolean args with defaults", function () { const argv = parseArgs([], { boolean: ["foo", "bar", "foo-bar"], default: { bar: 123, baz: "123", }, }); assertType< IsExact< typeof argv, & { [x: string]: unknown } & { foo: boolean; bar: number | boolean; baz: unknown; "foo-bar": boolean; _: Array<string | number>; } > >(true);});
Deno.test("parseArgs() handles types of string args", function () { const argv = parseArgs([], { string: ["foo", "bar", "foo-bar"], }); assertType< IsExact< typeof argv, & { [x: string]: unknown } & { foo?: string | undefined; bar?: string | undefined; "foo-bar"?: string | undefined; _: Array<string | number>; } > >(true);});
Deno.test("parseArgs() handles types of string args with defaults", function () { const argv = parseArgs([], { string: ["foo", "bar", "foo-bar"], default: { bar: true, baz: 123, }, }); assertType< IsExact< typeof argv, & { [x: string]: unknown } & { foo?: string | undefined; bar: string | boolean; baz: unknown; "foo-bar"?: string | undefined; _: Array<string | number>; } > >(true);});
Deno.test("parseArgs() handles types of boolean and string args", function () { const argv = parseArgs([], { boolean: ["foo", "bar", "foo-bar"], string: ["beep", "boop", "beep-boop"], }); assertType< IsExact< typeof argv, & { [x: string]: unknown } & { beep?: string | undefined; boop?: string | undefined; "beep-boop"?: string | undefined; foo: boolean; bar: boolean; "foo-bar": boolean; _: Array<string | number>; } > >(true);});
Deno.test("parseArgs() handles types of boolean and string args with defaults", function () { const argv = parseArgs([], { boolean: ["foo", "bar", "foo-bar"], string: ["beep", "boop", "beep-boop"], default: { bar: 123, baz: new Error(), beep: new Date(), }, }); assertType< IsExact< typeof argv, & { [x: string]: unknown } & { foo: boolean; boop?: string | undefined; "beep-boop"?: string | undefined; bar: number | boolean; baz: unknown; beep: string | Date; "foo-bar": boolean; _: Array<string | number>; } > >(true);});
/** ------------------------ DOTTED OPTIONS ------------------------ */
Deno.test("parseArgs() handles types of dotted boolean args", function () { const argv = parseArgs([], { boolean: ["blubb", "foo.bar", "foo.baz.biz", "foo.baz.buz"], }); assertType< IsExact< typeof argv, & { [x: string]: unknown } & { blubb: boolean; foo: { bar: boolean; baz: { biz: boolean; buz: boolean; }; }; _: Array<string | number>; } > >(true);});
Deno.test("parseArgs() handles types of dotted boolean args with defaults", function () { const argv = parseArgs([], { boolean: ["blubb", "foo.bar", "foo.baz.biz", "foo.baz.buz"], default: { blubb: "123", foo: { bar: 123, baz: { biz: new Date(), }, }, bla: new Date(), }, }); assertType< IsExact< typeof argv, & { [x: string]: unknown } & { blubb: boolean | string; foo: { bar: boolean | number; baz: { biz: boolean | Date; buz: boolean; }; }; bla: unknown; _: Array<string | number>; } > >(true);});
Deno.test("parseArgs() handles types of dotted string args", function () { const argv = parseArgs([], { string: ["blubb", "foo.bar", "foo.baz.biz", "foo.baz.buz"], }); assertType< IsExact< typeof argv, & { [x: string]: unknown } & { blubb?: string | undefined; foo?: { bar?: string | undefined; baz?: { biz?: string | undefined; buz?: string | undefined; }; }; _: Array<string | number>; } > >(true);});
Deno.test("parseArgs() handles types of dotted string args with defaults", function () { const argv = parseArgs([], { string: ["blubb", "foo.bar", "foo.baz.biz", "foo.baz.buz"], default: { blubb: true, foo: { bar: 123, baz: { biz: new Date(), }, }, bla: new Date(), }, }); assertType< IsExact< typeof argv, & { [x: string]: unknown } & { blubb: string | boolean; foo: { bar: string | number; baz: { biz: string | Date; buz?: string | undefined; }; }; bla: unknown; _: Array<string | number>; } > >(true);});
Deno.test("parseArgs() handles types of dotted string and boolean args", function () { const argv = parseArgs([], { boolean: ["blubb", "foo.bar", "foo.baz.biz", "beep.bib.bub"], string: ["bla", "beep.boop", "beep.bib.bab", "foo.baz.buz"], }); assertType< IsExact< typeof argv, & { [x: string]: unknown } & { blubb: boolean; foo: { bar: boolean; baz: { biz: boolean; buz?: string | undefined; }; }; bla?: string | undefined; beep: { boop?: string | undefined; bib: { bab?: string | undefined; bub: boolean; }; }; _: Array<string | number>; } > >(true);});
Deno.test("parseArgs() handles types of dotted string and boolean args with defaults", function () { const argv = parseArgs([], { boolean: ["blubb", "foo.bar", "foo.baz.biz", "beep.bib.bub"], string: ["beep.boop", "beep.bib.bab", "foo.baz.buz"], default: { blubb: true, foo: { bar: 123, baz: { biz: new Date(), }, }, beep: { boop: true, bib: { bab: new Date(), }, }, bla: new Date(), }, }); assertType< IsExact< typeof argv, & { [x: string]: unknown } & { bla: unknown; blubb: boolean; foo: { bar: boolean | number; baz: { biz: boolean | Date; buz?: string | undefined; }; }; beep: { boop: string | boolean; bib: { bab: string | Date; bub: boolean; }; }; _: Array<string | number>; } > >(true);});
Deno.test("parseArgs() handles types of dotted string and boolean args with flatted defaults", function () { const argv = parseArgs([], { boolean: ["blubb", "foo.bar", "foo.baz.biz", "beep.bib.bub"], string: ["beep.boop", "beep.bib.bab", "foo.baz.buz"], default: { bla: new Date(), blubb: true, "foo.bar": 123, "foo.baz.biz": new Date(), "beep.boop": true, "beep.bib.bab": new Date(), "mee.moo": true, }, }); assertType< IsExact< typeof argv, & { [x: string]: unknown } & { bla: unknown; blubb: boolean; mee: unknown; foo: { bar: boolean | number; baz: { biz: boolean | Date; buz?: string | undefined; }; }; beep: { boop: string | boolean; bib: { bab: string | Date; bub: boolean; }; }; _: Array<string | number>; } > >(true);});
Deno.test("parseArgs() handles types of dotted args with union defaults", function () { const argv = parseArgs([], { string: ["foo.bar.baz"], boolean: ["beep.boop.bab"], default: { "foo": 1, "beep": new Date(), }, }); assertType< IsExact< typeof argv, & { [x: string]: unknown } & { foo: number | { bar?: { baz?: string | undefined; } | undefined; }; beep: Date | { boop: { bab: boolean; }; }; _: Array<string | number>; } > >(true);});
Deno.test("parseArgs() handles types of dotted args with nested union defaults", function () { const argv = parseArgs([], { string: ["foo.bar.baz"], boolean: ["beep.boop.bab"], default: { "foo.bar": 1, "beep.boop": new Date(), }, }); assertType< IsExact< typeof argv, & { [x: string]: unknown } & { foo: { bar: number | { baz?: string | undefined; }; }; beep: { boop: Date | { bab: boolean; }; }; _: Array<string | number>; } > >(true);});
Deno.test("parseArgs() handles types of args with dotted defaults", function () { const argv = parseArgs([], { string: ["foo"], default: { "foo.bar": 1, }, }); assertType< IsExact< typeof argv, & { [x: string]: unknown } & { foo: string | { bar: number; }; _: Array<string | number>; } > >(true);});
/** ------------------------ COLLECT OPTION -------------------------- */
Deno.test("parseArgs() handles types of collect unknown args", function () { const argv = parseArgs([], { collect: ["foo", "bar.baz"], }); assertType< IsExact< typeof argv, & { [x: string]: unknown } & { foo: Array<unknown>; bar: { baz: Array<unknown>; }; _: Array<string | number>; } > >(true);});
Deno.test("parseArgs() handles types of collect args", function () { const argv = parseArgs([], { boolean: ["foo", "dotted.beep"], string: ["bar", "dotted.boop"], collect: ["foo", "dotted.boop"], }); assertType< IsExact< typeof argv, & { [x: string]: unknown } & { bar?: string | undefined; dotted: { boop: Array<string>; beep: boolean; }; foo: Array<boolean>; _: Array<string | number>; } > >(true);});
Deno.test("parseArgs() handles types of collect args with defaults", function () { const argv = parseArgs([], { boolean: ["foo", "dotted.beep"], string: ["bar", "dotted.boop"], collect: ["foo", "dotted.boop"], default: { bar: 123, dotted: { beep: new Date(), boop: /.*/, }, foo: new TextDecoder(), }, }); assertType< IsExact< typeof argv, & { [x: string]: unknown } & { bar: number | string; foo: TextDecoder | Array<boolean>; dotted: { beep: boolean | Date; boop: RegExp | Array<string>; }; _: Array<string | number>; } > >(true);});
Deno.test("parseArgs() handles types of collect args with single args", function () { const argv = parseArgs([], { boolean: ["foo"], collect: ["foo"], }); assertType< IsExact< typeof argv, & { [x: string]: unknown } & { foo: Array<boolean>; _: Array<string | number>; } > >(true);});
Deno.test("parseArgs() handles types of collect args with empty type array", function () { const argv = parseArgs([], { boolean: [], collect: ["foo"], }); assertType< IsExact< typeof argv, & { [x: string]: unknown } & { foo: Array<unknown>; _: Array<string | number>; } > >(true);});
Deno.test("parseArgs() handles types of collect args with unknown args", function () { const argv = parseArgs([], { boolean: ["bar"], collect: ["foo"], }); assertType< IsExact< typeof argv, & { [x: string]: unknown } & { bar: boolean; foo: Array<unknown>; _: Array<string | number>; } > >(true);});
Deno.test("parseArgs() handles types of collect args with known and unknown args", function () { const argv = parseArgs([], { boolean: ["foo"], collect: ["foo", "bar"], }); assertType< IsExact< typeof argv, & { [x: string]: unknown } & { foo: Array<boolean>; bar: Array<unknown>; _: Array<string | number>; } > >(true);});
/** -------------------------- NEGATABLE OPTIONS --------------------------- */
Deno.test("parseArgs() handles types of negatable args", function () { const argv = parseArgs([], { boolean: ["foo", "bar", "dotted.tick", "dotted.tock"], string: ["beep", "boop", "dotted.zig", "dotted.zag"], negatable: ["bar", "boop", "dotted.tick", "dotted.zig"], }); assertType< IsExact< typeof argv, & { [x: string]: unknown } & { beep?: string | undefined; boop?: string | false | undefined; dotted: { zig?: string | false | undefined; zag?: string | undefined; tick: boolean; tock: boolean; }; foo: boolean; bar: boolean; _: Array<string | number>; } > >(true);});
Deno.test("parseArgs() handles types of collect all args with defaults", function () { const argv = parseArgs([], { boolean: ["foo", "bar", "dotted.tick", "dotted.tock"], string: ["beep", "boop", "dotted.zig", "dotted.zag"], negatable: ["bar", "boop", "dotted.tick", "dotted.zig"], default: { bar: 123, boop: new TextDecoder(), dotted: { tick: new Date(), zig: /.*/, }, }, }); assertType< IsExact< typeof argv, & { [x: string]: unknown } & { foo: boolean; beep?: string | undefined; bar: number | boolean; boop: string | false | TextDecoder; dotted: { zag?: string | undefined; tock: boolean; tick: boolean | Date; zig: string | false | RegExp; }; _: Array<string | number>; } > >(true);});
/** ----------------------------- ALIAS OPTION ----------------------------- */
Deno.test("parseArgs() handles types of alias args", function () { const argv = parseArgs([], { boolean: ["foo"], string: ["beep"], alias: { foo: ["bar", "baz"], beep: "boop", }, }); assertType< IsExact< typeof argv, & { [x: string]: unknown } & { beep?: string | undefined; boop?: string | undefined; foo: boolean; bar: boolean; baz: boolean; _: Array<string | number>; } > >(true);});
Deno.test("parseArgs() handles types of alias args with options", function () { const argv = parseArgs([], { boolean: ["foo", "biz"], string: ["beep", "bib"], negatable: ["foo", "beep"], alias: { foo: "bar", beep: "boop", biz: "baz", }, default: { foo: 1, beep: new Date(), }, }); assertType< IsExact< typeof argv, & { [x: string]: unknown } & { baz: boolean; biz: boolean; bib?: string | undefined; foo: number | boolean; bar: number | boolean; beep: string | false | Date; boop: string | false | Date; _: Array<string | number>; } > >(true);});
/** ----------------------- OTHER TYPE TESTS ------------------------ */
Deno.test("parseArgs() handles types of double dash option", function () { const argv = parseArgs([], { boolean: true, string: ["foo"], "--": true, }); assertType< IsExact< typeof argv, & { [x: string]: unknown } & { foo?: string | undefined; _: Array<string | number>; "--": Array<string>; } > >(true);});
Deno.test("parseArgs() handles types of nullish defaults", function () { const argv = parseArgs([], { boolean: true, string: ["foo", "bar", "baz"], default: { bar: undefined, baz: null, }, }); assertType< IsExact< typeof argv, & { [x: string]: unknown } & { foo?: string | undefined; bar: string | undefined; baz: string | null; _: Array<string | number>; } > >(true);});
Deno.test("parseArgs() handles types of parse generics", function () { const argv = parseArgs<{ foo?: number } & { bar: string }, true>([]); assertType< IsExact< typeof argv, { foo?: number | undefined; bar: string; _: Array<string | number>; "--": Array<string>; } > >(true);});
Deno.test("parseArgs() handles types of args generics", function () { type ArgsResult = Args<{ foo?: number } & { bar: string }, true>; assertType< IsExact< ArgsResult, { foo?: number | undefined; bar: string; _: Array<string | number>; "--": Array<string>; } > >(true);});
Deno.test("parseArgs() handles types of parse options generics", function () { type Opts = ParseOptions<"foo", "bar" | "baz">; assertType< IsExact< Pick<Opts, "string">, { string?: "bar" | "baz" | ReadonlyArray<"bar" | "baz"> | undefined } > >(true);
assertType< IsExact< Pick<Opts, "boolean">, { boolean?: "foo" | ReadonlyArray<"foo"> | undefined } > >(true);
assertType< IsExact< Pick<Opts, "default">, { default?: { [x: string]: unknown; bar?: unknown; baz?: unknown; foo?: unknown; } | undefined; } > >(true);});
Deno.test("parseArgs() handles types of parse options generic defaults", function () { const opts: ParseOptions = { boolean: ["foo"], string: ["bar"], };
const args = parseArgs([], opts);
assertType< IsExact< typeof args, { // deno-lint-ignore no-explicit-any [x: string]: any; _: (string | number)[]; "--"?: string[] | undefined; } > >(true);});
Deno.test("parseArgs() handles collect with alias", () => { const args = ["--header", "abc", "--header", "def"]; const parsed = parseArgs(args, { collect: ["header"], alias: { H: "header", }, }); assertEquals(parsed.header, ["abc", "def"]);});
std
Version Info
6 months ago
