@villedemontreal/caporal 3.1.7

package/dist/src/types.d.ts

@@ -0,0 +1,396 @@
+/**
+ * List of Caporal type aliases.
+ *
+ * @packageDocumentation
+ * @module caporal/types
+ */
+import { Logger as WinstonLogger } from "winston";
+import { Program } from "./program";
+import { Command } from "./command";
+import { CommonError } from "./error";
+/**
+ * The Caporal logger interface. It extends the [Winston](https://github.com/winstonjs/winston) Logger interface
+ * and adds the following properties & methods.
+ * @noInheritDoc
+ */
+export interface Logger extends WinstonLogger {
+    /**
+     * Allow to force disabling colors.
+     */
+    disableColors(): void;
+    /**
+     * Tells Caporal if colors are enabled or not.
+     */
+    colorsEnabled: boolean;
+}
+export type GlobalOptions = Map<Option, Action | undefined>;
+/**
+ * Caporal-provided validator flags.
+ */
+export declare enum CaporalValidator {
+    /**
+     * Number validator. Check that the value looks like a numeric one
+     * and cast the provided value to a javascript `Number`.
+     */
+    NUMBER = 1,
+    /**
+     * Boolean validator. Check that the value looks like a boolean.
+     * It accepts values like `true`, `false`, `yes`, `no`, `0`, and `1`
+     * and will auto-cast those values to `true` or `false`.
+     */
+    BOOLEAN = 2,
+    /**
+     * String validator. Mainly used to make sure the value is a string,
+     * and prevent Caporal auto-casting of numerics values and boolean
+     * strings like `true` or `false`.
+     */
+    STRING = 4,
+    /**
+     * Array validator. Convert any provided value to an array. If a string is provided,
+     * this validator will try to split it by commas.
+     */
+    ARRAY = 8
+}
+type FunctionValidatorArgument = ParsedArgument | ParsedOption;
+export interface FunctionValidator<T = FunctionValidatorArgument> {
+    (value: T): Promisable<T>;
+}
+export type Validator = RegExp | FunctionValidator | CaporalValidator | ParserTypes[];
+/**
+ * @internal
+ */
+export interface ValidatorWrapper {
+    validate(value: ParsedArgument | ParsedOption): ParserTypes | ParserTypes[] | Promise<ParserTypes>;
+    getChoices(): ParserTypes[];
+}
+export interface OptionSynopsis {
+    name: string;
+    notation: string;
+    shortName?: string;
+    shortNotation?: string;
+    longName?: string;
+    longNotation?: string;
+    allNames: string[];
+    allNotations: string[];
+    synopsis: string;
+    valueRequired: boolean;
+    valueType?: OptionValueType;
+    variadic: boolean;
+}
+/**
+ * Option possible value.
+ *
+ */
+export declare enum OptionValueType {
+    /**
+     * Value is optional.
+     */
+    Optional = 0,
+    /**
+     * Value is required.
+     */
+    Required = 1,
+    /**
+     * Option does not have any possible value
+     */
+    None = 2
+}
+/**
+ * Option properties
+ */
+export interface CreateOptionCommandOpts {
+    /**
+     * Optional validator
+     */
+    validator?: Validator;
+    /**
+     * Default value for the Option
+     */
+    default?: ParsedOption;
+    /**
+     * Set the Option as itself required
+     */
+    required?: boolean;
+    /**
+     * Hide the option from help
+     */
+    hidden?: boolean;
+}
+/**
+ * Option properties
+ */
+export interface CreateOptionProgramOpts extends CreateOptionCommandOpts {
+    /**
+     * Set to `true` for a global option.
+     */
+    global?: boolean;
+    /**
+     * Action to call when a global-option is passed.
+     * Only available for global options, e.g. when `global` is set to `true`.
+     */
+    action?: Action;
+}
+export interface CreateArgumentOpts {
+    /**
+     * Argument validator.
+     */
+    validator?: Validator;
+    /**
+     * Argument default value.
+     */
+    default?: ParsedArgument;
+}
+export interface ArgumentSynopsis {
+    /**
+     * Argument name.
+     */
+    readonly name: string;
+    /**
+     * Boolean indicating if the argument is required.
+     */
+    readonly required: boolean;
+    /**
+     * Synopsis string.
+     */
+    readonly synopsis: string;
+    /**
+     * Boolean indicating if the argument is valiadic,
+     * e.g. can be repeated to contain an array of values.
+     */
+    readonly variadic: boolean;
+}
+export interface Argument extends ArgumentSynopsis {
+    readonly default?: ParsedArgument;
+    readonly description: string;
+    readonly choices: ParsedArgument[];
+    readonly validator?: Validator;
+    typeHint?: string;
+    kind: "argument";
+}
+export interface Option extends OptionSynopsis {
+    readonly boolean: boolean;
+    readonly default?: ParsedOption;
+    readonly description: string;
+    readonly choices: ParsedOption[];
+    readonly validator?: Validator;
+    readonly required: boolean;
+    readonly visible: boolean;
+    typeHint?: string;
+    kind: "option";
+}
+/**
+ * A type that could be wrapped in a Promise, or not
+ */
+export type Promisable<T> = T | Promise<T>;
+/**
+ * Parameters object passed to an {@link Action} function
+ */
+export interface ActionParameters {
+    /**
+     * Parsed command line arguments
+     */
+    args: ParsedArgumentsObject;
+    /**
+     * If the `dash` (double dash) config property is enabled,
+     * this *array* will contain all arguments present
+     * after '--'.
+     */
+    ddash: ParsedArguments;
+    /**
+     * Parsed command line options
+     */
+    options: ParsedOptions;
+    /**
+     * Program instance
+     */
+    program: Program;
+    /**
+     * Contextual command, if any
+     */
+    command?: Command;
+    /**
+     * Logger instance
+     */
+    logger: Logger;
+}
+/**
+ * An action is a function that will be executed upon a command call.
+ */
+export interface Action {
+    (params: ActionParameters): unknown;
+}
+export interface ErrorMetadata {
+    [meta: string]: unknown;
+}
+export type ParserTypes = string | number | boolean;
+/**
+ * Available options for the Caporal internal parser.
+ * Arguments must be referenced by their position (0-based) and options by their name (short or long)
+ * in {@link ParserOptions.boolean boolean}, {@link ParserOptions.string string}
+ * and {@link ParserOptions.variadic variadic} parser options.
+ *
+ */
+export interface ParserOptions {
+    /**
+     * List of {@link Argument Arguments} and {@link Options Options} to be casted as *booleans*.
+     * Arguments must be referenced by their position (0-based) and options by their name (short or long).
+     *
+     * **Example**
+     *
+     * ```ts
+     * import { parseArgv } from "caporal/parser"
+     *
+     * parseArgv({
+     *  boolean: [2, 'sendEmail']
+     * })
+     *
+     * // ./my-cli-app first-arg second-arg 3rd-arg --sendEmail=1
+     * // -> "3rd-arg" will be casted to boolean as well as "--sendEmail"
+     * ```
+     */
+    boolean: (string | number)[];
+    /**
+     * List of {@link Argument Arguments} and {@link Options Options} to be casted as *strings*.
+     * Arguments must be referenced by their position (0-based) and options by their name (short or long).
+     *
+     * **Example**
+     *
+     * ```ts
+     * import { parseArgv } from "caporal/parser"
+     *
+     * parseArgv({
+     *  string: [1]
+     * })
+     *
+     * // ./my-cli-app first-arg 2
+     * // -> second arg "2" will be casted to string instead of number
+     * ```
+     */
+    string: (string | number)[];
+    /**
+     * List of variadic {@link Argument Arguments} and {@link Options Options}, meaning
+     * that there value is an `Array`.
+     *
+     * Arguments must be referenced by their position (0-based) and options by their name (short or long).
+     *
+     * **Example**
+     *
+     * ```ts
+     * import { parseArgv } from "caporal/parser"
+     *
+     * parseArgv({
+     *  variadic: [1]
+     * })
+     *
+     * // ./pizza order margherita regina --add sausages --add basil
+     * {
+     *   args: ['order', ['margherita', 'regina']]
+     *   options: {
+     *     add: ['sausages', 'basil']
+     *   }
+     * }
+     * ```
+     */
+    variadic: (string | number)[];
+    /**
+     * Double-dash (--) handling mode. If `true`, the parser will populate the
+     * {@link ParserResult.ddash} property, otherwise, arguments will be added
+     * to {@link ParserResult.args}.
+     */
+    ddash: boolean;
+    /**
+     * Option aliases map.
+     */
+    alias: Record<string, string>;
+    /**
+     * Enable or disable autocasting of arguments and options. Default to `true`.
+     */
+    autoCast: boolean;
+}
+export type ParsedArgument = ParserTypes | ParserTypes[];
+export type ParsedArguments = ParsedArgument[];
+export interface ParsedArgumentsObject {
+    [arg: string]: ParsedArgument;
+}
+export type ParsedOption = ParserTypes | ParserTypes[];
+export interface ParsedOptions {
+    [opt: string]: ParsedOption;
+}
+/**
+ * @internal
+ */
+export interface ArgumentsRange {
+    min: number;
+    max: number;
+}
+export interface ParserResult {
+    args: ParsedArguments;
+    options: ParsedOptions;
+    rawOptions: ParsedOptions;
+    line: string;
+    rawArgv: string[];
+    ddash: ParsedArguments;
+}
+export interface ParserProcessedResult extends Omit<ParserResult, "args"> {
+    args: ParsedArgumentsObject;
+    errors: CommonError[];
+}
+export interface CreateCommandParameters {
+    program: Program;
+    createCommand(description?: string): Command;
+}
+export interface CommandCreator {
+    (options: CreateCommandParameters): Command;
+}
+/**
+ * Available configuration properties for the program.
+ */
+export type ProgramConfig = {
+    /**
+     * Strict checking of arguments count. If enabled, any additional argument willl trigger an error.
+     * Default to `true`.
+     */
+    strictArgsCount: boolean;
+    /**
+     * Strict checking of options provided. If enabled, any unknown option will trigger an error.
+     * Default to `true`.
+     */
+    strictOptions: boolean;
+    /**
+     * Auto-casting of arguments and options.
+     * Default to `true`.
+     */
+    autoCast: boolean;
+    /**
+     * Environment variable to check for log level override.
+     * Default to "CAPORAL_LOG_LEVEL".
+     */
+    logLevelEnvVar: string;
+};
+export type CommandConfig = {
+    /**
+     * Strict checking of arguments count. If enabled, any additional argument willl trigger an error.
+     */
+    strictArgsCount?: boolean;
+    /**
+     * Strict checking of options provided. If enabled, any unknown option will trigger an error.
+     */
+    strictOptions?: boolean;
+    /**
+     * Auto-casting of arguments and options.
+     */
+    autoCast?: boolean;
+    /**
+     * Visibility of the command in help.
+     */
+    visible: boolean;
+};
+export type BaseConfig = Record<string, boolean | string>;
+export interface Configurator<T extends BaseConfig> {
+    get<K extends keyof T>(key: K): T[K];
+    getAll(): T;
+    set(props: Partial<T>): T;
+    reset(): T;
+}
+export {};
+//# sourceMappingURL=types.d.ts.map

