clerc 0.34.0 → 0.35.0

package/dist/index.d.ts

@@ -220,511 +220,511 @@ type LiteralUnion<
 	BaseType extends Primitive,
 > = LiteralType | (BaseType & Record<never, never>);
 
-type Equals<X, Y> = (<T>() => T extends X ? 1 : 2) extends (<T>() => T extends Y ? 1 : 2) ? true : false;
-type Dict<T> = Record<string, T>;
-type MaybeArray$1<T> = T | T[];
-type AlphabetLowercase = "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z";
-type Numeric = "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9";
-type AlphaNumeric = AlphabetLowercase | Uppercase<AlphabetLowercase> | Numeric;
+type Equals<X, Y> = (<T>() => T extends X ? 1 : 2) extends (<T>() => T extends Y ? 1 : 2) ? true : false;
+type Dict<T> = Record<string, T>;
+type MaybeArray$1<T> = T | T[];
+type AlphabetLowercase = "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z";
+type Numeric = "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9";
+type AlphaNumeric = AlphabetLowercase | Uppercase<AlphabetLowercase> | Numeric;
 type CamelCase<Word extends string> = (Word extends `${infer FirstCharacter}${infer Rest}` ? (FirstCharacter extends AlphaNumeric ? `${FirstCharacter}${CamelCase<Rest>}` : Capitalize<CamelCase<Rest>>) : Word);
 
