@jakubmazanec/args 1.0.0-de51f16

package/src/types/OptionConfig.ts

@@ -0,0 +1,279 @@
+/* eslint-disable @typescript-eslint/sort-type-constituents -- sorting hurts readability in this case */
+
+import {type ShortOptionName} from './ShortOptionName.js';
+
+export type BooleanOptionConfig =
+  | {
+      shortName?: ShortOptionName | undefined;
+      description?: string | undefined;
+
+      type: 'boolean';
+      multiple?: false | undefined;
+      count?: false | undefined;
+      defaultValue?: undefined;
+      required?: false | undefined;
+      validate?: ((value: boolean) => void) | undefined;
+    }
+  | {
+      shortName?: ShortOptionName | undefined;
+      description?: string | undefined;
+
+      type: 'boolean';
+      multiple?: false | undefined;
+      count?: false | undefined;
+      defaultValue: boolean;
+      required?: false | undefined;
+      validate?: ((value: boolean) => void) | undefined;
+    }
+  | {
+      shortName?: ShortOptionName | undefined;
+      description?: string | undefined;
+
+      type: 'boolean';
+      multiple?: false | undefined;
+      count?: false | undefined;
+      defaultValue?: undefined;
+      required: true;
+      validate?: ((value: boolean) => void) | undefined;
+    };
+
+export type BooleansOptionConfig =
+  | {
+      shortName?: ShortOptionName | undefined;
+      description?: string | undefined;
+
+      type: 'boolean';
+      multiple: true;
+      count?: false | undefined;
+      defaultValue?: undefined;
+      required?: false | undefined;
+      arity?: number | undefined;
+      validate?: ((value: boolean[]) => void) | undefined;
+    }
+  | {
+      shortName?: ShortOptionName | undefined;
+      description?: string | undefined;
+
+      type: 'boolean';
+      multiple: true;
+      count?: false | undefined;
+      defaultValue: readonly boolean[];
+      required?: false | undefined;
+      arity?: number | undefined;
+      validate?: ((value: boolean[]) => void) | undefined;
+    }
+  | {
+      shortName?: ShortOptionName | undefined;
+      description?: string | undefined;
+
+      type: 'boolean';
+      multiple: true;
+      count?: false | undefined;
+      defaultValue?: undefined;
+      required: true;
+      arity?: number | undefined;
+      validate?: ((value: boolean[]) => void) | undefined;
+    };
+
+export type NumberOptionConfig =
+  | {
+      shortName?: ShortOptionName | undefined;
+      description?: string | undefined;
+
+      type: 'number';
+      multiple?: false | undefined;
+      count?: false | undefined;
+      defaultValue?: undefined;
+      required?: false | undefined;
+      choices?: readonly number[] | undefined;
+      validate?: ((value: number) => void) | undefined;
+    }
+  | {
+      shortName?: ShortOptionName | undefined;
+      description?: string | undefined;
+
+      type: 'number';
+      multiple?: false | undefined;
+      count?: false | undefined;
+      defaultValue: number;
+      required?: false | undefined;
+      choices?: readonly number[] | undefined;
+      validate?: ((value: number) => void) | undefined;
+    }
+  | {
+      shortName?: ShortOptionName | undefined;
+      description?: string | undefined;
+
+      type: 'number';
+      multiple?: false | undefined;
+      count?: false | undefined;
+      defaultValue?: undefined;
+      required: true;
+      choices?: readonly number[] | undefined;
+      validate?: ((value: number) => void) | undefined;
+    };
+
+export type NumbersOptionConfig =
+  | {
+      shortName?: ShortOptionName | undefined;
+      description?: string | undefined;
+
+      type: 'number';
+      multiple: true;
+      count?: false | undefined;
+      choices?: readonly number[] | undefined;
+      defaultValue?: undefined;
+      required?: false | undefined;
+      arity?: number | undefined;
+      validate?: ((value: number[]) => void) | undefined;
+    }
+  | {
+      shortName?: ShortOptionName | undefined;
+      description?: string | undefined;
+
+      type: 'number';
+      multiple: true;
+      count?: false | undefined;
+      choices?: readonly number[] | undefined;
+      defaultValue: readonly number[];
+      required?: false | undefined;
+      arity?: number | undefined;
+      validate?: ((value: number[]) => void) | undefined;
+    }
+  | {
+      shortName?: ShortOptionName | undefined;
+      description?: string | undefined;
+
+      type: 'number';
+      multiple: true;
+      count?: false | undefined;
+      choices?: readonly number[] | undefined;
+      defaultValue?: undefined;
+      required: true;
+      arity?: number | undefined;
+      validate?: ((value: number[]) => void) | undefined;
+    };
+
+export type CountOptionConfig =
+  | {
+      shortName?: ShortOptionName | undefined;
+      description?: string | undefined;
+
+      type: 'number';
+      multiple?: false | undefined;
+      count: true;
+      defaultValue?: undefined;
+      required?: false | undefined;
+      validate?: ((value: number) => void) | undefined;
+    }
+  | {
+      shortName?: ShortOptionName | undefined;
+      description?: string | undefined;
+
+      type: 'number';
+      multiple?: false | undefined;
+      count: true;
+      defaultValue: number;
+      required?: false | undefined;
+      validate?: ((value: number) => void) | undefined;
+    }
+  | {
+      shortName?: ShortOptionName | undefined;
+      description?: string | undefined;
+
+      type: 'number';
+      multiple?: false | undefined;
+      count: true;
+      defaultValue?: undefined;
+      required: true;
+      validate?: ((value: number) => void) | undefined;
+    };
+
+export type StringOptionConfig =
+  | {
+      shortName?: ShortOptionName | undefined;
+      description?: string | undefined;
+
+      type: 'string';
+      multiple?: false | undefined;
+      count?: false | undefined;
+      choices?: readonly string[] | undefined;
+      defaultValue?: undefined;
+      required?: false | undefined;
+      validate?: ((value: string) => void) | undefined;
+    }
+  | {
+      shortName?: ShortOptionName | undefined;
+      description?: string | undefined;
+
+      type: 'string';
+      multiple?: false | undefined;
+      count?: false | undefined;
+      choices?: readonly string[] | undefined;
+      defaultValue: string;
+      required?: false | undefined;
+      validate?: ((value: string) => void) | undefined;
+    }
+  | {
+      shortName?: ShortOptionName | undefined;
+      description?: string | undefined;
+
+      type: 'string';
+      multiple?: false | undefined;
+      count?: false | undefined;
+      choices?: readonly string[] | undefined;
+      defaultValue?: undefined;
+      required: true;
+      validate?: ((value: string) => void) | undefined;
+    };
+
+export type StringsOptionConfig =
+  | {
+      shortName?: ShortOptionName | undefined;
+      description?: string | undefined;
+
+      type: 'string';
+      multiple: true;
+      count?: false | undefined;
+      choices?: readonly string[] | undefined;
+      defaultValue?: undefined;
+      required?: false | undefined;
+      arity?: number | undefined;
+      validate?: ((value: string[]) => void) | undefined;
+    }
+  | {
+      shortName?: ShortOptionName | undefined;
+      description?: string | undefined;
+
+      type: 'string';
+      multiple: true;
+      count?: false | undefined;
+      choices?: readonly string[] | undefined;
+      defaultValue: readonly string[];
+      required?: false | undefined;
+      arity?: number | undefined;
+      validate?: ((value: string[]) => void) | undefined;
+    }
+  | {
+      shortName?: ShortOptionName | undefined;
+      description?: string | undefined;
+
+      type: 'string';
+      multiple: true;
+      count?: false | undefined;
+      choices?: readonly string[] | undefined;
+      defaultValue?: undefined;
+      required: true;
+      arity?: number | undefined;
+      validate?: ((value: string[]) => void) | undefined;
+    };
+
+/** A type representing parser's option configuration. */
+export type OptionConfig =
+  | BooleanOptionConfig
+  | BooleansOptionConfig
+  | CountOptionConfig
+  | NumberOptionConfig
+  | NumbersOptionConfig
+  | StringOptionConfig
+  | StringsOptionConfig;