package/dist/src/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,MAAM,IAAI,aAAa,EAAE,MAAM,SAAS,CAAA;AACjD,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AACnC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AACnC,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AAErC;;;;GAIG;AACH,MAAM,WAAW,MAAO,SAAQ,aAAa;IAC3C;;OAEG;IACH,aAAa,IAAI,IAAI,CAAA;IACrB;;OAEG;IACH,aAAa,EAAE,OAAO,CAAA;CACvB;AAED,MAAM,MAAM,aAAa,GAAG,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAA;AAE3D;;GAEG;AACH,oBAAY,gBAAgB;IAC1B;;;OAGG;IACH,MAAM,IAAI;IACV;;;;OAIG;IACH,OAAO,IAAI;IACX;;;;OAIG;IACH,MAAM,IAAI;IACV;;;OAGG;IACH,KAAK,IAAI;CACV;AAED,KAAK,yBAAyB,GAAG,cAAc,GAAG,YAAY,CAAA;AAM9D,MAAM,WAAW,iBAAiB,CAAC,CAAC,GAAG,yBAAyB;IAC9D,CAAC,KAAK,EAAE,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAA;CAC1B;AAID,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,iBAAiB,GAAG,gBAAgB,GAAG,WAAW,EAAE,CAAA;AAErF;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CACN,KAAK,EAAE,cAAc,GAAG,YAAY,GACnC,WAAW,GAAG,WAAW,EAAE,GAAG,OAAO,CAAC,WAAW,CAAC,CAAA;IACrD,UAAU,IAAI,WAAW,EAAE,CAAA;CAC5B;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,QAAQ,EAAE,MAAM,EAAE,CAAA;IAClB,YAAY,EAAE,MAAM,EAAE,CAAA;IACtB,QAAQ,EAAE,MAAM,CAAA;IAChB,aAAa,EAAE,OAAO,CAAA;IACtB,SAAS,CAAC,EAAE,eAAe,CAAA;IAC3B,QAAQ,EAAE,OAAO,CAAA;CAClB;AAED;;;GAGG;AACH,oBAAY,eAAe;IACzB;;OAEG;IACH,QAAQ,IAAA;IACR;;OAEG;IACH,QAAQ,IAAA;IACR;;OAEG;IACH,IAAI,IAAA;CACL;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,SAAS,CAAC,EAAE,SAAS,CAAA;IACrB;;OAEG;IACH,OAAO,CAAC,EAAE,YAAY,CAAA;IACtB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,uBAAuB;IACtE;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,SAAS,CAAC,EAAE,SAAS,CAAA;IACrB;;OAEG;IACH,OAAO,CAAC,EAAE,cAAc,CAAA;CACzB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAA;IAC1B;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB;;;OAGG;IACH,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAA;CAC3B;AAED,MAAM,WAAW,QAAS,SAAQ,gBAAgB;IAChD,QAAQ,CAAC,OAAO,CAAC,EAAE,cAAc,CAAA;IACjC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;IAC5B,QAAQ,CAAC,OAAO,EAAE,cAAc,EAAE,CAAA;IAClC,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAA;IAC9B,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,UAAU,CAAA;CACjB;AAED,MAAM,WAAW,MAAO,SAAQ,cAAc;IAC5C,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;IACzB,QAAQ,CAAC,OAAO,CAAC,EAAE,YAAY,CAAA;IAC/B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;IAC5B,QAAQ,CAAC,OAAO,EAAE,YAAY,EAAE,CAAA;IAChC,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAA;IAC9B,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAA;IAC1B,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,QAAQ,CAAA;CACf;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;AAE1C;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,EAAE,qBAAqB,CAAA;IAC3B;;;;OAIG;IACH,KAAK,EAAE,eAAe,CAAA;IACtB;;OAEG;IACH,OAAO,EAAE,aAAa,CAAA;IACtB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAA;IAChB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;CACf;AAED;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB,CAAC,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAA;CACpC;AAED,MAAM,WAAW,aAAa;IAC5B,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAA;CACxB;AAED,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAA;AAEnD;;;;;;GAMG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;;;;;;;;;;;;;OAgBG;IACH,OAAO,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAA;IAC5B;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAA;IAC3B;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,QAAQ,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAA;IAC7B;;;;OAIG;IACH,KAAK,EAAE,OAAO,CAAA;IACd;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC7B;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAA;CAClB;AAED,MAAM,MAAM,cAAc,GAAG,WAAW,GAAG,WAAW,EAAE,CAAA;AACxD,MAAM,MAAM,eAAe,GAAG,cAAc,EAAE,CAAA;AAC9C,MAAM,WAAW,qBAAqB;IACpC,CAAC,GAAG,EAAE,MAAM,GAAG,cAAc,CAAA;CAC9B;AAED,MAAM,MAAM,YAAY,GAAG,WAAW,GAAG,WAAW,EAAE,CAAA;AACtD,MAAM,WAAW,aAAa;IAC5B,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY,CAAA;CAC5B;AACD;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,GAAG,EAAE,MAAM,CAAA;IACX,GAAG,EAAE,MAAM,CAAA;CACZ;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,eAAe,CAAA;IACrB,OAAO,EAAE,aAAa,CAAA;IACtB,UAAU,EAAE,aAAa,CAAA;IACzB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,KAAK,EAAE,eAAe,CAAA;CACvB;AAED,MAAM,WAAW,qBAAsB,SAAQ,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC;IACvE,IAAI,EAAE,qBAAqB,CAAA;IAC3B,MAAM,EAAE,WAAW,EAAE,CAAA;CACtB;AAED,MAAM,WAAW,uBAAuB;IACtC,OAAO,EAAE,OAAO,CAAA;IAChB,aAAa,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;CAC7C;AACD,MAAM,WAAW,cAAc;IAC7B,CAAC,OAAO,EAAE,uBAAuB,GAAG,OAAO,CAAA;CAC5C;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B;;;OAGG;IACH,eAAe,EAAE,OAAO,CAAA;IACxB;;;OAGG;IACH,aAAa,EAAE,OAAO,CAAA;IACtB;;;OAGG;IACH,QAAQ,EAAE,OAAO,CAAA;IACjB;;;OAGG;IACH,cAAc,EAAE,MAAM,CAAA;CACvB,CAAA;AACD,MAAM,MAAM,aAAa,GAAG;IAC1B;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,CAAC,CAAA;AAEzD,MAAM,WAAW,YAAY,CAAC,CAAC,SAAS,UAAU;IAChD,GAAG,CAAC,CAAC,SAAS,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;IACpC,MAAM,IAAI,CAAC,CAAA;IACX,GAAG,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;IACzB,KAAK,IAAI,CAAC,CAAA;CACX"}

