@karmaniverous/get-dotenv 5.2.5 → 6.0.0-0

package/dist/cliHost.d.ts

@@ -1,4 +1,4 @@
-import { Command } from 'commander';
+import { Command, Option } from 'commander';
 import { ZodType } from 'zod';
 
 /**
@@ -50,27 +50,6 @@ type ScriptsTable<TShell extends string | boolean = string | boolean> = Record<s
     shell?: TShell;
 }>;
 
-/**
- * Adapter-layer augmentation: add chainable helpers to GetDotenvCli without
- * coupling the core host to cliCore. Importing this module has side effects:
- * it extends the prototype and merges types for consumers.
- */
-declare module '../cliHost/GetDotenvCli' {
-    interface GetDotenvCli {
-        /**
-         * Attach legacy root flags to this CLI instance. Defaults come from
-         * baseRootOptionDefaults when none are provided.     */
-        attachRootOptions(defaults?: Partial<RootOptionsShape>, opts?: {
-            includeCommandOption?: boolean;
-        }): this;
-        /**
-         * Install a preSubcommand hook that merges CLI flags (including parent
-         * round-trip) and resolves the dotenv context before executing actions.
-         * Defaults come from baseRootOptionDefaults when none are provided.
-         */ passOptions(defaults?: Partial<RootOptionsShape>): this;
-    }
-}
-
 /**
  * A minimal representation of an environment key/value mapping.
  * Values may be `undefined` to represent "unset". */ type ProcessEnv = Record<string, string | undefined>;
@@ -252,6 +231,75 @@ interface GetDotenvCliOptions extends Omit<GetDotenvOptions, 'paths' | 'vars'> {
     varsDelimiterPattern?: string;
 }
 
