Skip to main content
Using Deno in production at your company? Earn free Deno merch.
Give us feedback
Module

std/cli/parse_args_test.ts

Deno standard library
Go to Latest
File
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918
// 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, {