package/dist/src/types.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OptionValueType = exports.CaporalValidator = void 0;
+/**
+ * Caporal-provided validator flags.
+ */
+var CaporalValidator;
+(function (CaporalValidator) {
+    /**
+     * Number validator. Check that the value looks like a numeric one
+     * and cast the provided value to a javascript `Number`.
+     */
+    CaporalValidator[CaporalValidator["NUMBER"] = 1] = "NUMBER";
+    /**
+     * Boolean validator. Check that the value looks like a boolean.
+     * It accepts values like `true`, `false`, `yes`, `no`, `0`, and `1`
+     * and will auto-cast those values to `true` or `false`.
+     */
+    CaporalValidator[CaporalValidator["BOOLEAN"] = 2] = "BOOLEAN";
+    /**
+     * String validator. Mainly used to make sure the value is a string,
+     * and prevent Caporal auto-casting of numerics values and boolean
+     * strings like `true` or `false`.
+     */
+    CaporalValidator[CaporalValidator["STRING"] = 4] = "STRING";
+    /**
+     * Array validator. Convert any provided value to an array. If a string is provided,
+     * this validator will try to split it by commas.
+     */
+    CaporalValidator[CaporalValidator["ARRAY"] = 8] = "ARRAY";
+})(CaporalValidator || (exports.CaporalValidator = CaporalValidator = {}));
+/**
+ * Option possible value.
+ *
+ */
+var OptionValueType;
+(function (OptionValueType) {
+    /**
+     * Value is optional.
+     */
+    OptionValueType[OptionValueType["Optional"] = 0] = "Optional";
+    /**
+     * Value is required.
+     */
+    OptionValueType[OptionValueType["Required"] = 1] = "Required";
+    /**
+     * Option does not have any possible value
+     */
+    OptionValueType[OptionValueType["None"] = 2] = "None";
+})(OptionValueType || (exports.OptionValueType = OptionValueType = {}));
+//# sourceMappingURL=types.js.map

