Module
Command line framework for deno 🦕 Including Commandline-Interfaces, Prompts, CLI-Table, Arguments Parser and more...
Extremely Popular
Latest
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022// deno-lint-ignore-file no-explicit-anyimport { UnknownTypeError, ValidationError as FlagsValidationError,} from "../flags/_errors.ts";import { parseFlags } from "../flags/flags.ts";import type { ParseFlagsContext } from "../flags/types.ts";import { getDescription, parseArgumentsDefinition, splitArguments, underscoreToCamelCase,} from "./_utils.ts";import { bold, brightBlue, red } from "./deps.ts";import { CommandNotFoundError, DefaultCommandNotFoundError, DuplicateCommandAliasError, DuplicateCommandNameError, DuplicateCompletionError, DuplicateEnvVarError, DuplicateExampleError, DuplicateOptionNameError, DuplicateTypeError, MissingArgumentError, MissingArgumentsError, MissingCommandNameError, MissingRequiredEnvVarError, NoArgumentsAllowedError, TooManyArgumentsError, TooManyEnvVarValuesError, UnexpectedOptionalEnvVarValueError, UnexpectedVariadicEnvVarValueError, UnknownCommandError, ValidationError,} from "./_errors.ts";import { Merge, OneOf, ValueOf } from "./_type_utils.ts";import { BooleanType } from "./types/boolean.ts";import { FileType } from "./types/file.ts";import { IntegerType } from "./types/integer.ts";import { NumberType } from "./types/number.ts";import { StringType } from "./types/string.ts";import { Type } from "./type.ts";import { HelpGenerator, type HelpOptions } from "./help/_help_generator.ts";import { MapTypes, MapValue, MergeOptions, TypedArguments, TypedCommandArguments, TypedEnv, TypedOption, TypedType,} from "./_argument_types.ts";import type { ActionHandler, Argument, ArgumentValue, CommandResult, CompleteHandler, CompleteOptions, Completion, DefaultValue, Description, EnvVar, EnvVarOptions, EnvVarValueHandler, ErrorHandler, Example, GlobalEnvVarOptions, GlobalOptionOptions, HelpHandler, Option, OptionOptions, OptionValueHandler, TypeDef, TypeOptions, TypeOrTypeHandler, VersionHandler,} from "./types.ts";import { checkVersion } from "./upgrade/_check_version.ts";
/** * Chainable command factory class. * * ```ts * import { Command } from "./mod.ts"; * * export const cli = new Command() * .name("todo") * .description("Example command description") * .globalOption("--verbose", "Enable verbose output.") * .globalEnv("VERBOSE=<value>", "Enable verbose output.") * .command("add <todo>", "Add todo.") * .action(({ verbose }, todo: string) => { * if (verbose) { * console.log("Add todo '%s'.", todo); * } * }) * .command("delete <id>", "Delete todo.") * .action(({ verbose }, id: string) => { * if (verbose) { * console.log("Delete todo with id '%s'.", id); * } * }); * * if (import.meta.main) { * await cli.parse(); * } * ``` */export class Command< TParentCommandGlobals extends Record<string, unknown> | void = void, TParentCommandTypes extends Record<string, unknown> | void = TParentCommandGlobals extends number ? any : void, TCommandOptions extends Record<string, unknown> | void = TParentCommandGlobals extends number ? any : void, TCommandArguments extends Array<unknown> = TParentCommandGlobals extends number ? any : [], TCommandGlobals extends Record<string, unknown> | void = TParentCommandGlobals extends number ? any : void, TCommandTypes extends Record<string, unknown> | void = TParentCommandGlobals extends number ? any : { number: number; integer: number; string: string; boolean: boolean; file: string; }, TCommandGlobalTypes extends Record<string, unknown> | void = TParentCommandGlobals extends number ? any : void, TParentCommand extends Command<any> | undefined = TParentCommandGlobals extends number ? any : undefined,> { private types: Map<string, TypeDef> = new Map(); private rawArgs: Array<string> = []; private literalArgs: Array<string> = []; private _name = "COMMAND"; private _parent?: TParentCommand; private _globalParent?: Command<any>; private ver?: VersionHandler; private desc: Description = ""; private _usage?: string; private actionHandler?: ActionHandler; private globalActionHandler?: ActionHandler; private options: Array<Option> = []; private commands = new Map<string, Command<any>>(); private examples: Array<Example> = []; private envVars: Array<EnvVar> = []; private aliases: Array<string> = []; private completions = new Map<string, Completion>(); private cmd: Command<any> = this; private argsDefinition?: string; private throwOnError = false; private _allowEmpty = false; private _stopEarly = false; private defaultCommand?: string; private _useRawArgs = false; private args: Array<Argument> = []; private isHidden = false; private isGlobal = false; private hasDefaults = false; private _versionOptions?: DefaultOption | false; private _helpOptions?: DefaultOption | false; private _versionOption?: Option; private _helpOption?: Option; private _help?: HelpHandler; private _shouldExit?: boolean; private _meta: Record<string, string> = {}; private _groupName: string | null = null; private _noGlobals = false; private errorHandler?: ErrorHandler;
/** Disable version option. */ public versionOption(enable: false): this;
/** * Set global version option. * * @param flags The flags of the version option. * @param desc The description of the version option. * @param opts Version option options. */ public versionOption( flags: string, desc?: string, opts?: & OptionOptions< Partial<TCommandOptions>, TCommandArguments, TCommandGlobals, TParentCommandGlobals, TCommandTypes, TCommandGlobalTypes, TParentCommandTypes, TParentCommand > & { global: true; }, ): this;
/** * Set version option. * * @param flags The flags of the version option. * @param desc The description of the version option. * @param opts Version option options. */ public versionOption( flags: string, desc?: string, opts?: OptionOptions< TCommandOptions, TCommandArguments, TCommandGlobals, TParentCommandGlobals, TCommandTypes, TCommandGlobalTypes, TParentCommandTypes, TParentCommand >, ): this;
/** * Set version option. * * @param flags The flags of the version option. * @param desc The description of the version option. * @param opts The action of the version option. */ public versionOption( flags: string, desc?: string, opts?: ActionHandler< TCommandOptions, TCommandArguments, TCommandGlobals, TParentCommandGlobals, TCommandTypes, TCommandGlobalTypes, TParentCommandTypes, TParentCommand >, ): this;
public versionOption( flags: string | false, desc?: string, opts?: | ActionHandler< TCommandOptions, TCommandArguments, TCommandGlobals, TParentCommandGlobals, TCommandTypes, TCommandGlobalTypes, TParentCommandTypes, TParentCommand > | OptionOptions< TCommandOptions, TCommandArguments, TCommandGlobals, TParentCommandGlobals, TCommandTypes, TCommandGlobalTypes, TParentCommandTypes, TParentCommand > | OptionOptions< Partial<TCommandOptions>, TCommandArguments, TCommandGlobals, TParentCommandGlobals, TCommandTypes, TCommandGlobalTypes, TParentCommandTypes, TParentCommand > & { global: true; }, ): this { this._versionOptions = flags === false ? flags : { flags, desc, opts: typeof opts === "function" ? { action: opts } : opts, }; return this; }
/** Disable help option. */ public helpOption(enable: false): this;
/** * Set global help option. * * @param flags The flags of the help option. * @param desc The description of the help option. * @param opts Help option options. */ public helpOption( flags: string, desc?: string, opts?: & OptionOptions< Partial<TCommandOptions>, TCommandArguments, TCommandGlobals, TParentCommandGlobals, TCommandTypes, TCommandGlobalTypes, TParentCommandTypes, TParentCommand > & { global: true; }, ): this;
/** * Set help option. * * @param flags The flags of the help option. * @param desc The description of the help option. * @param opts Help option options. */ public helpOption( flags: string, desc?: string, opts?: OptionOptions< TCommandOptions, TCommandArguments, TCommandGlobals, TParentCommandGlobals, TCommandTypes, TCommandGlobalTypes, TParentCommandTypes, TParentCommand >, ): this;
/** * Set help option. * * @param flags The flags of the help option. * @param desc The description of the help option. * @param opts The action of the help option. */ public helpOption( flags: string, desc?: string, opts?: ActionHandler< TCommandOptions, TCommandArguments, TCommandGlobals, TParentCommandGlobals, TCommandTypes, TCommandGlobalTypes, TParentCommandTypes, TParentCommand >, ): this;
public helpOption( flags: string | false, desc?: string, opts?: | ActionHandler< TCommandOptions, TCommandArguments, TCommandGlobals, TParentCommandGlobals, TCommandTypes, TCommandGlobalTypes, TParentCommandTypes, TParentCommand > | OptionOptions< TCommandOptions, TCommandArguments, TCommandGlobals, TParentCommandGlobals, TCommandTypes, TCommandGlobalTypes, TParentCommandTypes, TParentCommand > | OptionOptions< Partial<TCommandOptions>, TCommandArguments, TCommandGlobals, TParentCommandGlobals, TCommandTypes, TCommandGlobalTypes, TParentCommandTypes, TParentCommand > & { global: true; }, ): this { this._helpOptions = flags === false ? flags : { flags, desc, opts: typeof opts === "function" ? { action: opts } : opts, }; return this; }
/** * Add new sub-command. * * @param name Command definition. E.g: `my-command <input-file:string> <output-file:string>` * @param cmd The new child command to register. * @param override Override existing child command. */ public command< TCommand extends Command< (TGlobalOptions & Record<string, unknown>) | void | undefined, TGlobalTypes | void | undefined, Record<string, unknown> | void, Array<unknown>, Record<string, unknown> | void, Record<string, unknown> | void, Record<string, unknown> | void, Command< TGlobalOptions | void | undefined, TGlobalTypes | void | undefined, Record<string, unknown> | void, Array<unknown>, Record<string, unknown> | void, Record<string, unknown> | void, Record<string, unknown> | void, undefined > >, TGlobalOptions extends (TParentCommand extends Command<any> ? TParentCommandGlobals : Merge<TParentCommandGlobals, TCommandGlobals>), TGlobalTypes extends (TParentCommand extends Command<any> ? TParentCommandTypes : Merge<TParentCommandTypes, TCommandTypes>), >( name: string, cmd: TCommand, override?: boolean, ): ReturnType<TCommand["reset"]> extends Command< Record<string, unknown> | void, Record<string, unknown> | void, infer Options, infer Arguments, infer GlobalOptions, infer Types, infer GlobalTypes, undefined > ? Command< TGlobalOptions, TGlobalTypes, Options, Arguments, GlobalOptions, Types, GlobalTypes, OneOf<TParentCommand, this> > : never;
/** * Add new sub-command. * * @param name Command definition. E.g: `my-command <input-file:string> <output-file:string>` * @param cmd The new child command to register. * @param override Override existing child command. */ public command< TCommand extends Command< TGlobalOptions | void | undefined, TGlobalTypes | void | undefined, Record<string, unknown> | void, Array<unknown>, Record<string, unknown> | void, Record<string, unknown> | void, Record<string, unknown> | void, OneOf<TParentCommand, this> | undefined >, TGlobalOptions extends (TParentCommand extends Command<any> ? TParentCommandGlobals : Merge<TParentCommandGlobals, TCommandGlobals>), TGlobalTypes extends (TParentCommand extends Command<any> ? TParentCommandTypes : Merge<TParentCommandTypes, TCommandTypes>), >( name: string, cmd: TCommand, override?: boolean, ): TCommand extends Command< Record<string, unknown> | void, Record<string, unknown> | void, infer Options, infer Arguments, infer GlobalOptions, infer Types, infer GlobalTypes, OneOf<TParentCommand, this> | undefined > ? Command< TGlobalOptions, TGlobalTypes, Options, Arguments, GlobalOptions, Types, GlobalTypes, OneOf<TParentCommand, this> > : never;
/** * Add new sub-command. * * @param nameAndArguments Command definition. E.g: `my-command <input-file:string> <output-file:string>` * @param desc The description of the new child command. * @param override Override existing child command. */ public command< TNameAndArguments extends string, TArguments extends TypedCommandArguments< TNameAndArguments, TParentCommand extends Command<any> ? TParentCommandTypes : Merge<TParentCommandTypes, TCommandGlobalTypes> >, >( nameAndArguments: TNameAndArguments, desc?: string, override?: boolean, ): TParentCommandGlobals extends number ? Command<any> : Command< TParentCommand extends Command<any> ? TParentCommandGlobals : Merge<TParentCommandGlobals, TCommandGlobals>, TParentCommand extends Command<any> ? TParentCommandTypes : Merge<TParentCommandTypes, TCommandGlobalTypes>, void, TArguments, void, void, void, OneOf<TParentCommand, this> >;
/** * Add new sub-command. * @param nameAndArguments Command definition. E.g: `my-command <input-file:string> <output-file:string>` * @param cmdOrDescription The description of the new child command. * @param override Override existing child command. */ command( nameAndArguments: string, cmdOrDescription?: Command<any> | string, override?: boolean, ): Command<any> { this.reset();
const result = splitArguments(nameAndArguments);
const name: string | undefined = result.flags.shift(); const aliases: string[] = result.flags;
if (!name) { throw new MissingCommandNameError(); }
if (this.getBaseCommand(name, true)) { if (!override) { throw new DuplicateCommandNameError(name); } this.removeCommand(name); }
let description: string | undefined; let cmd: Command<any>;
if (typeof cmdOrDescription === "string") { description = cmdOrDescription; }
if (cmdOrDescription instanceof Command) { cmd = cmdOrDescription.reset(); } else { cmd = new Command(); }
cmd._name = name; cmd._parent = this;
if (description) { cmd.description(description); }
if (result.typeDefinition) { cmd.arguments(result.typeDefinition); }
aliases.forEach((alias: string) => cmd.alias(alias));
this.commands.set(name, cmd);
this.select(name);
return this; }
/** * Add new command alias. * * @param alias Tha name of the alias. */ public alias(alias: string): this { if (this.cmd._name === alias || this.cmd.aliases.includes(alias)) { throw new DuplicateCommandAliasError(alias); }
this.cmd.aliases.push(alias);
return this; }
/** Reset internal command reference to main command. */ public reset(): OneOf<TParentCommand, this> { this._groupName = null; this.cmd = this; return this as OneOf<TParentCommand, this>; }
/** * Set internal command pointer to child command with given name. * @param name The name of the command to select. */ public select< TOptions extends Record<string, unknown> | void = any, TArguments extends Array<unknown> = any, TGlobalOptions extends Record<string, unknown> | void = any, >( name: string, ): Command< TParentCommandGlobals, TParentCommandTypes, TOptions, TArguments, TGlobalOptions, TCommandTypes, TCommandGlobalTypes, TParentCommand > { const cmd = this.getBaseCommand(name, true);
if (!cmd) { throw new CommandNotFoundError(name, this.getBaseCommands(true)); }
this.cmd = cmd;
return this as Command<any>; }
/***************************************************************************** **** SUB HANDLER ************************************************************ *****************************************************************************/
/** Set command name. Used in auto generated help and shell completions */ public name(name: string): this { this.cmd._name = name; return this; }
/** * Set command version. * * @param version Semantic version string string or method that returns the version string. */ public version( version: | string | VersionHandler< Partial<TCommandOptions>, Partial<TCommandArguments>, TCommandGlobals, TParentCommandGlobals, TCommandTypes, TCommandGlobalTypes, TParentCommandTypes, TParentCommand >, ): this { if (typeof version === "string") { this.cmd.ver = () => version; } else if (typeof version === "function") { this.cmd.ver = version; } return this; }
/** * Add meta data. Will be displayed in the auto generated help and in the * output of the long version. * * @param name The name/label of the metadata. * @param value The value of the metadata. */ public meta(name: string, value: string): this { this.cmd._meta[name] = value; return this; }
/** Returns an object of metadata. */ public getMeta(): Record<string, string>;
/** Get metadata value by name. */ public getMeta(name: string): string;
public getMeta(name?: string): Record<string, string> | string { return typeof name === "undefined" ? this._meta : this._meta[name]; }
/** * Set command help. * * @param help Help string, method, or config for generator that returns the help string. */ public help( help: | string | HelpHandler< Partial<TCommandOptions>, Partial<TCommandArguments>, TCommandGlobals, TParentCommandGlobals > | HelpOptions, ): this { if (typeof help === "string") { this.cmd._help = () => help; } else if (typeof help === "function") { this.cmd._help = help; } else { this.cmd._help = (cmd: Command, options: HelpOptions): string => HelpGenerator.generate(cmd, { ...help, ...options }); } return this; }
/** * Set the long command description. * * @param description The command description. */ public description( description: Description< TCommandOptions, TCommandArguments, TCommandGlobals, TParentCommandGlobals, TCommandTypes, TCommandGlobalTypes, TParentCommandTypes, TParentCommand >, ): this { this.cmd.desc = description; return this; }
/** * Set the command usage. Defaults to arguments. * * @param usage The command usage. */ public usage(usage: string): this { this.cmd._usage = usage; return this; }
/** Hide command from help, completions, etc. */ public hidden(): this { this.cmd.isHidden = true; return this; }
/** Make command globally available. */ public global(): this { this.cmd.isGlobal = true; return this; }
/** * Set command arguments. * * Syntax: `<requiredArg:string> [optionalArg: number] [...restArgs:string]` */ public arguments< TArguments extends TypedArguments< TArgs, Merge<TParentCommandTypes, Merge<TCommandGlobalTypes, TCommandTypes>> >, TArgs extends string = string, >( args: TArgs, ): Command< TParentCommandGlobals, TParentCommandTypes, TCommandOptions, TArguments, TCommandGlobals, TCommandTypes, TCommandGlobalTypes, TParentCommand > { this.cmd.argsDefinition = args; return this as Command<any>; }
/** * Set command callback method. * * @param fn Command action handler. */ public action( fn: ActionHandler< TCommandOptions, TCommandArguments, TCommandGlobals, TParentCommandGlobals, TCommandTypes, TCommandGlobalTypes, TParentCommandTypes, TParentCommand >, ): this { this.cmd.actionHandler = fn; return this; }
/** * Set command callback method. * * @param fn Command action handler. */ public globalAction( fn: ActionHandler< Partial<TCommandOptions>, Array<unknown>, TCommandGlobals, TParentCommandGlobals, TCommandTypes, TCommandGlobalTypes, TParentCommandTypes, TParentCommand >, ): this { this.cmd.globalActionHandler = fn; return this; }
/** * Don't throw an error if the command was called without arguments. * * @param allowEmpty Enable/disable allow empty. */ public allowEmpty<TAllowEmpty extends boolean | undefined = undefined>( allowEmpty?: TAllowEmpty, ): false extends TAllowEmpty ? this : Command< Partial<TParentCommandGlobals>, TParentCommandTypes, Partial<TCommandOptions>, TCommandArguments, TCommandGlobals, TCommandTypes, TCommandGlobalTypes, TParentCommand > { this.cmd._allowEmpty = allowEmpty !== false; return this as false extends TAllowEmpty ? this : Command< Partial<TParentCommandGlobals>, TParentCommandTypes, Partial<TCommandOptions>, TCommandArguments, TCommandGlobals, TCommandTypes, TCommandGlobalTypes, TParentCommand >; }
/** * Enable stop early. If enabled, all arguments starting from the first non * option argument will be passed as arguments with type string to the command * action handler. * * For example: * `command --debug-level warning server --port 80` * * Will result in: * - options: `{ debugLevel: 'warning' }` * - args: `['server', '--port', '80']` * * @param stopEarly Enable/disable stop early. */ public stopEarly(stopEarly = true): this { this.cmd._stopEarly = stopEarly; return this; }
/** * Disable parsing arguments. If enabled the raw arguments will be passed to * the action handler. This has no effect for parent or child commands. Only * for the command on which this method was called. * * @param useRawArgs Enable/disable raw arguments. */ public useRawArgs( useRawArgs = true, ): Command< void, void, void, Array<string>, void, void, void, TParentCommand > { this.cmd._useRawArgs = useRawArgs; return this as Command<any>; }
/** * Set default command. The default command is executed when the program * was called without any argument and if no action handler is registered. * * @param name Name of the default command. */ public default(name: string): this { this.cmd.defaultCommand = name; return this; }
public globalType< THandler extends TypeOrTypeHandler<unknown>, TName extends string = string, >( name: TName, handler: THandler, options?: Omit<TypeOptions, "global">, ): Command< TParentCommandGlobals, TParentCommandTypes, TCommandOptions, TCommandArguments, TCommandGlobals, TCommandTypes, Merge<TCommandGlobalTypes, TypedType<TName, THandler>>, TParentCommand > { return this.type(name, handler, { ...options, global: true }); }
/** * Register custom type. * * @param name The name of the type. * @param handler The callback method to parse the type. * @param options Type options. */ public type< THandler extends TypeOrTypeHandler<unknown>, TName extends string = string, >( name: TName, handler: THandler, options?: TypeOptions, ): Command< TParentCommandGlobals, TParentCommandTypes, TCommandOptions, TCommandArguments, TCommandGlobals, Merge<TCommandTypes, TypedType<TName, THandler>>, TCommandGlobalTypes, TParentCommand > { if (this.cmd.types.get(name) && !options?.override) { throw new DuplicateTypeError(name); }
this.cmd.types.set(name, { ...options, name, handler: handler as TypeOrTypeHandler<unknown>, });
if ( handler instanceof Type && (typeof handler.complete !== "undefined" || typeof handler.values !== "undefined") ) { const completeHandler: CompleteHandler = ( cmd: Command, parent?: Command, ) => handler.complete?.(cmd, parent) || []; this.complete(name, completeHandler, options); }
return this as Command<any>; }
/** * Register global complete handler. * * @param name The name of the completion. * @param complete The callback method to complete the type. * @param options Complete options. */ public globalComplete( name: string, complete: CompleteHandler, options?: Omit<CompleteOptions, "global">, ): this { return this.complete(name, complete, { ...options, global: true }); }
/** * Register global complete handler. * * @param name The name of the completion. * @param complete The callback method to complete the type. * @param options Complete options. */ public complete( name: string, complete: CompleteHandler< Partial<TCommandOptions>, Partial<TCommandArguments>, TCommandGlobals, TParentCommandGlobals, TCommandTypes, TCommandGlobalTypes, TParentCommandTypes, any >, options: CompleteOptions & { global: boolean }, ): this;
/** * Register complete handler. * * @param name The name of the completion. * @param complete The callback method to complete the type. * @param options Complete options. */ public complete( name: string, complete: CompleteHandler< TCommandOptions, TCommandArguments, TCommandGlobals, TParentCommandGlobals, TCommandTypes, TCommandGlobalTypes, TParentCommandTypes, TParentCommand >, options?: CompleteOptions, ): this;
public complete( name: string, complete: | CompleteHandler< TCommandOptions, TCommandArguments, TCommandGlobals, TParentCommandGlobals, TCommandTypes, TCommandGlobalTypes, TParentCommandTypes, TParentCommand > | CompleteHandler< Partial<TCommandOptions>, Partial<TCommandArguments>, TCommandGlobals, TParentCommandGlobals, TCommandTypes, TCommandGlobalTypes, TParentCommandTypes, any >, options?: CompleteOptions, ): this { if (this.cmd.completions.has(name) && !options?.override) { throw new DuplicateCompletionError(name); }
this.cmd.completions.set(name, { name, complete, ...options, });
return this; }
/** * Throw validation errors instead of calling `Deno.exit()` to handle * validation errors manually. * * A validation error is thrown when the command is wrongly used by the user. * For example: If the user passes some invalid options or arguments to the * command. * * This has no effect for parent commands. Only for the command on which this * method was called and all child commands. * * **Example:** * * ```ts * import { Command, ValidationError } from "./mod.ts"; * * const cmd = new Command(); * // ... * * try { * cmd.parse(); * } catch(error) { * if (error instanceof ValidationError) { * cmd.showHelp(); * Deno.exit(1); * } * throw error; * } * ``` * * @see ValidationError */ public throwErrors(): this { this.cmd.throwOnError = true; return this; }
/** * Set custom error handler. * * @param handler Error handler callback function. */ public error(handler: ErrorHandler): this { this.cmd.errorHandler = handler; return this; }
/** Get error handler callback function. */ private getErrorHandler(): ErrorHandler | undefined { return this.errorHandler ?? this._parent?.errorHandler; }
/** * Same as `.throwErrors()` but also prevents calling `Deno.exit` after * printing help or version with the --help and --version option. */ public noExit(): this { this.cmd._shouldExit = false; this.throwErrors(); return this; }
/** * Disable inheriting global commands, options and environment variables from * parent commands. */ public noGlobals(): this { this.cmd._noGlobals = true; return this; }
/** Check whether the command should throw errors or exit. */ protected shouldThrowErrors(): boolean { return this.throwOnError || !!this._parent?.shouldThrowErrors(); }
/** Check whether the command should exit after printing help or version. */ protected shouldExit(): boolean { return this._shouldExit ?? this._parent?.shouldExit() ?? true; }
/** * Enable grouping of options and set the name of the group. * All option which are added after calling the `.group()` method will be * grouped in the help output. If the `.group()` method can be use multiple * times to create more groups. * * @param name The name of the option group. */ public group(name: string | null): this { this.cmd._groupName = name; return this; }
/** * Register a global option. * * @param flags Flags string e.g: -h, --help, --manual <requiredArg:string> [optionalArg:number] [...restArgs:string] * @param desc Flag description. * @param opts Flag options or custom handler for processing flag value. */ public globalOption< TFlags extends string, TGlobalOptions extends TypedOption< TFlags, TCommandOptions, Merge<TParentCommandTypes, Merge<TCommandGlobalTypes, TCommandTypes>>, undefined extends TConflicts ? TRequired : false, TDefaultValue >, TMappedGlobalOptions extends MapValue< TGlobalOptions, TMappedValue, TCollect >, TRequired extends OptionOptions["required"] = undefined, TCollect extends OptionOptions["collect"] = undefined, TConflicts extends OptionOptions["conflicts"] = undefined, const TDefaultValue = undefined, TMappedValue = undefined, >( flags: TFlags, desc: string, opts?: | Omit< GlobalOptionOptions< Partial<TCommandOptions>, TCommandArguments, MergeOptions<TFlags, TCommandGlobals, TGlobalOptions>, TParentCommandGlobals, TCommandTypes, TCommandGlobalTypes, TParentCommandTypes, TParentCommand >, "value" > & { default?: DefaultValue<TDefaultValue>; required?: TRequired; collect?: TCollect; value?: OptionValueHandler< MapTypes<ValueOf<TGlobalOptions>>, TMappedValue >; } | OptionValueHandler<MapTypes<ValueOf<TGlobalOptions>>, TMappedValue>, ): Command< TParentCommandGlobals, TParentCommandTypes, TCommandOptions, TCommandArguments, MergeOptions<TFlags, TCommandGlobals, TMappedGlobalOptions>, TCommandTypes, TCommandGlobalTypes, TParentCommand > { if (typeof opts === "function") { return this.option( flags, desc, { value: opts, global: true } as OptionOptions, ) as Command<any>; } return this.option( flags, desc, { ...opts, global: true } as OptionOptions, ) as Command<any>; }
/** * Add a global option. * * @param flags Flags string e.g: -h, --help, --manual <requiredArg:string> [optionalArg:number] [...restArgs:string] * @param desc Flag description. * @param opts Flag options or custom handler for processing flag value. */ public option< TFlags extends string, TGlobalOptions extends TypedOption< TFlags, TCommandOptions, Merge<TParentCommandTypes, Merge<TCommandGlobalTypes, TCommandTypes>>, undefined extends TConflicts ? TRequired : false, TDefaultValue >, TMappedGlobalOptions extends MapValue< TGlobalOptions, TMappedValue, TCollect >, TRequired extends OptionOptions["required"] = undefined, TCollect extends OptionOptions["collect"] = undefined, TConflicts extends OptionOptions["conflicts"] = undefined, const TDefaultValue = undefined, TMappedValue = undefined, >( flags: TFlags, desc: string, opts: | Omit< OptionOptions< Partial<TCommandOptions>, TCommandArguments, MergeOptions<TFlags, TCommandGlobals, TGlobalOptions>, TParentCommandGlobals, TCommandTypes, TCommandGlobalTypes, TParentCommandTypes, TParentCommand >, "value" > & { global: true; default?: DefaultValue<TDefaultValue>; required?: TRequired; collect?: TCollect; value?: OptionValueHandler< MapTypes<ValueOf<TGlobalOptions>>, TMappedValue >; } | OptionValueHandler<MapTypes<ValueOf<TGlobalOptions>>, TMappedValue>, ): Command< TParentCommandGlobals, TParentCommandTypes, TCommandOptions, TCommandArguments, MergeOptions<TFlags, TCommandGlobals, TMappedGlobalOptions>, TCommandTypes, TCommandGlobalTypes, TParentCommand >;
/** * Register an option. * * @param flags Flags string e.g: -h, --help, --manual <requiredArg:string> [optionalArg:number] [...restArgs:string] * @param desc Flag description. * @param opts Flag options or custom handler for processing flag value. */ public option< TFlags extends string, TOptions extends TypedOption< TFlags, TCommandOptions, Merge<TParentCommandTypes, Merge<TCommandGlobalTypes, TCommandTypes>>, undefined extends TConflicts ? TRequired : false, TDefaultValue >, TMappedOptions extends MapValue<TOptions, TMappedValue, TCollect>, TRequired extends OptionOptions["required"] = undefined, TCollect extends OptionOptions["collect"] = undefined, TConflicts extends OptionOptions["conflicts"] = undefined, const TDefaultValue = undefined, TMappedValue = undefined, >( flags: TFlags, desc: string, opts?: | Omit< OptionOptions< MergeOptions<TFlags, TCommandOptions, TMappedOptions>, TCommandArguments, TCommandGlobals, TParentCommandGlobals, TCommandTypes, TCommandGlobalTypes, TParentCommandTypes, TParentCommand >, "value" > & { default?: DefaultValue<TDefaultValue>; required?: TRequired; collect?: TCollect; conflicts?: TConflicts; value?: OptionValueHandler<MapTypes<ValueOf<TOptions>>, TMappedValue>; } | OptionValueHandler<MapTypes<ValueOf<TOptions>>, TMappedValue>, ): Command< TParentCommandGlobals, TParentCommandTypes, MergeOptions<TFlags, TCommandOptions, TMappedOptions>, TCommandArguments, TCommandGlobals, TCommandTypes, TCommandGlobalTypes, TParentCommand >;
public option( flags: string, desc: string, opts?: OptionOptions | OptionValueHandler, ): Command<any> { if (typeof opts === "function") { opts = { value: opts }; }
const result = splitArguments(flags);
const args: Argument[] = result.typeDefinition ? parseArgumentsDefinition(result.typeDefinition) : [];
const option: Option = { ...opts, name: "", description: desc, args, flags: result.flags, equalsSign: result.equalsSign, typeDefinition: result.typeDefinition, groupName: this._groupName ?? undefined, };
if (option.separator) { for (const arg of args) { if (arg.list) { arg.separator = option.separator; } } }
for (const part of option.flags) { const arg = part.trim(); const isLong = /^--/.test(arg); const name = isLong ? arg.slice(2) : arg.slice(1);
if (this.cmd.getBaseOption(name, true)) { if (opts?.override) { this.removeOption(name); } else { throw new DuplicateOptionNameError(name, this.getPath()); } }
if (!option.name && isLong) { option.name = name; } else if (!option.aliases) { option.aliases = [name]; } else { option.aliases.push(name); } }
if (option.prepend) { this.cmd.options.unshift(option); } else { this.cmd.options.push(option); }
return this; }
/** * Register command example. * * @param name Name of the example. * @param description The content of the example. */ public example(name: string, description: string): this { if (this.cmd.hasExample(name)) { throw new DuplicateExampleError(name); }
this.cmd.examples.push({ name, description });
return this; }
/** * @param flags Flags string e.g: -h, --help, --manual <requiredArg:string> [optionalArg:number] [...restArgs:string] * @param desc Flag description. * @param opts Flag options or custom handler for processing flag value. */
/** * Register a global environment variable. * * @param name Name of the environment variable. * @param description The description of the environment variable. * @param options Environment variable options. */ public globalEnv< TNameAndValue extends string, TGlobalEnvVars extends TypedEnv< TNameAndValue, TPrefix, TCommandOptions, Merge<TParentCommandTypes, Merge<TCommandGlobalTypes, TCommandTypes>>, TRequired >, TMappedGlobalEnvVars extends MapValue<TGlobalEnvVars, TMappedValue>, TRequired extends EnvVarOptions["required"] = undefined, TPrefix extends EnvVarOptions["prefix"] = undefined, TMappedValue = undefined, >( name: TNameAndValue, description: string, options?: Omit<GlobalEnvVarOptions, "value"> & { required?: TRequired; prefix?: TPrefix; value?: EnvVarValueHandler< MapTypes<ValueOf<TGlobalEnvVars>>, TMappedValue >; }, ): Command< TParentCommandGlobals, TParentCommandTypes, TCommandOptions, TCommandArguments, Merge<TCommandGlobals, TMappedGlobalEnvVars>, TCommandTypes, TCommandGlobalTypes, TParentCommand > { return this.env( name, description, { ...options, global: true } as EnvVarOptions, ) as Command<any>; }
/** * Register a global environment variable. * * @param name Name of the environment variable. * @param description The description of the environment variable. * @param options Environment variable options. */ public env< N extends string, G extends TypedEnv< N, P, TCommandOptions, Merge<TParentCommandTypes, Merge<TCommandGlobalTypes, TCommandTypes>>, R >, MG extends MapValue<G, V>, R extends EnvVarOptions["required"] = undefined, P extends EnvVarOptions["prefix"] = undefined, V = undefined, >( name: N, description: string, options: Omit<EnvVarOptions, "value"> & { global: true; required?: R; prefix?: P; value?: EnvVarValueHandler<MapTypes<ValueOf<G>>, V>; }, ): Command< TParentCommandGlobals, TParentCommandTypes, TCommandOptions, TCommandArguments, Merge<TCommandGlobals, MG>, TCommandTypes, TCommandGlobalTypes, TParentCommand >;
/** * Register an environment variable. * * @param name Name of the environment variable. * @param description The description of the environment variable. * @param options Environment variable options. */ public env< TNameAndValue extends string, TEnvVar extends TypedEnv< TNameAndValue, TPrefix, TCommandOptions, Merge<TParentCommandTypes, Merge<TCommandGlobalTypes, TCommandTypes>>, TRequired >, TMappedEnvVar extends MapValue<TEnvVar, TMappedValue>, TRequired extends EnvVarOptions["required"] = undefined, TPrefix extends EnvVarOptions["prefix"] = undefined, TMappedValue = undefined, >( name: TNameAndValue, description: string, options?: Omit<EnvVarOptions, "value"> & { required?: TRequired; prefix?: TPrefix; value?: EnvVarValueHandler<MapTypes<ValueOf<TEnvVar>>, TMappedValue>; }, ): Command< TParentCommandGlobals, TParentCommandTypes, Merge<TCommandOptions, TMappedEnvVar>, TCommandArguments, TCommandGlobals, TCommandTypes, TCommandGlobalTypes, TParentCommand >;
public env( name: string, description: string, options?: EnvVarOptions, ): Command<any> { const result = splitArguments(name);
if (!result.typeDefinition) { result.typeDefinition = "<value:boolean>"; }
if (result.flags.some((envName) => this.cmd.getBaseEnvVar(envName, true))) { throw new DuplicateEnvVarError(name); }
const details: Argument[] = parseArgumentsDefinition( result.typeDefinition, );
if (details.length > 1) { throw new TooManyEnvVarValuesError(name); } else if (details.length && details[0].optional) { throw new UnexpectedOptionalEnvVarValueError(name); } else if (details.length && details[0].variadic) { throw new UnexpectedVariadicEnvVarValueError(name); }
this.cmd.envVars.push({ name: result.flags[0], names: result.flags, description, type: details[0].type, details: details.shift() as Argument, ...options, });
return this; }
/***************************************************************************** **** MAIN HANDLER *********************************************************** *****************************************************************************/
/** * Parse command line arguments and execute matched command. * * @param args Command line args to parse. Ex: `cmd.parse( Deno.args )` */ public parse( args: string[] = Deno.args, ): Promise< TParentCommand extends Command<any> ? CommandResult< Record<string, unknown>, Array<unknown>, Record<string, unknown>, Record<string, unknown>, Record<string, unknown>, Record<string, unknown>, Record<string, unknown>, undefined > : CommandResult< MapTypes<TCommandOptions>, MapTypes<TCommandArguments>, MapTypes<TCommandGlobals>, MapTypes<TParentCommandGlobals>, TCommandTypes, TCommandGlobalTypes, TParentCommandTypes, TParentCommand > > { const ctx: ParseContext = { unknown: args.slice(), flags: {}, env: {}, literal: [], stopEarly: false, stopOnUnknown: false, defaults: {}, actions: [], }; return this.parseCommand(ctx) as any; }
private async parseCommand(ctx: ParseContext): Promise<CommandResult> { try { this.reset(); this.registerDefaults(); this.rawArgs = ctx.unknown.slice();
if (this._useRawArgs) { await this.parseEnvVars(ctx, this.envVars); return await this.execute(ctx.env, ctx.unknown); }
let preParseGlobals = false; let subCommand: Command<any> | undefined;
// Pre parse globals to support: cmd --global-option sub-command --option if (ctx.unknown.length > 0) { // Detect sub command. subCommand = this.getSubCommand(ctx);
if (!subCommand) { // Only pre parse globals if first arg ist a global option. const optionName = ctx.unknown[0].replace(/^-+/, ""); const option = this.getOption(optionName, true);
if (option?.global) { preParseGlobals = true; await this.parseGlobalOptionsAndEnvVars(ctx); } } }
if (subCommand || ctx.unknown.length > 0) { subCommand ??= this.getSubCommand(ctx);
if (subCommand) { subCommand._globalParent = this; return subCommand.parseCommand(ctx); } }
// Parse rest options & env vars. await this.parseOptionsAndEnvVars(ctx, preParseGlobals); const options = { ...ctx.env, ...ctx.flags }; const args = this.parseArguments(ctx, options); this.literalArgs = ctx.literal;
// Execute option action. if (ctx.actions.length) { await Promise.all( ctx.actions.map((action) => action.call(this, options, ...args)), );
if (ctx.standalone) { return { options, args, cmd: this, literal: this.literalArgs, }; } }
return await this.execute(options, args); } catch (error: unknown) { this.handleError(error); } }
private getSubCommand(ctx: ParseContext) { const subCommand = this.getCommand(ctx.unknown[0], true);
if (subCommand) { ctx.unknown.shift(); }
return subCommand; }
private async parseGlobalOptionsAndEnvVars( ctx: ParseContext, ): Promise<void> { const isHelpOption = this.getHelpOption()?.flags.includes(ctx.unknown[0]);
// Parse global env vars. const envVars = [ ...this.envVars.filter((envVar) => envVar.global), ...this.getGlobalEnvVars(true), ];
await this.parseEnvVars(ctx, envVars, !isHelpOption);
// Parse global options. const options = [ ...this.options.filter((option) => option.global), ...this.getGlobalOptions(true), ];
this.parseOptions(ctx, options, { stopEarly: true, stopOnUnknown: true, dotted: false, }); }
private async parseOptionsAndEnvVars( ctx: ParseContext, preParseGlobals: boolean, ): Promise<void> { const helpOption = this.getHelpOption(); const isVersionOption = this._versionOption?.flags.includes(ctx.unknown[0]); const isHelpOption = helpOption && ctx.flags?.[helpOption.name] === true;
// Parse env vars. const envVars = preParseGlobals ? this.envVars.filter((envVar) => !envVar.global) : this.getEnvVars(true);
await this.parseEnvVars( ctx, envVars, !isHelpOption && !isVersionOption, );
// Parse options. const options = this.getOptions(true);
this.parseOptions(ctx, options); }
/** Register default options like `--version` and `--help`. */ private registerDefaults(): this { if (this.hasDefaults || this.getParent()) { return this; } this.hasDefaults = true;
this.reset();
!this.types.has("string") && this.type("string", new StringType(), { global: true }); !this.types.has("number") && this.type("number", new NumberType(), { global: true }); !this.types.has("integer") && this.type("integer", new IntegerType(), { global: true }); !this.types.has("boolean") && this.type("boolean", new BooleanType(), { global: true }); !this.types.has("file") && this.type("file", new FileType(), { global: true });
if (!this._help) { this.help({}); }
if (this._versionOptions !== false && (this._versionOptions || this.ver)) { this.option( this._versionOptions?.flags || "-V, --version", this._versionOptions?.desc || "Show the version number for this program.", { standalone: true, prepend: true, action: async function () { const long = this.getRawArgs().includes( `--${this._versionOption?.name}`, ); if (long) { await checkVersion(this); this.showLongVersion(); } else { this.showVersion(); } this.exit(); }, ...(this._versionOptions?.opts ?? {}), }, ); this._versionOption = this.options[0]; }
if (this._helpOptions !== false) { this.option( this._helpOptions?.flags || "-h, --help", this._helpOptions?.desc || "Show this help.", { standalone: true, global: true, prepend: true, action: async function () { const long = this.getRawArgs().includes( `--${this.getHelpOption()?.name}`, ); await checkVersion(this); this.showHelp({ long }); this.exit(); }, ...(this._helpOptions?.opts ?? {}), }, ); this._helpOption = this.options[0]; }
return this; }
/** * Execute command. * @param options A map of options. * @param args Command arguments. */ private async execute( options: Record<string, unknown>, args: Array<unknown>, ): Promise<CommandResult> { if (this.defaultCommand) { const cmd = this.getCommand(this.defaultCommand, true);
if (!cmd) { throw new DefaultCommandNotFoundError( this.defaultCommand, this.getCommands(), ); } cmd._globalParent = this;
return cmd.execute(options, args); }
await this.executeGlobalAction(options, args);
if (this.actionHandler) { await this.actionHandler(options, ...args); }
return { options, args, cmd: this, literal: this.literalArgs, }; }
private async executeGlobalAction( options: Record<string, unknown>, args: Array<unknown>, ) { if (!this._noGlobals) { await this._parent?.executeGlobalAction(options, args); } await this.globalActionHandler?.(options, ...args); }
/** Parse raw command line arguments. */ protected parseOptions( ctx: ParseContext, options: Option[], { stopEarly = this._stopEarly, stopOnUnknown = false, dotted = true, }: ParseOptionsOptions = {}, ): void { parseFlags(ctx, { stopEarly, stopOnUnknown, dotted, allowEmpty: this._allowEmpty, flags: options, ignoreDefaults: ctx.env, parse: (type: ArgumentValue) => this.parseType(type), option: (option: Option) => { if (option.action) { ctx.actions.push(option.action); } }, }); }
/** Parse argument type. */ protected parseType(type: ArgumentValue): unknown { const typeSettings: TypeDef | undefined = this.getType(type.type);
if (!typeSettings) { throw new UnknownTypeError( type.type, this.getTypes().map((type) => type.name), ); }
return typeSettings.handler instanceof Type ? typeSettings.handler.parse(type) : typeSettings.handler(type); }
/** * Read and validate environment variables. * @param ctx Parse context. * @param envVars env vars defined by the command. * @param validate when true, throws an error if a required env var is missing. */ protected async parseEnvVars( ctx: ParseContext, envVars: Array<EnvVar>, validate = true, ): Promise<void> { for (const envVar of envVars) { const env = await this.findEnvVar(envVar.names);
if (env) { const parseType = (value: string) => { return this.parseType({ label: "Environment variable", type: envVar.type, name: env.name, value, }); };
const propertyName = underscoreToCamelCase( envVar.prefix ? envVar.names[0].replace(new RegExp(`^${envVar.prefix}`), "") : envVar.names[0], );
if (envVar.details.list) { ctx.env[propertyName] = env.value .split(envVar.details.separator ?? ",") .map(parseType); } else { ctx.env[propertyName] = parseType(env.value); }
if (envVar.value && typeof ctx.env[propertyName] !== "undefined") { ctx.env[propertyName] = envVar.value(ctx.env[propertyName]); } } else if (envVar.required && validate) { throw new MissingRequiredEnvVarError(envVar); } } }
protected async findEnvVar( names: readonly string[], ): Promise<{ name: string; value: string } | undefined> { for (const name of names) { const status = await Deno.permissions.query({ name: "env", variable: name, });
if (status.state === "granted") { const value = Deno.env.get(name);
if (value) { return { name, value }; } } }
return undefined; }
/** * Parse command-line arguments. * @param ctx Parse context. * @param options Parsed command line options. */ protected parseArguments( ctx: ParseContext, options: Record<string, unknown>, ): TCommandArguments { const params: Array<unknown> = []; const args = ctx.unknown.slice();
if (!this.hasArguments()) { if (args.length) { if (this.hasCommands(true)) { if (this.hasCommand(args[0], true)) { // e.g: command --global-foo --foo sub-command throw new TooManyArgumentsError(args); } else { throw new UnknownCommandError(args[0], this.getCommands()); } } else { throw new NoArgumentsAllowedError(this.getPath()); } } } else { if (!args.length) { const required = this.getArguments() .filter((expectedArg) => !expectedArg.optional) .map((expectedArg) => expectedArg.name);
if (required.length) { const optionNames: string[] = Object.keys(options); const hasStandaloneOption = !!optionNames.find((name) => this.getOption(name, true)?.standalone );
if (!hasStandaloneOption) { throw new MissingArgumentsError(required); } } } else { for (const expectedArg of this.getArguments()) { if (!args.length) { if (expectedArg.optional) { break; } throw new MissingArgumentError(expectedArg.name); }
let arg: unknown;
const parseArgValue = (value: string) => { return expectedArg.list ? value.split(",").map((value) => parseArgType(value)) : parseArgType(value); };
const parseArgType = (value: string) => { return this.parseType({ label: "Argument", type: expectedArg.type, name: expectedArg.name, value, }); };
if (expectedArg.variadic) { arg = args.splice(0, args.length).map((value) => parseArgValue(value) ); } else { arg = parseArgValue(args.shift() as string); }
if (expectedArg.variadic && Array.isArray(arg)) { params.push(...arg); } else if (typeof arg !== "undefined") { params.push(arg); } }
if (args.length) { throw new TooManyArgumentsError(args); } } }
return params as TCommandArguments; }
private handleError(error: unknown): never { this.throw( error instanceof FlagsValidationError ? new ValidationError(error.message) : error instanceof Error ? error : new Error(`[non-error-thrown] ${error}`), ); }
/** * Handle error. If `throwErrors` is enabled the error will be thrown, * otherwise a formatted error message will be printed and `Deno.exit(1)` * will be called. This will also trigger registered error handlers. * * @param error The error to handle. */ public throw(error: Error): never { if (error instanceof ValidationError) { error.cmd = this as unknown as Command; } this.getErrorHandler()?.(error, this as unknown as Command);
if (this.shouldThrowErrors() || !(error instanceof ValidationError)) { throw error; } this.showHelp();
console.error(red(` ${bold("error")}: ${error.message}\n`));
Deno.exit(error instanceof ValidationError ? error.exitCode : 1); }
/***************************************************************************** **** GETTER ***************************************************************** *****************************************************************************/
/** Get command name. */ public getName(): string { return this._name; }
/** Get parent command. */ public getParent(): TParentCommand { return this._parent as TParentCommand; }
/** * Get parent command from global executed command. * Be sure, to call this method only inside an action handler. Unless this or any child command was executed, * this method returns always undefined. */ public getGlobalParent(): Command<any> | undefined { return this._globalParent; }
/** Get main command. */ public getMainCommand(): Command<any> { return this._parent?.getMainCommand() ?? this; }
/** Get command name aliases. */ public getAliases(): string[] { return this.aliases; }
/** * Get full command path. * * @param name Override the main command name. */ public getPath(name?: string): string { return this._parent ? this._parent.getPath(name) + " " + this._name : name || this._name; }
/** Get arguments definition. E.g: <input-file:string> <output-file:string> */ public getArgsDefinition(): string | undefined { return this.argsDefinition; }
/** * Get argument by name. * * @param name Name of the argument. */ public getArgument(name: string): Argument | undefined { return this.getArguments().find((arg) => arg.name === name); }
/** Get arguments. */ public getArguments(): Argument[] { if (!this.args.length && this.argsDefinition) { this.args = parseArgumentsDefinition(this.argsDefinition); }
return this.args; }
/** Check if command has arguments. */ public hasArguments() { return !!this.argsDefinition; }
/** Get command version. */ public getVersion(): string | undefined { return this.getVersionHandler()?.call(this, this); }
/** Get help handler method. */ private getVersionHandler(): VersionHandler | undefined { return this.ver ?? this._parent?.getVersionHandler(); }
/** Get command description. */ public getDescription(): string { // call description method only once return typeof this.desc === "function" ? this.desc = this.desc() : this.desc; }
/** Get auto generated command usage. */ public getUsage() { return this._usage ?? [this.getArgsDefinition(), this.getRequiredOptionsDefinition()] .join(" ") .trim(); }
private getRequiredOptionsDefinition() { return this.getOptions() .filter((option) => option.required) .map((option) => [findFlag(option.flags), option.typeDefinition].filter((v) => v) .join(" ") .trim() ) .join(" "); }
/** Get short command description. This is the first line of the description. */ public getShortDescription(): string { return getDescription(this.getDescription(), true); }
/** Get original command-line arguments. */ public getRawArgs(): string[] { return this.rawArgs; }
/** Get all arguments defined after the double dash. */ public getLiteralArgs(): string[] { return this.literalArgs; }
/** Output generated help without exiting. */ public showVersion(): void { console.log(this.getVersion()); }
/** Returns command name, version and meta data. */ public getLongVersion(): string { return `${bold(this.getMainCommand().getName())} ${ brightBlue(this.getVersion() ?? "") }` + Object.entries(this.getMeta()).map( ([k, v]) => `\n${bold(k)} ${brightBlue(v)}`, ).join(""); }
/** Outputs command name, version and meta data. */ public showLongVersion(): void { console.log(this.getLongVersion()); }
/** Output generated help without exiting. */ public showHelp(options?: HelpOptions): void { console.log(this.getHelp(options)); }
/** Get generated help. */ public getHelp(options?: HelpOptions): string { this.registerDefaults(); return this.getHelpHandler().call(this, this, options ?? {}); }
/** Get help handler method. */ private getHelpHandler(): HelpHandler { return this._help ?? this._parent?.getHelpHandler() as HelpHandler; }
private exit(code = 0) { if (this.shouldExit()) { Deno.exit(code); } }
/***************************************************************************** **** Options GETTER ********************************************************* *****************************************************************************/
/** * Checks whether the command has options or not. * * @param hidden Include hidden options. */ public hasOptions(hidden?: boolean): boolean { return this.getOptions(hidden).length > 0; }
/** * Get options. * * @param hidden Include hidden options. */ public getOptions(hidden?: boolean): Option[] { return this.getGlobalOptions(hidden).concat(this.getBaseOptions(hidden)); }
/** * Get base options. * * @param hidden Include hidden options. */ public getBaseOptions(hidden?: boolean): Option[] { if (!this.options.length) { return []; }
return hidden ? this.options.slice(0) : this.options.filter((opt) => !opt.hidden); }
/** * Get global options. * * @param hidden Include hidden options. */ public getGlobalOptions(hidden?: boolean): Option[] { const helpOption = this.getHelpOption(); const getGlobals = ( cmd: Command<any>, noGlobals: boolean, options: Option[] = [], names: string[] = [], ): Option[] => { if (cmd.options.length) { for (const option of cmd.options) { if ( option.global && !this.options.find((opt) => opt.name === option.name) && names.indexOf(option.name) === -1 && (hidden || !option.hidden) ) { if (noGlobals && option !== helpOption) { continue; }
names.push(option.name); options.push(option); } } }
return cmd._parent ? getGlobals( cmd._parent, noGlobals || cmd._noGlobals, options, names, ) : options; };
return this._parent ? getGlobals(this._parent, this._noGlobals) : []; }
/** * Checks whether the command has an option with given name or not. * * @param name Name of the option. Must be in param-case. * @param hidden Include hidden options. */ public hasOption(name: string, hidden?: boolean): boolean { return !!this.getOption(name, hidden); }
/** * Get option by name. * * @param name Name of the option. Must be in param-case. * @param hidden Include hidden options. */ public getOption(name: string, hidden?: boolean): Option | undefined { return this.getBaseOption(name, hidden) ?? this.getGlobalOption(name, hidden); }
/** * Get base option by name. * * @param name Name of the option. Must be in param-case. * @param hidden Include hidden options. */ public getBaseOption(name: string, hidden?: boolean): Option | undefined { const option = this.options.find((option) => option.name === name || option.aliases?.includes(name) );
return option && (hidden || !option.hidden) ? option : undefined; }
/** * Get global option from parent commands by name. * * @param name Name of the option. Must be in param-case. * @param hidden Include hidden options. */ public getGlobalOption(name: string, hidden?: boolean): Option | undefined { const helpOption = this.getHelpOption(); const getGlobalOption = ( parent: Command, noGlobals: boolean, ): Option | undefined => { const option: Option | undefined = parent.getBaseOption( name, hidden, );
if (!option?.global) { return parent._parent && getGlobalOption( parent._parent, noGlobals || parent._noGlobals, ); } if (noGlobals && option !== helpOption) { return; }
return option; };
return this._parent && getGlobalOption( this._parent, this._noGlobals, ); }
/** * Remove option by name. * * @param name Name of the option. Must be in param-case. */ public removeOption(name: string): Option | undefined { const index = this.options.findIndex((option) => option.name === name);
if (index === -1) { return; }
return this.options.splice(index, 1)[0]; }
/** * Checks whether the command has sub-commands or not. * * @param hidden Include hidden commands. */ public hasCommands(hidden?: boolean): boolean { return this.getCommands(hidden).length > 0; }
/** * Get commands. * * @param hidden Include hidden commands. */ public getCommands(hidden?: boolean): Array<Command<any>> { return this.getGlobalCommands(hidden).concat(this.getBaseCommands(hidden)); }
/** * Get base commands. * * @param hidden Include hidden commands. */ public getBaseCommands(hidden?: boolean): Array<Command<any>> { const commands = Array.from(this.commands.values()); return hidden ? commands : commands.filter((cmd) => !cmd.isHidden); }
/** * Get global commands. * * @param hidden Include hidden commands. */ public getGlobalCommands(hidden?: boolean): Array<Command<any>> { const getCommands = ( command: Command<any>, noGlobals: boolean, commands: Array<Command<any>> = [], names: string[] = [], ): Array<Command<any>> => { if (command.commands.size) { for (const [_, cmd] of command.commands) { if ( cmd.isGlobal && this !== cmd && !this.commands.has(cmd._name) && names.indexOf(cmd._name) === -1 && (hidden || !cmd.isHidden) ) { if (noGlobals && cmd?.getName() !== "help") { continue; }
names.push(cmd._name); commands.push(cmd); } } }
return command._parent ? getCommands( command._parent, noGlobals || command._noGlobals, commands, names, ) : commands; };
return this._parent ? getCommands(this._parent, this._noGlobals) : []; }
/** * Checks whether a child command exists by given name or alias. * * @param name Name or alias of the command. * @param hidden Include hidden commands. */ public hasCommand(name: string, hidden?: boolean): boolean { return !!this.getCommand(name, hidden); }
/** * Get command by name or alias. * * @param name Name or alias of the command. * @param hidden Include hidden commands. */ public getCommand<TCommand extends Command<any>>( name: string, hidden?: boolean, ): TCommand | undefined { return this.getBaseCommand(name, hidden) ?? this.getGlobalCommand(name, hidden); }
/** * Get base command by name or alias. * * @param name Name or alias of the command. * @param hidden Include hidden commands. */ public getBaseCommand<TCommand extends Command<any>>( name: string, hidden?: boolean, ): TCommand | undefined { for (const cmd of this.commands.values()) { if (cmd._name === name || cmd.aliases.includes(name)) { return (cmd && (hidden || !cmd.isHidden) ? cmd : undefined) as | TCommand | undefined; } } }
/** * Get global command by name or alias. * * @param name Name or alias of the command. * @param hidden Include hidden commands. */ public getGlobalCommand<TCommand extends Command<any>>( name: string, hidden?: boolean, ): TCommand | undefined { const getGlobalCommand = ( parent: Command, noGlobals: boolean, ): Command | undefined => { const cmd: Command | undefined = parent.getBaseCommand(name, hidden);
if (!cmd?.isGlobal) { return parent._parent && getGlobalCommand(parent._parent, noGlobals || parent._noGlobals); } if (noGlobals && cmd.getName() !== "help") { return; }
return cmd; };
return this._parent && getGlobalCommand(this._parent, this._noGlobals) as TCommand; }
/** * Remove sub-command by name or alias. * * @param name Name or alias of the command. */ public removeCommand(name: string): Command<any> | undefined { const command = this.getBaseCommand(name, true);
if (command) { this.commands.delete(command._name); }
return command; }
/** Get types. */ public getTypes(): Array<TypeDef> { return this.getGlobalTypes().concat(this.getBaseTypes()); }
/** Get base types. */ public getBaseTypes(): Array<TypeDef> { return Array.from(this.types.values()); }
/** Get global types. */ public getGlobalTypes(): Array<TypeDef> { const getTypes = ( cmd: Command<any> | undefined, types: Array<TypeDef> = [], names: Array<string> = [], ): Array<TypeDef> => { if (cmd) { if (cmd.types.size) { cmd.types.forEach((type: TypeDef) => { if ( type.global && !this.types.has(type.name) && names.indexOf(type.name) === -1 ) { names.push(type.name); types.push(type); } }); }
return getTypes(cmd._parent, types, names); }
return types; };
return getTypes(this._parent); }
/** * Get type by name. * * @param name Name of the type. */ public getType(name: string): TypeDef | undefined { return this.getBaseType(name) ?? this.getGlobalType(name); }
/** * Get base type by name. * * @param name Name of the type. */ public getBaseType(name: string): TypeDef | undefined { return this.types.get(name); }
/** * Get global type by name. * * @param name Name of the type. */ public getGlobalType(name: string): TypeDef | undefined { if (!this._parent) { return; }
const cmd: TypeDef | undefined = this._parent.getBaseType(name);
if (!cmd?.global) { return this._parent.getGlobalType(name); }
return cmd; }
/** Get completions. */ public getCompletions() { return this.getGlobalCompletions().concat(this.getBaseCompletions()); }
/** Get base completions. */ public getBaseCompletions(): Completion[] { return Array.from(this.completions.values()); }
/** Get global completions. */ public getGlobalCompletions(): Completion[] { const getCompletions = ( cmd: Command<any> | undefined, completions: Completion[] = [], names: string[] = [], ): Completion[] => { if (cmd) { if (cmd.completions.size) { cmd.completions.forEach((completion: Completion) => { if ( completion.global && !this.completions.has(completion.name) && names.indexOf(completion.name) === -1 ) { names.push(completion.name); completions.push(completion); } }); }
return getCompletions(cmd._parent, completions, names); }
return completions; };
return getCompletions(this._parent); }
/** * Get completion by name. * * @param name Name of the completion. */ public getCompletion(name: string): Completion | undefined { return this.getBaseCompletion(name) ?? this.getGlobalCompletion(name); }
/** * Get base completion by name. * * @param name Name of the completion. */ public getBaseCompletion(name: string): Completion | undefined { return this.completions.get(name); }
/** * Get global completions by name. * * @param name Name of the completion. */ public getGlobalCompletion(name: string): Completion | undefined { if (!this._parent) { return; }
const completion: Completion | undefined = this._parent.getBaseCompletion( name, );
if (!completion?.global) { return this._parent.getGlobalCompletion(name); }
return completion; }
/** * Checks whether the command has environment variables or not. * * @param hidden Include hidden environment variable. */ public hasEnvVars(hidden?: boolean): boolean { return this.getEnvVars(hidden).length > 0; }
/** * Get environment variables. * * @param hidden Include hidden environment variable. */ public getEnvVars(hidden?: boolean): EnvVar[] { return this.getGlobalEnvVars(hidden).concat(this.getBaseEnvVars(hidden)); }
/** * Get base environment variables. * * @param hidden Include hidden environment variable. */ public getBaseEnvVars(hidden?: boolean): EnvVar[] { if (!this.envVars.length) { return []; }
return hidden ? this.envVars.slice(0) : this.envVars.filter((env) => !env.hidden); }
/** * Get global environment variables. * * @param hidden Include hidden environment variable. */ public getGlobalEnvVars(hidden?: boolean): EnvVar[] { if (this._noGlobals) { return []; }
const getEnvVars = ( cmd: Command<any> | undefined, envVars: EnvVar[] = [], names: string[] = [], ): EnvVar[] => { if (cmd) { if (cmd.envVars.length) { cmd.envVars.forEach((envVar: EnvVar) => { if ( envVar.global && !this.envVars.find((env) => env.names[0] === envVar.names[0]) && names.indexOf(envVar.names[0]) === -1 && (hidden || !envVar.hidden) ) { names.push(envVar.names[0]); envVars.push(envVar); } }); }
return getEnvVars(cmd._parent, envVars, names); }
return envVars; };
return getEnvVars(this._parent); }
/** * Checks whether the command has an environment variable with given name or not. * * @param name Name of the environment variable. * @param hidden Include hidden environment variable. */ public hasEnvVar(name: string, hidden?: boolean): boolean { return !!this.getEnvVar(name, hidden); }
/** * Get environment variable by name. * * @param name Name of the environment variable. * @param hidden Include hidden environment variable. */ public getEnvVar(name: string, hidden?: boolean): EnvVar | undefined { return this.getBaseEnvVar(name, hidden) ?? this.getGlobalEnvVar(name, hidden); }
/** * Get base environment variable by name. * * @param name Name of the environment variable. * @param hidden Include hidden environment variable. */ public getBaseEnvVar(name: string, hidden?: boolean): EnvVar | undefined { const envVar: EnvVar | undefined = this.envVars.find((env) => env.names.indexOf(name) !== -1 );
return envVar && (hidden || !envVar.hidden) ? envVar : undefined; }
/** * Get global environment variable by name. * * @param name Name of the environment variable. * @param hidden Include hidden environment variable. */ public getGlobalEnvVar(name: string, hidden?: boolean): EnvVar | undefined { if (!this._parent || this._noGlobals) { return; }
const envVar: EnvVar | undefined = this._parent.getBaseEnvVar( name, hidden, );
if (!envVar?.global) { return this._parent.getGlobalEnvVar(name, hidden); }
return envVar; }
/** Checks whether the command has examples or not. */ public hasExamples(): boolean { return this.examples.length > 0; }
/** Get all examples. */ public getExamples(): Example[] { return this.examples; }
/** Checks whether the command has an example with given name or not. */ public hasExample(name: string): boolean { return !!this.getExample(name); }
/** Get example with given name. */ public getExample(name: string): Example | undefined { return this.examples.find((example) => example.name === name); }
private getHelpOption(): Option | undefined { return this._helpOption ?? this._parent?.getHelpOption(); }}
function findFlag(flags: Array<string>): string { for (const flag of flags) { if (flag.startsWith("--")) { return flag; } } return flags[0];}
interface DefaultOption { flags: string; desc?: string; opts?: OptionOptions;}
interface ParseContext extends ParseFlagsContext<Record<string, unknown>> { actions: Array<ActionHandler>; env: Record<string, unknown>;}
interface ParseOptionsOptions { stopEarly?: boolean; stopOnUnknown?: boolean; dotted?: boolean;}