package/src/types/OptionsConfig.ts

@@ -0,0 +1,4 @@
+import {type OptionConfig} from './OptionConfig.js';
+
+/** A type representing parser's options configuration. */
+export type OptionsConfig = Record<string, OptionConfig>;

package/src/types/ParameterConfig.ts

@@ -0,0 +1,100 @@
+/* eslint-disable @typescript-eslint/sort-type-constituents -- sorting hurts readability in this case */
+
+export type BooleanParameterConfig =
+  | {
+      label?: string | undefined;
+      description?: string | undefined;
+
+      type: 'boolean';
+      defaultValue?: undefined;
+      required?: false | undefined;
+      validate?: ((value: boolean) => void) | undefined;
+    }
+  | {
+      label?: string | undefined;
+      description?: string | undefined;
+
+      type: 'boolean';
+      defaultValue: boolean;
+      required?: false | undefined;
+      validate?: ((value: boolean) => void) | undefined;
+    }
+  | {
+      label?: string | undefined;
+      description?: string | undefined;
+
+      type: 'boolean';
+      defaultValue?: undefined;
+      required: true;
+      validate?: ((value: boolean) => void) | undefined;
+    };
+
+export type NumberParameterConfig =
+  | {
+      label?: string | undefined;
+      description?: string | undefined;
+
+      type: 'number';
+      defaultValue?: undefined;
+      required?: false | undefined;
+      choices?: readonly number[] | undefined;
+      validate?: ((value: number) => void) | undefined;
+    }
+  | {
+      label?: string | undefined;
+      description?: string | undefined;
+
+      type: 'number';
+      defaultValue: number;
+      required?: false | undefined;
+      choices?: readonly number[] | undefined;
+      validate?: ((value: number) => void) | undefined;
+    }
+  | {
+      label?: string | undefined;
+      description?: string | undefined;
+
+      type: 'number';
+      defaultValue?: undefined;
+      required: true;
+      choices?: readonly number[] | undefined;
+      validate?: ((value: number) => void) | undefined;
+    };
+
+export type StringParameterConfig =
+  | {
+      label?: string | undefined;
+      description?: string | undefined;
+
+      type: 'string';
+      defaultValue?: undefined;
+      required?: false | undefined;
+      choices?: readonly string[] | undefined;
+      validate?: ((value: string) => void) | undefined;
+    }
+  | {
+      label?: string | undefined;
+      description?: string | undefined;
+
+      type: 'string';
+      defaultValue: string;
+      required?: false | undefined;
+      choices?: readonly string[] | undefined;
+      validate?: ((value: string) => void) | undefined;
+    }
+  | {
+      label?: string | undefined;
+      description?: string | undefined;
+
+      type: 'string';
+      defaultValue?: undefined;
+      required: true;
+      choices?: readonly string[] | undefined;
+      validate?: ((value: string) => void) | undefined;
+    };
+
+/** A type representing parser's parameter configuration. */
+export type ParameterConfig =
+  | BooleanParameterConfig
+  | NumberParameterConfig
+  | StringParameterConfig;