package/dist/src/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":";;;AA8BA;;GAEG;AACH,IAAY,gBAuBX;AAvBD,WAAY,gBAAgB;IAC1B;;;OAGG;IACH,2DAAU,CAAA;IACV;;;;OAIG;IACH,6DAAW,CAAA;IACX;;;;OAIG;IACH,2DAAU,CAAA;IACV;;;OAGG;IACH,yDAAS,CAAA;AACX,CAAC,EAvBW,gBAAgB,gCAAhB,gBAAgB,QAuB3B;AAyCD;;;GAGG;AACH,IAAY,eAaX;AAbD,WAAY,eAAe;IACzB;;OAEG;IACH,6DAAQ,CAAA;IACR;;OAEG;IACH,6DAAQ,CAAA;IACR;;OAEG;IACH,qDAAI,CAAA;AACN,CAAC,EAbW,eAAe,+BAAf,eAAe,QAa1B"}

package/dist/src/utils/__tests__/fs.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=fs.spec.d.ts.map

package/dist/src/utils/__tests__/fs.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fs.spec.d.ts","sourceRoot":"","sources":["../../../../src/utils/__tests__/fs.spec.ts"],"names":[],"mappings":""}

package/dist/src/utils/__tests__/fs.spec.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs_1 = require("../fs");
+const vitest_1 = require("vitest");
+(0, vitest_1.describe)("readdir()", () => {
+    (0, vitest_1.it)("should resolve to a file list on success", async () => {
+        const files = await (0, fs_1.readdir)(__dirname);
+        return (0, vitest_1.expect)(files.sort()).toEqual(["fs.spec.ts", "levenshtein.spec.ts", "suggest.spec.ts"].sort());
+    });
+    (0, vitest_1.it)("should reject if directory does note exist", () => {
+        return (0, vitest_1.expect)((0, fs_1.readdir)("/does/not/exist")).rejects.toBeInstanceOf(Error);
+    });
+});
+//# sourceMappingURL=fs.spec.js.map