+/** src/cliHost/definePlugin.ts
+ * Plugin contracts for the GetDotenv CLI host.
+ *
+ * This module exposes a structural public interface for the host that plugins
+ * should use (GetDotenvCliPublic). Using a structural type at the seam avoids
+ * nominal class identity issues (private fields) in downstream consumers.
+ */
+
+/**
+ * Structural public interface for the host exposed to plugins.
+ * - Extends Commander.Command so plugins can attach options/commands/hooks.
+ * - Adds host-specific helpers used by built-in plugins.
+ *
+ * Purpose: remove nominal class identity (private fields) from the plugin seam
+ * to avoid TS2379 under exactOptionalPropertyTypes in downstream consumers.
+ */
+type GetDotenvCliPublic<TOptions extends GetDotenvOptions = GetDotenvOptions> = Command & {
+    ns: (name: string) => Command;
+    getCtx: () => GetDotenvCliCtx<TOptions> | undefined;
+    resolveAndLoad: (customOptions?: Partial<TOptions>) => Promise<GetDotenvCliCtx<TOptions>>;
+};
+/** Public plugin contract used by the GetDotenv CLI host. */
+interface GetDotenvCliPlugin {
+    id?: string;
+    /**
+     * Setup phase: register commands and wiring on the provided CLI instance.
+     * Runs parent → children (pre-order).
+     */
+    setup: (cli: GetDotenvCliPublic) => void | Promise<void>;
+    /**
+     * After the dotenv context is resolved, initialize any clients/secrets
+     * or attach per-plugin state under ctx.plugins (by convention).
+     * Runs parent → children (pre-order).
+     */
+    afterResolve?: (cli: GetDotenvCliPublic, ctx: GetDotenvCliCtx) => void | Promise<void>;
+    /**
+     * Optional Zod schema for this plugin's config slice (from config.plugins[id]).
+     * When provided, the host validates the merged config under the guarded loader path.
+     */
+    configSchema?: ZodType;
+    /**
+     * Compositional children. Installed after the parent per pre-order.
+     */
+    children: GetDotenvCliPlugin[];
+    /**
+     * Compose a child plugin. Returns the parent to enable chaining.
+     */
+    use: (child: GetDotenvCliPlugin) => GetDotenvCliPlugin;
+}
+/**
+ * Public spec type for defining a plugin with optional children.
+ * Exported to ensure TypeDoc links and navigation resolve correctly.
+ */
+type DefineSpec = Omit<GetDotenvCliPlugin, 'children' | 'use'> & {
+    children?: GetDotenvCliPlugin[];
+};
+/**
+ * Define a GetDotenv CLI plugin with compositional helpers.
+ *
+ * @example
+ * const parent = definePlugin(\{ id: 'p', setup(cli) \{ /* ... *\/ \} \})
+ *   .use(childA)
+ *   .use(childB);
+ */
+declare const definePlugin: (spec: DefineSpec) => GetDotenvCliPlugin;
+
+type ResolvedHelpConfig = Partial<GetDotenvOptions> & {
+    plugins: Record<string, unknown>;
+};
 /** * Per-invocation context shared with plugins and actions. */
 type GetDotenvCliCtx<TOptions extends GetDotenvOptions = GetDotenvOptions> = {
     optionsResolved: TOptions;
@@ -271,7 +319,7 @@ declare const HELP_HEADER_SYMBOL: unique symbol;
  *
  * NOTE: This host is additive and does not alter the legacy CLI.
  */
-declare class GetDotenvCli<TOptions extends GetDotenvOptions = GetDotenvOptions> extends Command {
+declare class GetDotenvCli$1<TOptions extends GetDotenvOptions = GetDotenvOptions> extends Command {
     #private;
     /** Registered top-level plugins (composition happens via .use()) */
     private _plugins;
@@ -279,11 +327,45 @@ declare class GetDotenvCli<TOptions extends GetDotenvOptions = GetDotenvOptions>
     private _installed;
     /** Optional header line to prepend in help output */
     private [HELP_HEADER_SYMBOL];
+    /**
+     * Create a subcommand using the same subclass, preserving helpers like
+     * dynamicOption on children.
+     */
+    createCommand(name?: string): Command;
     constructor(alias?: string);
     /**
-     * Resolve options (strict) and compute dotenv context.   * Stores the context on the instance under a symbol.
+     * Resolve options (strict) and compute dotenv context.
+     * Stores the context on the instance under a symbol.
+     *
+     * Options:
+     * - opts.runAfterResolve (default true): when false, skips running plugin
+     *   afterResolve hooks. Useful for top-level help rendering to avoid
+     *   long-running side-effects while still evaluating dynamic help text.
+     */
+    resolveAndLoad(customOptions?: Partial<TOptions>, opts?: {
+        runAfterResolve?: boolean;
+    }): Promise<GetDotenvCliCtx<TOptions>>;
+    /**
+     * Create a Commander Option that computes its description at help time.
+     * The returned Option may be configured (conflicts, default, parser) and
+     * added via addOption().
+     */
+    createDynamicOption<TPlugins = Record<string, unknown>>(flags: string, desc: (cfg: ResolvedHelpConfig & {
+        plugins: TPlugins;
+    }) => string, parser?: (value: string, previous?: unknown) => unknown, defaultValue?: unknown): Option;
+    /**
+     * Chainable helper mirroring .option(), but with a dynamic description.
+     * Equivalent to addOption(createDynamicOption(...)).
+     */
+    dynamicOption<TPlugins = Record<string, unknown>>(flags: string, desc: (cfg: ResolvedHelpConfig & {
+        plugins: TPlugins;
+    }) => string, parser?: (value: string, previous?: unknown) => unknown, defaultValue?: unknown): this;
+    /**
+     * Evaluate dynamic descriptions for this command and all descendants using
+     * the provided resolved configuration. Mutates the Option.description in
+     * place so Commander help renders updated text.
      */
-    resolveAndLoad(customOptions?: Partial<TOptions>): Promise<GetDotenvCliCtx<TOptions>>;
+    evaluateDynamicOptions(resolved: ResolvedHelpConfig): void;
     /**
      * Retrieve the current invocation context (if any).
      */
@@ -315,6 +397,11 @@ declare class GetDotenvCli<TOptions extends GetDotenvOptions = GetDotenvOptions>
         importMetaUrl?: string;
         helpHeader?: string;
     }): Promise<this>;
+    /**
+     * Insert grouped plugin/app options between "Options" and "Commands" for
+     * hybrid ordering. Applies to root and any parent command.
+     */
+    helpInformation(): string;
     /**
      * Register a plugin for installation (parent level).
      * Installation occurs on first resolveAndLoad() (or explicit install()).
@@ -331,72 +418,29 @@ declare class GetDotenvCli<TOptions extends GetDotenvOptions = GetDotenvOptions>
     private _runAfterResolve;
 }
 
-/** src/cliHost/definePlugin.ts
- * Plugin contracts for the GetDotenv CLI host.
- *
- * This module exposes a structural public interface for the host that plugins
- * should use (GetDotenvCliPublic). Using a structural type at the seam avoids
- * nominal class identity issues (private fields) in downstream consumers.
- */
-
 /**
- * Structural public interface for the host exposed to plugins.
- * - Extends Commander.Command so plugins can attach options/commands/hooks.
- * - Adds host-specific helpers used by built-in plugins.
- *
- * Purpose: remove nominal class identity (private fields) from the plugin seam
- * to avoid TS2379 under exactOptionalPropertyTypes in downstream consumers.
+ * GetDotenvCli with root helpers as real class methods.
+ * - attachRootOptions: installs legacy/base root flags on the command.
+ * - passOptions: merges flags (parent \< current), computes dotenv context once,
+ *   runs validation, and persists merged options for nested flows.
  */
-type GetDotenvCliPublic<TOptions extends GetDotenvOptions = GetDotenvOptions> = Command & {
-    ns: (name: string) => Command;
-    getCtx: () => GetDotenvCliCtx<TOptions> | undefined;
-    resolveAndLoad: (customOptions?: Partial<TOptions>) => Promise<GetDotenvCliCtx<TOptions>>;
-};
-/** Public plugin contract used by the GetDotenv CLI host. */
-interface GetDotenvCliPlugin {
-    id?: string;
-    /**
-     * Setup phase: register commands and wiring on the provided CLI instance.
-     * Runs parent → children (pre-order).
-     */
-    setup: (cli: GetDotenvCliPublic) => void | Promise<void>;
-    /**
-     * After the dotenv context is resolved, initialize any clients/secrets
-     * or attach per-plugin state under ctx.plugins (by convention).
-     * Runs parent → children (pre-order).
-     */
-    afterResolve?: (cli: GetDotenvCliPublic, ctx: GetDotenvCliCtx) => void | Promise<void>;
+declare class GetDotenvCli extends GetDotenvCli$1 {
     /**
-     * Optional Zod schema for this plugin's config slice (from config.plugins[id]).
-     * When provided, the host validates the merged config under the guarded loader path.
+     * Attach legacy root flags to this CLI instance. Defaults come from
+     * baseRootOptionDefaults when none are provided.
      */
-    configSchema?: ZodType;
+    attachRootOptions(defaults?: Partial<RootOptionsShape>, opts?: {
+        includeCommandOption?: boolean;
+    }): this;
     /**
-     * Compositional children. Installed after the parent per pre-order.
+     * Install preSubcommand/preAction hooks that:
+     * - Merge options (parent round-trip + current invocation) using resolveCliOptions.
+     * - Persist the merged bag on the current command and on the host (for ergonomics).
+     * - Compute the dotenv context once via resolveAndLoad(serviceOptions).
+     * - Validate the composed env against discovered config (warn or --strict fail).
      */
-    children: GetDotenvCliPlugin[];
-    /**
-     * Compose a child plugin. Returns the parent to enable chaining.
-     */
-    use: (child: GetDotenvCliPlugin) => GetDotenvCliPlugin;
+    passOptions(defaults?: Partial<RootOptionsShape>): this;
 }
-/**
- * Public spec type for defining a plugin with optional children.
- * Exported to ensure TypeDoc links and navigation resolve correctly.
- */
-type DefineSpec = Omit<GetDotenvCliPlugin, 'children' | 'use'> & {
-    children?: GetDotenvCliPlugin[];
-};
-/**
- * Define a GetDotenv CLI plugin with compositional helpers.
- *
- * @example
- * const parent = definePlugin(\{ id: 'p', setup(cli) \{ /* ... *\/ \} \})
- *   .use(childA)
- *   .use(childB);
- */
-declare const definePlugin: (spec: DefineSpec) => GetDotenvCliPlugin;
-
 /**
  * Helper to retrieve the merged root options bag from any action handler
  * that only has access to thisCommand. Avoids structural casts.