package/src/types/ParametersConfig.ts

@@ -0,0 +1,17 @@
+import {type ParameterConfig} from './ParameterConfig.js';
+
+/** A type representing parser's parameters configuration. */
+export type ParametersConfig =
+  | readonly [
+      ParameterConfig,
+      ParameterConfig,
+      ParameterConfig,
+      ParameterConfig,
+      ParameterConfig,
+      ParameterConfig,
+    ]
+  | readonly [ParameterConfig, ParameterConfig, ParameterConfig, ParameterConfig, ParameterConfig]
+  | readonly [ParameterConfig, ParameterConfig, ParameterConfig, ParameterConfig]
+  | readonly [ParameterConfig, ParameterConfig, ParameterConfig]
+  | readonly [ParameterConfig, ParameterConfig]
+  | readonly [ParameterConfig];

package/src/types/ParserConfig.ts

@@ -0,0 +1,21 @@
+import {type CommandsConfig} from './CommandsConfig.js';
+import {type OptionsConfig} from './OptionsConfig.js';
+import {type ParametersConfig} from './ParametersConfig.js';
+
+/** Parser configuration specifies how the command line arguments should be parsed. */
+export type ParserConfig = {
+  /** Commands configuration. */
+  commands?: CommandsConfig | undefined;
+
+  /** Parameters configuration. */
+  parameters?: ParametersConfig | undefined;
+
+  /** Options configuration. */
+  options?: OptionsConfig | undefined;
+
+  /** Allow parsing unknown options. */
+  allowUnknownOptions?: boolean | undefined;
+
+  /** Allow parsing unknown parameters. */
+  allowUnknownParameters?: boolean | undefined;
+};

package/src/types/ShortOptionName.ts

@@ -0,0 +1,54 @@
+/** Short option name. */
+export type ShortOptionName =
+  | 'A'
+  | 'a'
+  | 'B'
+  | 'b'
+  | 'C'
+  | 'c'
+  | 'D'
+  | 'd'
+  | 'E'
+  | 'e'
+  | 'F'
+  | 'f'
+  | 'G'
+  | 'g'
+  | 'H'
+  | 'h'
+  | 'I'
+  | 'i'
+  | 'J'
+  | 'j'
+  | 'K'
+  | 'k'
+  | 'L'
+  | 'l'
+  | 'M'
+  | 'm'
+  | 'N'
+  | 'n'
+  | 'O'
+  | 'o'
+  | 'P'
+  | 'p'
+  | 'Q'
+  | 'q'
+  | 'R'
+  | 'r'
+  | 'S'
+  | 's'
+  | 'T'
+  | 't'
+  | 'U'
+  | 'u'
+  | 'V'
+  | 'v'
+  | 'W'
+  | 'w'
+  | 'X'
+  | 'x'
+  | 'Y'
+  | 'y'
+  | 'Z'
+  | 'z';

package/src/types.ts

@@ -0,0 +1,17 @@
+export * from './types/Arguments.js';
+export * from './types/ArgumentsCommand.js';
+export * from './types/ArgumentsOptions.js';
+export * from './types/ArgumentsParameters.js';
+export * from './types/ArgumentsUnknownOptions.js';
+export * from './types/Argv.js';
+export * from './types/CommandConfig.js';
+export * from './types/CommandsConfig.js';
+export * from './types/LongOptionName.js';
+export * from './types/NormalizedCommandConfig.js';
+export * from './types/NormalizedCommandsConfig.js';
+export * from './types/OptionConfig.js';
+export * from './types/OptionsConfig.js';
+export * from './types/ParameterConfig.js';
+export * from './types/ParametersConfig.js';
+export * from './types/ParserConfig.js';
+export * from './types/ShortOptionName.js';