package/dist/src/utils/__tests__/fs.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fs.spec.js","sourceRoot":"","sources":["../../../../src/utils/__tests__/fs.spec.ts"],"names":[],"mappings":";;AAAA,8BAA+B;AAC/B,mCAA6C;AAE7C,IAAA,iBAAQ,EAAC,WAAW,EAAE,GAAG,EAAE;IACzB,IAAA,WAAE,EAAC,0CAA0C,EAAE,KAAK,IAAI,EAAE;QACxD,MAAM,KAAK,GAAG,MAAM,IAAA,YAAO,EAAC,SAAS,CAAC,CAAA;QACtC,OAAO,IAAA,eAAM,EAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CACjC,CAAC,YAAY,EAAE,qBAAqB,EAAE,iBAAiB,CAAC,CAAC,IAAI,EAAE,CAChE,CAAA;IACH,CAAC,CAAC,CAAA;IACF,IAAA,WAAE,EAAC,4CAA4C,EAAE,GAAG,EAAE;QACpD,OAAO,IAAA,eAAM,EAAC,IAAA,YAAO,EAAC,iBAAiB,CAAC,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,KAAK,CAAC,CAAA;IACzE,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

package/dist/src/utils/__tests__/levenshtein.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=levenshtein.spec.d.ts.map