-declare const DOUBLE_DASH = "--";
-type TypeFunction<ReturnType = any> = (value: any) => ReturnType;
-type TypeFunctionArray<ReturnType> = readonly [TypeFunction<ReturnType>];
-type FlagType<ReturnType = any> = TypeFunction<ReturnType> | TypeFunctionArray<ReturnType>;
-type FlagSchemaBase<TF> = {
-    /**
-      Type of the flag as a function that parses the argv string and returns the parsed value.
-  
-      @example
-      ```
-      type: String
-      ```
-  
-      @example Wrap in an array to accept multiple values.
-      ```
-      type: [Boolean]
-      ```
-  
-      @example Custom function type that uses moment.js to parse string as date.
-      ```
-      type: function CustomDate(value: string) {
-          return moment(value).toDate();
-      }
-      ```
-      */
-    type: TF;
-    /**
-      A single-character alias for the flag.
-  
-      @example
-      ```
-      alias: 's'
-      ```
-      */
-    alias?: string;
-} & Record<PropertyKey, unknown>;
-type FlagSchemaDefault<TF, DefaultType = any> = FlagSchemaBase<TF> & {
-    /**
-      Default value of the flag. Also accepts a function that returns the default value.
-      [Default: undefined]
-  
-      @example
-      ```
-      default: 'hello'
-      ```
-  
-      @example
-      ```
-      default: () => [1, 2, 3]
-      ```
-      */
-    default: DefaultType | (() => DefaultType);
-};
-type FlagSchema<TF = FlagType> = (FlagSchemaBase<TF> | FlagSchemaDefault<TF>);
-type FlagTypeOrSchema<ExtraOptions = Record<string, unknown>> = FlagType | (FlagSchema & ExtraOptions);
-type Flags$1<ExtraOptions = Record<string, unknown>> = Record<string, FlagTypeOrSchema<ExtraOptions>>;
-type InferFlagType<Flag extends FlagTypeOrSchema> = (Flag extends (TypeFunctionArray<infer T> | FlagSchema<TypeFunctionArray<infer T>>) ? (Flag extends FlagSchemaDefault<TypeFunctionArray<T>, infer D> ? T[] | D : T[]) : (Flag extends TypeFunction<infer T> | FlagSchema<TypeFunction<infer T>> ? (Flag extends FlagSchemaDefault<TypeFunction<T>, infer D> ? T | D : T | undefined) : never));
-interface ParsedFlags<Schemas = Record<string, unknown>> {
-    flags: Schemas;
-    unknownFlags: Record<string, (string | boolean)[]>;
-    _: string[] & {
-        [DOUBLE_DASH]: string[];
-    };
-}
-type TypeFlag<Schemas extends Flags$1> = ParsedFlags<{
-    [flag in keyof Schemas]: InferFlagType<Schemas[flag]>;
+declare const DOUBLE_DASH = "--";
+type TypeFunction<ReturnType = any> = (value: any) => ReturnType;
+type TypeFunctionArray<ReturnType> = readonly [TypeFunction<ReturnType>];
+type FlagType<ReturnType = any> = TypeFunction<ReturnType> | TypeFunctionArray<ReturnType>;
+type FlagSchemaBase<TF> = {
+    /**
+      Type of the flag as a function that parses the argv string and returns the parsed value.
+  
+      @example
+      ```
+      type: String
+      ```
+  
+      @example Wrap in an array to accept multiple values.
+      ```
+      type: [Boolean]
+      ```
+  
+      @example Custom function type that uses moment.js to parse string as date.
+      ```
+      type: function CustomDate(value: string) {
+          return moment(value).toDate();
+      }
+      ```
+      */
+    type: TF;
+    /**
+      A single-character alias for the flag.
+  
+      @example
+      ```
+      alias: 's'
+      ```
+      */
+    alias?: string;
+} & Record<PropertyKey, unknown>;
+type FlagSchemaDefault<TF, DefaultType = any> = FlagSchemaBase<TF> & {
+    /**
+      Default value of the flag. Also accepts a function that returns the default value.
+      [Default: undefined]
+  
+      @example
+      ```
+      default: 'hello'
+      ```
+  
+      @example
+      ```
+      default: () => [1, 2, 3]
+      ```
+      */
+    default: DefaultType | (() => DefaultType);
+};
+type FlagSchema<TF = FlagType> = (FlagSchemaBase<TF> | FlagSchemaDefault<TF>);
+type FlagTypeOrSchema<ExtraOptions = Record<string, unknown>> = FlagType | (FlagSchema & ExtraOptions);
+type Flags$1<ExtraOptions = Record<string, unknown>> = Record<string, FlagTypeOrSchema<ExtraOptions>>;
+type InferFlagType<Flag extends FlagTypeOrSchema> = (Flag extends (TypeFunctionArray<infer T> | FlagSchema<TypeFunctionArray<infer T>>) ? (Flag extends FlagSchemaDefault<TypeFunctionArray<T>, infer D> ? T[] | D : T[]) : (Flag extends TypeFunction<infer T> | FlagSchema<TypeFunction<infer T>> ? (Flag extends FlagSchemaDefault<TypeFunction<T>, infer D> ? T | D : T | undefined) : never));
+interface ParsedFlags<Schemas = Record<string, unknown>> {
+    flags: Schemas;
+    unknownFlags: Record<string, (string | boolean)[]>;
+    _: string[] & {
+        [DOUBLE_DASH]: string[];
+    };
+}
+type TypeFlag<Schemas extends Flags$1> = ParsedFlags<{
+    [flag in keyof Schemas]: InferFlagType<Schemas[flag]>;
 }>;
 
-type StripBrackets<Parameter extends string> = (Parameter extends `<${infer ParameterName}>` | `[${infer ParameterName}]` ? (ParameterName extends `${infer SpreadName}...` ? SpreadName : ParameterName) : never);
-type ParameterType<Parameter extends string> = (Parameter extends `<${infer _ParameterName}...>` | `[${infer _ParameterName}...]` ? string[] : Parameter extends `<${infer _ParameterName}>` ? string : Parameter extends `[${infer _ParameterName}]` ? string | undefined : never);
-type NonNullableParameters<T extends string[] | undefined> = T extends undefined ? [] : NonNullable<T>;
-type TransformParameters<C extends Command> = {
-    [Parameter in NonNullableParameters<C["parameters"]>[number] as CamelCase<StripBrackets<Parameter>>]: ParameterType<Parameter>;
-};
-type MakeEventMap<T extends Commands> = {
-    [K in keyof T]: [InspectorContext];
-};
-type FallbackFlags<F extends Flags | undefined> = Equals<NonNullableFlag<F>["flags"], {}> extends true ? Dict<any> : NonNullableFlag<F>["flags"];
-type NonNullableFlag<F extends Flags | undefined> = TypeFlag<NonNullable<F>>;
-type ParseFlag<C extends Commands, N extends keyof C, GF extends FlagsWithoutDescription = {}> = N extends keyof C ? OmitIndexSignature<NonNullableFlag<C[N]["flags"] & GF>["flags"]> : FallbackFlags<C[N]["flags"] & GF>["flags"];
-type ParseRaw<C extends Command, GF extends FlagsWithoutDescription = {}> = NonNullableFlag<C["flags"] & GF> & {
-    flags: FallbackFlags<C["flags"] & GF>;
-    parameters: string[];
-    mergedFlags: FallbackFlags<C["flags"] & GF> & NonNullableFlag<C["flags"] & GF>["unknownFlags"];
-};
+type StripBrackets<Parameter extends string> = (Parameter extends `<${infer ParameterName}>` | `[${infer ParameterName}]` ? (ParameterName extends `${infer SpreadName}...` ? SpreadName : ParameterName) : never);
+type ParameterType<Parameter extends string> = (Parameter extends `<${infer _ParameterName}...>` | `[${infer _ParameterName}...]` ? string[] : Parameter extends `<${infer _ParameterName}>` ? string : Parameter extends `[${infer _ParameterName}]` ? string | undefined : never);
+type NonNullableParameters<T extends string[] | undefined> = T extends undefined ? [] : NonNullable<T>;
+type TransformParameters<C extends Command> = {
+    [Parameter in NonNullableParameters<C["parameters"]>[number] as CamelCase<StripBrackets<Parameter>>]: ParameterType<Parameter>;
+};
+type MakeEventMap<T extends Commands> = {
+    [K in keyof T]: [InspectorContext];
+};
+type FallbackFlags<F extends Flags | undefined> = Equals<NonNullableFlag<F>["flags"], {}> extends true ? Dict<any> : NonNullableFlag<F>["flags"];
+type NonNullableFlag<F extends Flags | undefined> = TypeFlag<NonNullable<F>>;
+type ParseFlag<C extends Commands, N extends keyof C, GF extends GlobalFlagOptions = {}> = N extends keyof C ? OmitIndexSignature<NonNullableFlag<C[N]["flags"] & GF>["flags"]> : FallbackFlags<C[N]["flags"] & GF>["flags"];
+type ParseRaw<C extends Command, GF extends GlobalFlagOptions = {}> = NonNullableFlag<C["flags"] & GF> & {
+    flags: FallbackFlags<C["flags"] & GF>;
+    parameters: string[];
+    mergedFlags: FallbackFlags<C["flags"] & GF> & NonNullableFlag<C["flags"] & GF>["unknownFlags"];
+};
 type ParseParameters<C extends Commands = Commands, N extends keyof C = keyof C> = Equals<TransformParameters<C[N]>, {}> extends true ? N extends keyof C ? TransformParameters<C[N]> : Dict<string | string[] | undefined> : TransformParameters<C[N]>;
 
-interface Plugin<T extends Clerc = Clerc, U extends Clerc = Clerc> {
-    setup: (cli: T) => U;
+interface Plugin<T extends Clerc = Clerc, U extends Clerc = Clerc> {
+    setup: (cli: T) => U;
 }
 
-type Locales = Dict<Dict<string>>;
-type TranslateFn = (name: string, ...args: string[]) => string | undefined;
-interface I18N {
-    add: (locales: Locales) => void;
-    t: TranslateFn;
+type Locales = Dict<Dict<string>>;
+type TranslateFn = (name: string, ...args: string[]) => string | undefined;
+interface I18N {
+    add: (locales: Locales) => void;
+    t: TranslateFn;
 }
 
-type CommandType = RootType | string;
-type FlagOptions = FlagSchema & {
-    description: string;
-};
-type Flag = FlagOptions & {
-    name: string;
-};
-type FlagWithoutDescription = Omit<Flag, "description">;
-type Flags = Dict<FlagOptions>;
-type FlagsWithoutDescription = Dict<FlagWithoutDescription>;
-declare interface CommandCustomProperties {
-}
-interface CommandOptions<P extends string[] = string[], A extends MaybeArray$1<string | RootType> = MaybeArray$1<string | RootType>, F extends Flags = Flags> extends CommandCustomProperties {
-    alias?: A;
-    parameters?: P;
-    flags?: F;
-    examples?: [string, string][];
-    notes?: string[];
-}
-type Command<N extends string | RootType = string, O extends CommandOptions = CommandOptions> = O & {
-    name: N;
-    description: string;
-};
-type CommandAlias<N extends string | RootType = string, O extends CommandOptions = CommandOptions> = Command<N, O> & {
-    __isAlias?: true;
-};
-type CommandWithHandler<N extends string | RootType = string, O extends CommandOptions = CommandOptions> = Command<N, O> & {
-    handler?: HandlerInCommand<HandlerContext<Record<N, Command<N, O>> & Record<never, never>, N>>;
-};
-type Commands = Dict<Command> & {
-    [Root]?: Command;
-};
-interface ParseOptions {
-    argv?: string[];
-    run?: boolean;
-}
-interface HandlerContext<C extends Commands = Commands, N extends keyof C = keyof C, GF extends FlagsWithoutDescription = {}> {
-    name?: LiteralUnion<N, string>;
-    called?: string | RootType;
-    resolved: boolean;
-    hasRootOrAlias: boolean;
-    hasRoot: boolean;
-    raw: Simplify<ParseRaw<C[N], GF>>;
-    parameters: Simplify<ParseParameters<C, N>>;
-    unknownFlags: ParsedFlags["unknownFlags"];
-    flags: Simplify<ParseFlag<C, N, GF> & Record<string, any>>;
-    cli: Clerc<C, GF>;
-}
-type Handler<C extends Commands = Commands, K extends keyof C = keyof C, GF extends FlagsWithoutDescription = {}> = (ctx: HandlerContext<C, K, GF>) => void;
-type HandlerInCommand<C extends HandlerContext> = (ctx: {
-    [K in keyof C]: C[K];
-}) => void;
-type FallbackType<T, U> = {} extends T ? U : T;
-type InspectorContext<C extends Commands = Commands> = HandlerContext<C> & {
-    flags: FallbackType<TypeFlag<NonNullable<C[keyof C]["flags"]>>["flags"], Dict<any>>;
-};
-type Inspector<C extends Commands = Commands> = InspectorFn<C> | InspectorObject<C>;
-type InspectorFn<C extends Commands = Commands> = (ctx: InspectorContext<C>, next: () => void) => (() => void) | void;
-interface InspectorObject<C extends Commands = Commands> {
-    enforce?: "pre" | "post";
-    fn: InspectorFn<C>;
+type CommandType = RootType | string;
+type FlagOptions = FlagSchema & {
+    description: string;
+};
+type Flag = FlagOptions & {
+    name: string;
+};
+type GlobalFlagOption = FlagSchema;
+type Flags = Dict<FlagOptions>;
+type GlobalFlagOptions = Dict<GlobalFlagOption>;
+declare interface CommandCustomProperties {
+}
+interface CommandOptions<P extends string[] = string[], A extends MaybeArray$1<string | RootType> = MaybeArray$1<string | RootType>, F extends Flags = Flags> extends CommandCustomProperties {
+    alias?: A;
+    parameters?: P;
+    flags?: F;
+}
+type Command<N extends string | RootType = string, O extends CommandOptions = CommandOptions> = O & {
+    name: N;
+    description: string;
+};
+type CommandAlias<N extends string | RootType = string, O extends CommandOptions = CommandOptions> = Command<N, O> & {
+    __isAlias?: true;
+};
+type CommandWithHandler<N extends string | RootType = string, O extends CommandOptions = CommandOptions> = Command<N, O> & {
+    handler?: HandlerInCommand<HandlerContext<Record<N, Command<N, O>> & Record<never, never>, N>>;
+};
+type Commands = Dict<Command> & {
+    [Root]?: Command;
+};
+interface ParseOptions {
+    argv?: string[];
+    run?: boolean;
+}
+interface HandlerContext<C extends Commands = Commands, N extends keyof C = keyof C, GF extends GlobalFlagOptions = {}> {
+    name?: LiteralUnion<N, string>;
+    called?: string | RootType;
+    resolved: boolean;
+    hasRootOrAlias: boolean;
+    hasRoot: boolean;
+    raw: Simplify<ParseRaw<C[N], GF>>;
+    parameters: Simplify<ParseParameters<C, N>>;
+    unknownFlags: ParsedFlags["unknownFlags"];
+    flags: Simplify<ParseFlag<C, N, GF> & Record<string, any>>;
+    cli: Clerc<C, GF>;
+}
+type Handler<C extends Commands = Commands, K extends keyof C = keyof C, GF extends GlobalFlagOptions = {}> = (ctx: HandlerContext<C, K, GF>) => void;
+type HandlerInCommand<C extends HandlerContext> = (ctx: {
+    [K in keyof C]: C[K];
+}) => void;
+type FallbackType<T, U> = {} extends T ? U : T;
+type InspectorContext<C extends Commands = Commands> = HandlerContext<C> & {
+    flags: FallbackType<TypeFlag<NonNullable<C[keyof C]["flags"]>>["flags"], Dict<any>>;
+};
+type Inspector<C extends Commands = Commands> = InspectorFn<C> | InspectorObject<C>;
+type InspectorFn<C extends Commands = Commands> = (ctx: InspectorContext<C>, next: () => void) => (() => void) | void;
+interface InspectorObject<C extends Commands = Commands> {
+    enforce?: "pre" | "post";
+    fn: InspectorFn<C>;
 }
 
-declare const Root: unique symbol;
-type RootType = typeof Root;
-declare class Clerc<C extends Commands = {}, GF extends FlagsWithoutDescription = {}> {
-    #private;
-    i18n: I18N;
-    private constructor();
-    get _name(): string;
-    get _description(): string;
-    get _version(): string;
-    get _inspectors(): Inspector<Commands>[];
-    get _commands(): C;
-    get _flags(): GF;
-    /**
-     * Create a new cli
-     * @returns
-     * @example
-     * ```ts
-     * const cli = Clerc.create()
-     * ```
-     */
-    static create(name?: string, description?: string, version?: string): Clerc<{}, {}>;
-    /**
-     * Set the name of the cli
-     * @param name
-     * @returns
-     * @example
-     * ```ts
-     * Clerc.create()
-     *   .name("test")
-     * ```
-     */
-    name(name: string): this;
-    /**
-     * Set the description of the cli
-     * @param description
-     * @returns
-     * @example
-     * ```ts
-     * Clerc.create()
-     *   .description("test cli")
-     * ```
-     */
-    description(description: string): this;
-    /**
-     * Set the version of the cli
-     * @param version
-     * @returns
-     * @example
-     * ```ts
-     * Clerc.create()
-     *   .version("1.0.0")
-     * ```
-     */
-    version(version: string): this;
-    /**
-     * Set the Locale
-     * You must call this method once after you created the Clerc instance.
-     * @param locale
-     * @returns
-     * @example
-     * ```ts
-     * Clerc.create()
-     *   .locale("en")
-     *   .command(...)
-     * ```
-     */
-    locale(locale: string): this;
-    /**
-     * Set the fallback Locale
-     * You must call this method once after you created the Clerc instance.
-     * @param fallbackLocale
-     * @returns
-     * @example
-     * ```ts
-     * Clerc.create()
-     *   .fallbackLocale("en")
-     *   .command(...)
-     * ```
-     */
-    fallbackLocale(fallbackLocale: string): this;
-    /**
-     * Register a error handler
-     * @param handler
-     * @returns
-     * @example
-     * ```ts
-     * Clerc.create()
-     *   .errorHandler((err) => { console.log(err); })
-     * ```
-     */
-    errorHandler(handler: (err: any) => void): this;
-    /**
-     * Register a command
-     * @param name
-     * @param description
-     * @param options
-     * @returns
-     * @example
-     * ```ts
-     * Clerc.create()
-     *   .command("test", "test command", {
-     *     alias: "t",
-     *     flags: {
-     *       foo: {
-     *         alias: "f",
-     *         description: "foo flag",
-     *       }
-     *     }
-     *   })
-     * ```
-     * @example
-     * ```ts
-     * Clerc.create()
-     *   .command("", "root", {
-     *     flags: {
-     *       foo: {
-     *         alias: "f",
-     *         description: "foo flag",
-     *       }
-     *     }
-     *   })
-     * ```
-     */
-    command<N extends string | RootType, O extends CommandOptions<[...P], A, F>, P extends string[] = string[], A extends MaybeArray$1<string | RootType> = MaybeArray$1<string | RootType>, F extends Flags = Flags>(c: CommandWithHandler<N, O & CommandOptions<[...P], A, F>>): this & Clerc<C & Record<N, Command<N, O>>, GF>;
-    command<N extends string | RootType, O extends CommandOptions<[...P], A, F>, P extends string[] = string[], A extends MaybeArray$1<string | RootType> = MaybeArray$1<string | RootType>, F extends Flags = Flags>(name: N, description: string, options?: O & CommandOptions<[...P], A, F>): this & Clerc<C & Record<N, Command<N, O>>, GF>;
-    /**
-     * Register a global flag
-     * @param name
-     * @param options
-     * @returns
-     * @example
-     * ```ts
-     * Clerc.create()
-     *   .flag("help", {
-     *     alias: "h",
-     *     description: "help",
-     *   })
-     * ```
-     */
-    flag<N extends string, O extends FlagWithoutDescription>(name: N, description: string, options: O): this & Clerc<C, GF & Record<N, O>>;
-    /**
-     * Register a handler
-     * @param name
-     * @param handler
-     * @returns
-     * @example
-     * ```ts
-     * Clerc.create()
-     *   .command("test", "test command")
-     *   .on("test", (ctx) => {
-     *     console.log(ctx);
-     *   })
-     * ```
-     */
-    on<K extends LiteralUnion<keyof CM, string | RootType>, CM extends this["_commands"] = this["_commands"]>(name: K, handler: Handler<CM, K, this["_flags"]>): this;
-    /**
-     * Use a plugin
-     * @param plugin
-     * @returns
-     * @example
-     * ```ts
-     * Clerc.create()
-     *   .use(plugin)
-     * ```
-     */
-    use<T extends Clerc, U extends Clerc>(plugin: Plugin<T, U>): this & Clerc<C & U["_commands"]> & U;
-    /**
-     * Register a inspector
-     * @param inspector
-     * @returns
-     * @example
-     * ```ts
-     * Clerc.create()
-     *   .inspector((ctx, next) => {
-     *     console.log(ctx);
-     *     next();
-     *   })
-     * ```
-     */
-    inspector(inspector: Inspector): this;
-    /**
-     * Parse the command line arguments
-     * @param args
-     * @returns
-     * @example
-     * ```ts
-     * Clerc.create()
-     *   .parse(process.argv.slice(2)) // Optional
-     * ```
-     */
-    parse(optionsOrArgv?: string[] | ParseOptions): this;
-    /**
-     * Run matched command
-     * @returns
-     * @example
-     * ```ts
-     * Clerc.create()
-     *   .parse({ run: false })
-     *   .runMatchedCommand()
-     * ```
-     */
-    runMatchedCommand(): this;
+declare const Root: unique symbol;
+type RootType = typeof Root;
+declare class Clerc<C extends Commands = {}, GF extends GlobalFlagOptions = {}> {
+    #private;
+    i18n: I18N;
+    private constructor();
+    get _name(): string;
+    get _description(): string;
+    get _version(): string;
+    get _inspectors(): Inspector[];
+    get _commands(): C;
+    get _flags(): GF;
+    /**
+     * Create a new cli
+     * @returns
+     * @example
+     * ```ts
+     * const cli = Clerc.create()
+     * ```
+     */
+    static create(name?: string, description?: string, version?: string): Clerc<{}, {}>;
+    /**
+     * Set the name of the cli
+     * @param name
+     * @returns
+     * @example
+     * ```ts
+     * Clerc.create()
+     *   .name("test")
+     * ```
+     */
+    name(name: string): this;
+    /**
+     * Set the description of the cli
+     * @param description
+     * @returns
+     * @example
+     * ```ts
+     * Clerc.create()
+     *   .description("test cli")
+     * ```
+     */
+    description(description: string): this;
+    /**
+     * Set the version of the cli
+     * @param version
+     * @returns
+     * @example
+     * ```ts
+     * Clerc.create()
+     *   .version("1.0.0")
+     * ```
+     */
+    version(version: string): this;
+    /**
+     * Set the Locale
+     * You must call this method once after you created the Clerc instance.
+     * @param locale
+     * @returns
+     * @example
+     * ```ts
+     * Clerc.create()
+     *   .locale("en")
+     *   .command(...)
+     * ```
+     */
+    locale(locale: string): this;
+    /**
+     * Set the fallback Locale
+     * You must call this method once after you created the Clerc instance.
+     * @param fallbackLocale
+     * @returns
+     * @example
+     * ```ts
+     * Clerc.create()
+     *   .fallbackLocale("en")
+     *   .command(...)
+     * ```
+     */
+    fallbackLocale(fallbackLocale: string): this;
+    /**
+     * Register a error handler
+     * @param handler
+     * @returns
+     * @example
+     * ```ts
+     * Clerc.create()
+     *   .errorHandler((err) => { console.log(err); })
+     * ```
+     */
+    errorHandler(handler: (err: any) => void): this;
+    /**
+     * Register a command
+     * @param name
+     * @param description
+     * @param options
+     * @returns
+     * @example
+     * ```ts
+     * Clerc.create()
+     *   .command("test", "test command", {
+     *     alias: "t",
+     *     flags: {
+     *       foo: {
+     *         alias: "f",
+     *         description: "foo flag",
+     *       }
+     *     }
+     *   })
+     * ```
+     * @example
+     * ```ts
+     * Clerc.create()
+     *   .command("", "root", {
+     *     flags: {
+     *       foo: {
+     *         alias: "f",
+     *         description: "foo flag",
+     *       }
+     *     }
+     *   })
+     * ```
+     */
+    command<N extends string | RootType, O extends CommandOptions<[...P], A, F>, P extends string[] = string[], A extends MaybeArray$1<string | RootType> = MaybeArray$1<string | RootType>, F extends Flags = Flags>(c: CommandWithHandler<N, O & CommandOptions<[...P], A, F>>): this & Clerc<C & Record<N, Command<N, O>>, GF>;
+    command<N extends string | RootType, O extends CommandOptions<[...P], A, F>, P extends string[] = string[], A extends MaybeArray$1<string | RootType> = MaybeArray$1<string | RootType>, F extends Flags = Flags>(name: N, description: string, options?: O & CommandOptions<[...P], A, F>): this & Clerc<C & Record<N, Command<N, O>>, GF>;
+    /**
+     * Register a global flag
+     * @param name
+     * @param description
+     * @param options
+     * @returns
+     * @example
+     * ```ts
+     * Clerc.create()
+     *   .flag("help", "help", {
+     *     alias: "h",
+     *     type: Boolean,
+     *   })
+     * ```
+     */
+    flag<N extends string, O extends GlobalFlagOption>(name: N, description: string, options: O): this & Clerc<C, GF & Record<N, O>>;
+    /**
+     * Register a handler
+     * @param name
+     * @param handler
+     * @returns
+     * @example
+     * ```ts
+     * Clerc.create()
+     *   .command("test", "test command")
+     *   .on("test", (ctx) => {
+     *     console.log(ctx);
+     *   })
+     * ```
+     */
+    on<K extends LiteralUnion<keyof CM, string | RootType>, CM extends this["_commands"] = this["_commands"]>(name: K, handler: Handler<CM, K, this["_flags"]>): this;
+    /**
+     * Use a plugin
+     * @param plugin
+     * @returns
+     * @example
+     * ```ts
+     * Clerc.create()
+     *   .use(plugin)
+     * ```
+     */
+    use<T extends Clerc, U extends Clerc>(plugin: Plugin<T, U>): this & Clerc<C & U["_commands"]> & U;
+    /**
+     * Register a inspector
+     * @param inspector
+     * @returns
+     * @example
+     * ```ts
+     * Clerc.create()
+     *   .inspector((ctx, next) => {
+     *     console.log(ctx);
+     *     next();
+     *   })
+     * ```
+     */
+    inspector(inspector: Inspector): this;
+    /**
+     * Parse the command line arguments
+     * @param args
+     * @returns
+     * @example
+     * ```ts
+     * Clerc.create()
+     *   .parse(process.argv.slice(2)) // Optional
+     * ```
+     */
+    parse(optionsOrArgv?: string[] | ParseOptions): this;
+    /**
+     * Run matched command
+     * @returns
+     * @example
+     * ```ts
+     * Clerc.create()
+     *   .parse({ run: false })
+     *   .runMatchedCommand()
+     * ```
+     */
+    runMatchedCommand(): this;
 }
 
 type MaybeArray<T> = T | T[];
 
-declare const definePlugin: <T extends Clerc<{}, {}>, U extends Clerc<{}, {}>>(p: Plugin<T, U>) => Plugin<T, U>;
-declare const defineHandler: <C extends Clerc<{}, {}>, K extends keyof C["_commands"]>(_cli: C, _key: K, handler: Handler<C["_commands"], K, {}>) => Handler<C["_commands"], K, {}>;
-declare const defineInspector: <C extends Clerc<{}, {}>>(_cli: C, inspector: Inspector<C["_commands"]>) => Inspector<C["_commands"]>;
+declare const definePlugin: <T extends Clerc<{}, {}>, U extends Clerc<{}, {}>>(p: Plugin<T, U>) => Plugin<T, U>;
+declare const defineHandler: <C extends Clerc<{}, {}>, K extends keyof C["_commands"]>(_cli: C, _key: K, handler: Handler<C["_commands"], K>) => Handler<C["_commands"], K>;
+declare const defineInspector: <C extends Clerc<{}, {}>>(_cli: C, inspector: Inspector<C["_commands"]>) => Inspector<C["_commands"]>;
 declare const defineCommand: <N extends string | typeof Root, O extends CommandOptions<[...P], MaybeArray<string | typeof Root>, Flags>, P extends string[]>(command: Command<N, O & CommandOptions<[...P], MaybeArray<string | typeof Root>, Flags>>, handler?: HandlerInCommand<HandlerContext<Record<N, Command<N, O>> & Record<never, never>, N, {}>> | undefined) => CommandWithHandler<N, O & CommandOptions<[...P], MaybeArray<string | typeof Root>, Flags>>;
 
-declare class CommandExistsError extends Error {
-    commandName: string;
-    constructor(commandName: string, t: TranslateFn);
-}
-declare class NoSuchCommandError extends Error {
-    commandName: string;
-    constructor(commandName: string, t: TranslateFn);
-}
-declare class NoCommandGivenError extends Error {
-    constructor(t: TranslateFn);
-}
-declare class CommandNameConflictError extends Error {
-    n1: string;
-    n2: string;
-    constructor(n1: string, n2: string, t: TranslateFn);
-}
-declare class NameNotSetError extends Error {
-    constructor(t: TranslateFn);
-}
-declare class DescriptionNotSetError extends Error {
-    constructor(t: TranslateFn);
-}
-declare class VersionNotSetError extends Error {
-    constructor(t: TranslateFn);
-}
-declare class InvalidCommandNameError extends Error {
-    commandName: string;
-    constructor(commandName: string, t: TranslateFn);
-}
-declare class LocaleNotCalledFirstError extends Error {
-    constructor(t: TranslateFn);
+declare class CommandExistsError extends Error {
+    commandName: string;
+    constructor(commandName: string, t: TranslateFn);
+}
+declare class NoSuchCommandError extends Error {
+    commandName: string;
+    constructor(commandName: string, t: TranslateFn);
+}
+declare class NoCommandGivenError extends Error {
+    constructor(t: TranslateFn);
+}
+declare class CommandNameConflictError extends Error {
+    n1: string;
+    n2: string;
+    constructor(n1: string, n2: string, t: TranslateFn);
+}
+declare class NameNotSetError extends Error {
+    constructor(t: TranslateFn);
+}
+declare class DescriptionNotSetError extends Error {
+    constructor(t: TranslateFn);
+}
+declare class VersionNotSetError extends Error {
+    constructor(t: TranslateFn);
+}
+declare class InvalidCommandNameError extends Error {
+    commandName: string;
+    constructor(commandName: string, t: TranslateFn);
+}
+declare class LocaleNotCalledFirstError extends Error {
+    constructor(t: TranslateFn);
 }
 
-declare function resolveFlattenCommands(commands: Commands, t: TranslateFn): Map<string[] | typeof Root, CommandAlias<string, CommandOptions<string[], MaybeArray$1<string | typeof Root>, Flags>>>;
-declare function resolveCommand(commands: Commands, argv: string[], t: TranslateFn): [Command<string | RootType> | undefined, string[] | RootType | undefined];
-declare function resolveCommandStrict(commands: Commands, name: CommandType | string[], t: TranslateFn): [Command<string | RootType> | undefined, string[] | RootType | undefined];
-declare function resolveSubcommandsByParent(commands: Commands, parent: string | string[], depth?: number): Command<string, CommandOptions<string[], MaybeArray$1<string | typeof Root>, Flags>>[];
-declare const resolveRootCommands: (commands: Commands) => Command<string, CommandOptions<string[], MaybeArray$1<string | typeof Root>, Flags>>[];
-declare const resolveArgv: () => string[];
-declare function compose(inspectors: Inspector[]): (ctx: InspectorContext) => void;
-declare const isValidName: (name: CommandType) => boolean;
-declare const withBrackets: (s: string, isOptional?: boolean) => string;
-declare const formatCommandName: (name: string | string[] | RootType) => string;
-declare const detectLocale: () => string;
+declare function resolveFlattenCommands(commands: Commands, t: TranslateFn): Map<string[] | typeof Root, CommandAlias>;
+declare function resolveCommand(commands: Commands, argv: string[], t: TranslateFn): [Command<string | RootType> | undefined, string[] | RootType | undefined];
+declare const resolveArgv: () => string[];
+declare function compose(inspectors: Inspector[]): (ctx: InspectorContext) => void;
+declare const isValidName: (name: CommandType) => boolean;
+declare const withBrackets: (s: string, isOptional?: boolean) => string;
+declare const formatCommandName: (name: string | string[] | RootType) => string;
+declare const detectLocale: () => string;
 declare const stripFlags: (argv: string[]) => string[];
 
-interface CompletionsPluginOptions {
-    command?: boolean;
-}
+interface CompletionsPluginOptions {
+    command?: boolean;
+}
 declare const completionsPlugin: (options?: CompletionsPluginOptions) => Plugin<Clerc<{}, {}>, Clerc<{}, {}>>;
 
-interface BlockSection {
-    type?: "block";
-    title: string;
-    body: string[];
-}
-interface InlineSection {
-    type: "inline";
-    items: {
-        title: string;
-        body: string;
-    }[];
-}
-type Section = BlockSection | InlineSection;
-interface Renderers {
-    renderSections?: (sections: Section[]) => Section[];
-    renderFlagName?: (name: string) => string;
-    renderType?: (type: any, hasDefault: boolean) => string;
-    renderDefault?: (default_: any) => string;
+interface BlockSection {
+    type?: "block";
+    title: string;
+    body: string[];
+}
+interface InlineSection {
+    type: "inline";
+    items: {
+        title: string;
+        body: string;
+    }[];
+}
+type Section = BlockSection | InlineSection;
+interface Renderers {
+    renderSections?: (sections: Section[]) => Section[];
+    renderFlagName?: (name: string) => string;
+    renderType?: (type: any, hasDefault: boolean) => string;
+    renderDefault?: (default_: any) => string;
 }
 
-declare module "@clerc/core" {
-    interface CommandCustomProperties {
-        help?: Renderers;
-    }
-}
-interface HelpPluginOptions {
-    /**
-     * Whether to register the help command.
-     * @default true
-     */
-    command?: boolean;
-    /**
-     * Whether to register the global help flag.
-     * @default true
-     */
-    flag?: boolean;
-    /**
-     * Whether to show help when no command is specified.
-     * @default true
-     */
-    showHelpWhenNoCommand?: boolean;
-    /**
-     * Global notes.
-     */
-    notes?: string[];
-    /**
-     * Global examples.
-     */
-    examples?: [string, string][];
-    /**
-     * Banner.
-     */
-    banner?: string;
-}
+declare module "@clerc/core" {
+    interface CommandCustomProperties {
+        help?: {
+            renderers?: Renderers;
+            examples?: [string, string][];
+            notes?: string[];
+        };
+    }
+}
+interface HelpPluginOptions {
+    /**
+     * Whether to register the help command.
+     * @default true
+     */
+    command?: boolean;
+    /**
+     * Whether to register the global help flag.
+     * @default true
+     */
+    flag?: boolean;
+    /**
+     * Whether to show help when no command is specified.
+     * @default true
+     */
+    showHelpWhenNoCommand?: boolean;
+    /**
+     * Global notes.
+     */
+    notes?: string[];
+    /**
+     * Global examples.
+     */
+    examples?: [string, string][];
+    /**
+     * Banner.
+     */
+    banner?: string;
+}
 declare const helpPlugin: ({ command, flag, showHelpWhenNoCommand, notes, examples, banner, }?: HelpPluginOptions) => Plugin<Clerc<{}, {}>, Clerc<{}, {}>>;
 
 declare const notFoundPlugin: () => Plugin<Clerc<{}, {}>, Clerc<{}, {}>>;
 
 declare const strictFlagsPlugin: () => Plugin<Clerc<{}, {}>, Clerc<{}, {}>>;
 
-interface VersionPluginOptions {
-    /**
-     * Whether to register the help command.
-     * @default true
-     */
-    command?: boolean;
-    /**
-       * Whether to register the global help flag.
-       * @default true
-       */
-    flag?: boolean;
-}
+interface VersionPluginOptions {
+    /**
+     * Whether to register the help command.
+     * @default true
+     */
+    command?: boolean;
+    /**
+       * Whether to register the global help flag.
+       * @default true
+       */
+    flag?: boolean;
+}
 declare const versionPlugin: ({ command, flag, }?: VersionPluginOptions) => Plugin<Clerc<{}, {}>, Clerc<{}, {}>>;
 
 declare const friendlyErrorPlugin: () => Plugin<Clerc<{}, {}>, Clerc<{}, {}>>;
 
-export { Clerc, Command, CommandAlias, CommandCustomProperties, CommandExistsError, CommandNameConflictError, CommandOptions, CommandType, CommandWithHandler, Commands, CompletionsPluginOptions, DescriptionNotSetError, FallbackType, Flag, FlagOptions, FlagWithoutDescription, Flags, FlagsWithoutDescription, Handler, HandlerContext, HandlerInCommand, HelpPluginOptions, I18N, Inspector, InspectorContext, InspectorFn, InspectorObject, InvalidCommandNameError, LocaleNotCalledFirstError, Locales, MakeEventMap, NameNotSetError, NoCommandGivenError, NoSuchCommandError, ParseOptions, Plugin, Root, RootType, TranslateFn, VersionNotSetError, completionsPlugin, compose, defineCommand, defineHandler, defineInspector, definePlugin, detectLocale, formatCommandName, friendlyErrorPlugin, helpPlugin, isValidName, notFoundPlugin, resolveArgv, resolveCommand, resolveCommandStrict, resolveFlattenCommands, resolveRootCommands, resolveSubcommandsByParent, strictFlagsPlugin, stripFlags, versionPlugin, withBrackets };
+export { Clerc, Command, CommandAlias, CommandCustomProperties, CommandExistsError, CommandNameConflictError, CommandOptions, CommandType, CommandWithHandler, Commands, CompletionsPluginOptions, DescriptionNotSetError, FallbackType, Flag, FlagOptions, Flags, GlobalFlagOption, GlobalFlagOptions, Handler, HandlerContext, HandlerInCommand, HelpPluginOptions, I18N, Inspector, InspectorContext, InspectorFn, InspectorObject, InvalidCommandNameError, LocaleNotCalledFirstError, Locales, MakeEventMap, NameNotSetError, NoCommandGivenError, NoSuchCommandError, ParseOptions, Plugin, Root, RootType, TranslateFn, VersionNotSetError, completionsPlugin, compose, defineCommand, defineHandler, defineInspector, definePlugin, detectLocale, formatCommandName, friendlyErrorPlugin, helpPlugin, isValidName, notFoundPlugin, resolveArgv, resolveCommand, resolveFlattenCommands, strictFlagsPlugin, stripFlags, versionPlugin, withBrackets };