@guanghechen/commander 4.5.1 → 4.7.0

package/lib/types/{index.d.ts → node.d.ts}

@@ -93,6 +93,8 @@ interface ICommandArgumentConfig<T = unknown> {
     coerce?: (rawValue: string) => T;
 }
 interface ICommandBuiltinOptionConfig {
+    /** Enable built-in --version option (root only, requires configured version) */
+    version?: boolean;
     /** Enable built-in --color/--no-color option for help rendering (defaults respect NO_COLOR) */
     color?: boolean;
     /** Enable built-in --log-level option */
@@ -104,15 +106,9 @@ interface ICommandBuiltinOptionConfig {
     /** Enable built-in --log-colorful/--no-log-colorful option */
     logColorful?: boolean;
 }
-interface ICommandBuiltinCommandConfig {
-    /** Enable built-in help subcommand */
-    help?: boolean;
-}
 interface ICommandBuiltinConfig {
     /** Built-in options configuration */
     option?: boolean | ICommandBuiltinOptionConfig;
-    /** Built-in command configuration */
-    command?: boolean | ICommandBuiltinCommandConfig;
 }
 /** Command example configuration */
 interface ICommandExample {
@@ -123,6 +119,32 @@ interface ICommandExample {
     /** Example description */
     desc: string;
 }
+/** Command preset defaults */
+interface ICommandPresetConfig {
+    /** Preset root directory (absolute path) */
+    root?: string;
+    /** Default preset options file */
+    opt?: string;
+    /** Default preset envs file */
+    env?: string;
+}
+/** Runtime file stats abstraction */
+interface ICommandRuntimeStats {
+    isDirectory(): boolean;
+}
+/** Runtime abstraction for environment-dependent operations */
+interface ICommandRuntime {
+    /** Current working directory */
+    cwd(): string;
+    /** Path absolute check */
+    isAbsolute(filepath: string): boolean;
+    /** Resolve paths into an absolute path */
+    resolve(...paths: string[]): string;
+    /** Read UTF-8 text file */
+    readFile(filepath: string): Promise<string>;
+    /** Stat file system entry */
+    stat(filepath: string): Promise<ICommandRuntimeStats>;
+}
 /** Command configuration */
 interface ICommandConfig {
     /** Command name (only for root command) */
@@ -133,14 +155,20 @@ interface ICommandConfig {
     version?: string;
     /** Built-in features configuration */
     builtin?: boolean | ICommandBuiltinConfig;
+    /** Command-level preset defaults */
+    preset?: ICommandPresetConfig;
     /** Default reporter for this command */
     reporter?: IReporter;
+    /** Runtime adapter for environment-dependent operations */
+    runtime?: ICommandRuntime;
 }
 /** Command interface */
 interface ICommand {
     readonly name: string | undefined;
     readonly description: string;
     readonly version: string | undefined;
+    readonly builtin: ICommandConfig['builtin'] | undefined;
+    readonly preset: ICommandPresetConfig | undefined;
     readonly parent: ICommand | undefined;
     readonly options: ICommandOptionConfig[];
     readonly arguments: ICommandArgumentConfig[];
@@ -151,12 +179,16 @@ interface ICommand {
 interface ICommandContext {
     /** Current command node */
     cmd: ICommand;
-    /** Environment variables */
+    /** Command chain from root to leaf */
+    chain: ICommand[];
+    /** Effective environment variables */
     envs: Record<string, string | undefined>;
+    /** Built-in control hit status */
+    controls: ICommandControls;
+    /** Input source snapshots */
+    sources: ICommandInputSources;
     /** Reporter instance */
     reporter: IReporter;
-    /** Original argv */
-    argv: string[];
 }
 /** Action callback parameters */
 interface ICommandActionParams {
@@ -185,11 +217,29 @@ type ICommandParsedOpts = Record<string, unknown>;
 /** Parsed arguments record */
 type ICommandParsedArgs = Record<string, unknown>;
 /** Route stage result */
-interface ICommandRouteResult {
+interface ICommandRouteResult<TCommand = ICommand> {
     /** Command chain from root to leaf */
-    chain: ICommand[];
+    chain: TCommand[];
     /** Remaining argv after routing */
     remaining: string[];
+    /** Routed command tokens from user argv (name/alias) */
+    cmds: string[];
+}
+/** Control-scan stage result */
+interface ICommandControlScanResult {
+    /** Built-in control hit status */
+    controls: ICommandControls;
+    /** Remaining argv after stripping control tokens */
+    remaining: string[];
+    /** Optional target token from `help <child>` syntax */
+    helpTarget?: string;
+}
+/** Preset stage result */
+interface ICommandPresetResult {
+    /** Effective tail argv after preset merge */
+    tailArgv: string[];
+    /** Effective envs after preset merge */
+    envs: Record<string, string | undefined>;
 }
 /** Tokenize stage result */
 interface ICommandTokenizeResult {
@@ -223,8 +273,29 @@ interface ICommandParseResult {
     /** Raw argument strings */
     rawArgs: string[];
 }
+/** Input source snapshots for debugging/tracing */
+interface ICommandInputSources {
+    preset: {
+        argv: string[];
+        envs: Record<string, string>;
+    };
+    user: {
+        /** Routed command tokens (name/alias as entered by user) */
+        cmds: string[];
+        /** Clean user tail argv after removing command chain/control/preset directives */
+        argv: string[];
+        /** Raw env snapshot from run/parse params */
+        envs: Record<string, string | undefined>;
+    };
+}
+/** Built-in run controls */
+interface ICommandControls {
+    help: boolean;
+    version: boolean;
+}
 /** Built-in option resolution result (internal) */
 interface ICommandBuiltinOptionResolved {
+    version: boolean;
     color: boolean;
     logLevel: boolean;
     silent: boolean;
@@ -234,9 +305,6 @@ interface ICommandBuiltinOptionResolved {
 /** Built-in config resolution result (internal) */
 interface ICommandBuiltinResolved {
     option: ICommandBuiltinOptionResolved;
-    command: {
-        help: boolean;
-    };
 }
 /** Subcommand registry entry (internal) */
 interface ISubcommandEntry<TCommand = ICommand> {
@@ -244,11 +312,6 @@ interface ISubcommandEntry<TCommand = ICommand> {
     aliases: string[];
     command: TCommand;
 }
-/** Internal route result */
-interface IInternalRouteResult<TCommand = ICommand> {
-    chain: TCommand[];
-    remaining: string[];
-}
 /** Help option line (internal) */
 interface IHelpOptionLine {
     sig: string;
@@ -325,13 +388,21 @@ interface ICompletionCommandConfig {
     /** Program name for completion scripts (defaults to root.name) */
     programName?: string;
     /** Default completion file paths for each shell */
-    paths: ICompletionPaths;
+    paths?: Partial<ICompletionPaths>;
 }
 
+/**
+ * Node runtime adapter
+ *
+ * @module @guanghechen/commander
+ */
+
+declare function createNodeCommandRuntime(): ICommandRuntime;
+
 /**
  * Command class - CLI command builder with fluent API
  *
- * Execution flow: route → tokenize → resolve → parse → run
+ * Execution flow: route → control-scan → run-control(run) → preset → tokenize → resolve → parse → run
  *
  * @module @guanghechen/commander
  */
@@ -342,6 +413,8 @@ declare class Command implements ICommand {
     get name(): string | undefined;
     get description(): string;
     get version(): string | undefined;
+    get builtin(): ICommandConfig['builtin'] | undefined;
+    get preset(): ICommandPresetConfig | undefined;
     get parent(): Command | undefined;
     get options(): ICommandOptionConfig[];
     get arguments(): ICommandArgumentConfig[];
@@ -353,7 +426,7 @@ declare class Command implements ICommand {
     example(title: string, usage: string, desc: string): this;
     subcommand(name: string, cmd: Command): this;
     run(params: ICommandRunParams): Promise<void>;
-    parse(params: ICommandRunParams): ICommandParseResult;
+    parse(params: ICommandRunParams): Promise<ICommandParseResult>;
     formatHelp(): string;
     getCompletionMeta(): ICompletionMeta;
 }
@@ -382,51 +455,6 @@ declare function isIpv6(rawValue: string): boolean;
 declare function isIp(rawValue: string): boolean;
 declare function isDomain(rawValue: string): boolean;
 
-/**
- * Shell completion generators
- *
- * @module @guanghechen/commander
- */
-
-/**
- * Built-in completion command that generates shell completion scripts.
- *
- * @example
- * ```typescript
- * const root = new Command({ name: 'mycli', desc: 'My CLI' })
- * root.subcommand('completion', new CompletionCommand(root, {
- *   paths: {
- *     bash: `~/.local/share/bash-completion/completions/mycli`,
- *     fish: `~/.config/fish/completions/mycli.fish`,
- *     pwsh: `~/.config/powershell/Microsoft.PowerShell_profile.ps1`,
- *   }
- * }))
- *
- * // Usage:
- * // mycli completion --bash > ~/.local/share/bash-completion/completions/mycli
- * // mycli completion --fish --write  (writes to default path)
- * // mycli completion --fish --write /custom/path.fish
- * ```
- */
-declare class CompletionCommand extends Command {
-    constructor(root: Command, config: ICompletionCommandConfig);
-}
-declare class BashCompletion {
-    #private;
-    constructor(meta: ICompletionMeta, programName: string);
-    generate(): string;
-}
-declare class FishCompletion {
-    #private;
-    constructor(meta: ICompletionMeta, programName: string);
-    generate(): string;
-}
-declare class PwshCompletion {
-    #private;
-    constructor(meta: ICompletionMeta, programName: string);
-    generate(): string;
-}
-
 /**
  * Pre-defined common options for @guanghechen/commander
  *
@@ -510,5 +538,67 @@ declare const logColorfulOption: ICommandOptionConfig<boolean>;
  */
 declare const silentOption: ICommandOptionConfig<boolean>;
 
-export { BashCompletion, Coerce, Command, CommanderError, CompletionCommand, FishCompletion, PwshCompletion, isDomain, isIp, isIpv4, isIpv6, logColorfulOption, logDateOption, logLevelOption, silentOption };
-export type { ICommand, ICommandAction, ICommandActionParams, ICommandArgumentConfig, ICommandArgumentKind, ICommandArgumentType, ICommandBuiltinCommandConfig, ICommandBuiltinConfig, ICommandBuiltinOptionConfig, ICommandBuiltinOptionResolved, ICommandBuiltinResolved, ICommandConfig, ICommandContext, ICommandExample, ICommandOptionArgs, ICommandOptionConfig, ICommandOptionType, ICommandParseResult, ICommandParsedArgs, ICommandParsedOpts, ICommandResolveResult, ICommandRouteResult, ICommandRunParams, ICommandShiftResult, ICommandToken, ICommandTokenType, ICommandTokenizeResult, ICommanderErrorKind, ICompletionCommandConfig, ICompletionMeta, ICompletionOptionMeta, ICompletionPaths, ICompletionShellType, IHelpCommandLine, IHelpData, IHelpExampleLine, IHelpOptionLine, IInternalRouteResult, ISubcommandEntry };
+/**
+ * Browser runtime adapter
+ *
+ * @module @guanghechen/commander
+ */
+
+declare function createBrowserCommandRuntime(): ICommandRuntime;
+
+/**
+ * Runtime adapters
+ *
+ * @module @guanghechen/commander
+ */
+
+declare function getDefaultCommandRuntime(): ICommandRuntime;
+declare function setDefaultCommandRuntime(runtime: ICommandRuntime): void;
+
+/**
+ * Shell completion generators
+ *
+ * @module @guanghechen/commander
+ */
+
+/**
+ * Built-in completion command that generates shell completion scripts.
+ *
+ * @example
+ * ```typescript
+ * const root = new Command({ name: 'mycli', desc: 'My CLI' })
+ * root.subcommand('completion', new CompletionCommand(root, {
+ *   paths: {
+ *     bash: `~/.local/share/bash-completion/completions/mycli`,
+ *     fish: `~/.config/fish/completions/mycli.fish`,
+ *     pwsh: `~/.config/powershell/Microsoft.PowerShell_profile.ps1`,
+ *   }
+ * }))
+ *
+ * // Usage:
+ * // mycli completion --bash > ~/.local/share/bash-completion/completions/mycli
+ * // mycli completion --fish --write  (writes to default path)
+ * // mycli completion --fish --write /custom/path.fish
+ * ```
+ */
+declare class CompletionCommand extends Command {
+    constructor(root: Command, config?: ICompletionCommandConfig);
+}
+declare class BashCompletion {
+    #private;
+    constructor(meta: ICompletionMeta, programName: string);
+    generate(): string;
+}
+declare class FishCompletion {
+    #private;
+    constructor(meta: ICompletionMeta, programName: string);
+    generate(): string;
+}
+declare class PwshCompletion {
+    #private;
+    constructor(meta: ICompletionMeta, programName: string);
+    generate(): string;
+}
+
+export { BashCompletion, Coerce, Command, CommanderError, CompletionCommand, FishCompletion, PwshCompletion, createBrowserCommandRuntime, createNodeCommandRuntime, getDefaultCommandRuntime, isDomain, isIp, isIpv4, isIpv6, logColorfulOption, logDateOption, logLevelOption, setDefaultCommandRuntime, silentOption };
+export type { ICommand, ICommandAction, ICommandActionParams, ICommandArgumentConfig, ICommandArgumentKind, ICommandArgumentType, ICommandBuiltinConfig, ICommandBuiltinOptionConfig, ICommandBuiltinOptionResolved, ICommandBuiltinResolved, ICommandConfig, ICommandContext, ICommandControlScanResult, ICommandControls, ICommandExample, ICommandInputSources, ICommandOptionArgs, ICommandOptionConfig, ICommandOptionType, ICommandParseResult, ICommandParsedArgs, ICommandParsedOpts, ICommandPresetConfig, ICommandPresetResult, ICommandResolveResult, ICommandRouteResult, ICommandRunParams, ICommandRuntime, ICommandRuntimeStats, ICommandShiftResult, ICommandToken, ICommandTokenType, ICommandTokenizeResult, ICommanderErrorKind, ICompletionCommandConfig, ICompletionMeta, ICompletionOptionMeta, ICompletionPaths, ICompletionShellType, IHelpCommandLine, IHelpData, IHelpExampleLine, IHelpOptionLine, ISubcommandEntry };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@guanghechen/commander",
-  "version": "4.5.1",
+  "version": "4.7.0",
   "description": "A minimal, type-safe command-line interface builder with fluent API",
   "author": {
     "name": "guanghechen",
@@ -20,17 +20,20 @@
   ],
   "type": "module",
   "exports": {
-    ".": {
-      "types": "./lib/types/index.d.ts",
-      "source": "./src/index.ts",
-      "import": "./lib/esm/index.mjs",
-      "require": "./lib/cjs/index.cjs"
+    ".": null,
+    "./browser": {
+      "types": "./lib/types/browser.d.ts",
+      "source": "./src/runtime/browser/entry.ts",
+      "import": "./lib/esm/browser.mjs",
+      "require": "./lib/cjs/browser.cjs"
+    },
+    "./node": {
+      "types": "./lib/types/node.d.ts",
+      "source": "./src/runtime/node/index.ts",
+      "import": "./lib/esm/node.mjs",
+      "require": "./lib/cjs/node.cjs"
     }
   },
-  "source": "./src/index.ts",
-  "main": "./lib/cjs/index.cjs",
-  "module": "./lib/esm/index.mjs",
-  "types": "./lib/types/index.d.ts",
   "license": "MIT",
   "files": [
     "lib/",
@@ -41,7 +44,8 @@
     "README.md"
   ],
   "dependencies": {
-    "@guanghechen/reporter": "^3.3.0"
+    "@guanghechen/reporter": "^3.3.0",
+    "@guanghechen/env": "^2.0.2"
   },
   "scripts": {
     "build": "rollup -c ../../rollup.config.mjs",