package/dist/src/utils/__tests__/levenshtein.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"levenshtein.spec.d.ts","sourceRoot":"","sources":["../../../../src/utils/__tests__/levenshtein.spec.ts"],"names":[],"mappings":""}

package/dist/src/utils/__tests__/levenshtein.spec.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const levenshtein_1 = require("../levenshtein");
+const vitest_1 = require("vitest");
+(0, vitest_1.describe)("levenshtein", () => {
+    vitest_1.it.each([
+        ["hello", "bye", 5],
+        ["some", "sometimes", 5],
+        ["john", "jane", 3],
+        ["exemple", "example", 1],
+        ["", "", 0],
+        ["not-empty", "", 9],
+        ["", "not-empty", 9],
+    ])(".levenshtein('%s', '%s')", (a, b, expected) => {
+        (0, vitest_1.expect)((0, levenshtein_1.levenshtein)(a, b)).toBe(expected);
+    });
+});
+//# sourceMappingURL=levenshtein.spec.js.map

package/dist/src/utils/__tests__/levenshtein.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"levenshtein.spec.js","sourceRoot":"","sources":["../../../../src/utils/__tests__/levenshtein.spec.ts"],"names":[],"mappings":";;AAAA,gDAA4C;AAC5C,mCAA6C;AAE7C,IAAA,iBAAQ,EAAC,aAAa,EAAE,GAAG,EAAE;IAC3B,WAAE,CAAC,IAAI,CAAC;QACN,CAAC,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;QACnB,CAAC,MAAM,EAAE,WAAW,EAAE,CAAC,CAAC;QACxB,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;QACnB,CAAC,SAAS,EAAE,SAAS,EAAE,CAAC,CAAC;QACzB,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;QACX,CAAC,WAAW,EAAE,EAAE,EAAE,CAAC,CAAC;QACpB,CAAC,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC;KACrB,CAAC,CAAC,0BAA0B,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,QAAQ,EAAE,EAAE;QAChD,IAAA,eAAM,EAAC,IAAA,yBAAW,EAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;IAC1C,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

package/dist/src/utils/__tests__/suggest.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=suggest.spec.d.ts.map

package/dist/src/utils/__tests__/suggest.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"suggest.spec.d.ts","sourceRoot":"","sources":["../../../../src/utils/__tests__/suggest.spec.ts"],"names":[],"mappings":""}

package/dist/src/utils/__tests__/suggest.spec.js

@@ -0,0 +1,31 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const suggest_1 = require("../suggest");
+const chalk_1 = __importDefault(require("chalk"));
+const vitest_1 = require("vitest");
+(0, vitest_1.describe)("Suggest", () => {
+    (0, vitest_1.describe)("getSuggestions()", () => {
+        (0, vitest_1.it)("should return proper suggestions", () => {
+            const suggestions = (0, suggest_1.getSuggestions)("foo", ["foa", "foab", "foabc", "afoo", "bfoap"]);
+            (0, vitest_1.expect)(suggestions).toStrictEqual(["foa", "afoo", "foab"]);
+        });
+    });
+    (0, vitest_1.describe)("boldDiffString()", () => {
+        (0, vitest_1.it)("should make the diff bold at the end of the word", () => {
+            (0, vitest_1.expect)((0, suggest_1.boldDiffString)("foo", "foob")).toEqual("foo" + chalk_1.default.bold.greenBright("b"));
+        });
+        (0, vitest_1.it)("should make the diff bold at the beginning of the word", () => {
+            (0, vitest_1.expect)((0, suggest_1.boldDiffString)("foo", "doo")).toBe(chalk_1.default.bold.greenBright("d") + "oo");
+        });
+        (0, vitest_1.it)("should make the diff bold at the middle of the word", () => {
+            (0, vitest_1.expect)((0, suggest_1.boldDiffString)("foo", "fao")).toBe("f" + chalk_1.default.bold.greenBright("a") + "o");
+        });
+        (0, vitest_1.it)("should make the diff bold anywhere in the word", () => {
+            (0, vitest_1.expect)((0, suggest_1.boldDiffString)("minimum", "maximum")).toBe("m" + chalk_1.default.bold.greenBright("a") + chalk_1.default.bold.greenBright("x") + "imum");
+        });
+    });
+});
+//# sourceMappingURL=suggest.spec.js.map

package/dist/src/utils/__tests__/suggest.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"suggest.spec.js","sourceRoot":"","sources":["../../../../src/utils/__tests__/suggest.spec.ts"],"names":[],"mappings":";;;;;AAAA,wCAA2D;AAC3D,kDAAqB;AACrB,mCAA6C;AAE7C,IAAA,iBAAQ,EAAC,SAAS,EAAE,GAAG,EAAE;IACvB,IAAA,iBAAQ,EAAC,kBAAkB,EAAE,GAAG,EAAE;QAChC,IAAA,WAAE,EAAC,kCAAkC,EAAE,GAAG,EAAE;YAC1C,MAAM,WAAW,GAAG,IAAA,wBAAc,EAAC,KAAK,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;YACpF,IAAA,eAAM,EAAC,WAAW,CAAC,CAAC,aAAa,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;QAC5D,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IACF,IAAA,iBAAQ,EAAC,kBAAkB,EAAE,GAAG,EAAE;QAChC,IAAA,WAAE,EAAC,kDAAkD,EAAE,GAAG,EAAE;YAC1D,IAAA,eAAM,EAAC,IAAA,wBAAc,EAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,GAAG,eAAC,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAA;QAChF,CAAC,CAAC,CAAA;QACF,IAAA,WAAE,EAAC,wDAAwD,EAAE,GAAG,EAAE;YAChE,IAAA,eAAM,EAAC,IAAA,wBAAc,EAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,eAAC,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAA;QAC3E,CAAC,CAAC,CAAA;QAEF,IAAA,WAAE,EAAC,qDAAqD,EAAE,GAAG,EAAE;YAC7D,IAAA,eAAM,EAAC,IAAA,wBAAc,EAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,GAAG,eAAC,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,CAAA;QAChF,CAAC,CAAC,CAAA;QAEF,IAAA,WAAE,EAAC,gDAAgD,EAAE,GAAG,EAAE;YACxD,IAAA,eAAM,EAAC,IAAA,wBAAc,EAAC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,IAAI,CAC/C,GAAG,GAAG,eAAC,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,eAAC,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,MAAM,CACjE,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

package/dist/src/utils/colorize.d.ts

@@ -0,0 +1,2 @@
+export declare function colorize(text: string): string;
+//# sourceMappingURL=colorize.d.ts.map

package/dist/src/utils/colorize.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"colorize.d.ts","sourceRoot":"","sources":["../../../src/utils/colorize.ts"],"names":[],"mappings":"AAMA,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAc7C"}

package/dist/src/utils/colorize.js

@@ -0,0 +1,27 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.colorize = colorize;
+/**
+ * @packageDocumentation
+ * @internal
+ */
+const chalk_1 = __importDefault(require("chalk"));
+function colorize(text) {
+    return text
+        .replace(/<([^>]+)>/gi, (match) => {
+        return chalk_1.default.hex("#569cd6")(match);
+    })
+        .replace(/<command>/gi, (match) => {
+        return chalk_1.default.hex("#ff9900")(match);
+    })
+        .replace(/\[([^[\]]+)\]/gi, (match) => {
+        return chalk_1.default.hex("#aaa")(match);
+    })
+        .replace(/ --?([^\s,]+)/gi, (match) => {
+        return chalk_1.default.green(match);
+    });
+}
+//# sourceMappingURL=colorize.js.map

package/dist/src/utils/colorize.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"colorize.js","sourceRoot":"","sources":["../../../src/utils/colorize.ts"],"names":[],"mappings":";;;;;AAMA,4BAcC;AApBD;;;GAGG;AACH,kDAAqB;AAErB,SAAgB,QAAQ,CAAC,IAAY;IACnC,OAAO,IAAI;SACR,OAAO,CAAC,aAAa,EAAE,CAAC,KAAK,EAAE,EAAE;QAChC,OAAO,eAAC,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,CAAA;IAChC,CAAC,CAAC;SACD,OAAO,CAAC,aAAa,EAAE,CAAC,KAAK,EAAE,EAAE;QAChC,OAAO,eAAC,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,CAAA;IAChC,CAAC,CAAC;SACD,OAAO,CAAC,iBAAiB,EAAE,CAAC,KAAK,EAAE,EAAE;QACpC,OAAO,eAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,CAAA;IAC7B,CAAC,CAAC;SACD,OAAO,CAAC,iBAAiB,EAAE,CAAC,KAAK,EAAE,EAAE;QACpC,OAAO,eAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;IACvB,CAAC,CAAC,CAAA;AACN,CAAC"}

package/dist/src/utils/fs.d.ts

@@ -0,0 +1,2 @@
+export declare function readdir(dirPath: string, extensions?: string): Promise<string[]>;
+//# sourceMappingURL=fs.d.ts.map

package/dist/src/utils/fs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fs.d.ts","sourceRoot":"","sources":["../../../src/utils/fs.ts"],"names":[],"mappings":"AAOA,wBAAgB,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,SAAU,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAKhF"}

package/dist/src/utils/fs.js

@@ -0,0 +1,19 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readdir = readdir;
+/**
+ * @packageDocumentation
+ * @internal
+ */
+const glob_1 = require("glob");
+const fs_1 = __importDefault(require("fs"));
+function readdir(dirPath, extensions = "js,ts") {
+    if (!fs_1.default.existsSync(dirPath)) {
+        return Promise.reject(new Error(`'${dirPath}' does not exist!`));
+    }
+    return (0, glob_1.glob)(`**/*.{${extensions}}`, { cwd: dirPath });
+}
+//# sourceMappingURL=fs.js.map

package/dist/src/utils/fs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fs.js","sourceRoot":"","sources":["../../../src/utils/fs.ts"],"names":[],"mappings":";;;;;AAOA,0BAKC;AAZD;;;GAGG;AACH,+BAA2B;AAC3B,4CAAmB;AAEnB,SAAgB,OAAO,CAAC,OAAe,EAAE,UAAU,GAAG,OAAO;IAC3D,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;QAC5B,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,IAAI,OAAO,mBAAmB,CAAC,CAAC,CAAA;IAClE,CAAC;IACD,OAAO,IAAA,WAAI,EAAC,SAAS,UAAU,GAAG,EAAE,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAAA;AACvD,CAAC"}

package/dist/src/utils/levenshtein.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @packageDocumentation
+ * @internal
+ */
+export declare function levenshtein(a: string, b: string): number;
+//# sourceMappingURL=levenshtein.d.ts.map

package/dist/src/utils/levenshtein.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"levenshtein.d.ts","sourceRoot":"","sources":["../../../src/utils/levenshtein.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAuBxD"}