@karmaniverous/get-dotenv 5.2.0 → 5.2.2

package/dist/index.d.cts

@@ -49,6 +49,27 @@ 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;
+    }
+}
+
 type RootOptionsShapeCompat = Omit<RootOptionsShape, 'vars' | 'paths'> & {
     vars?: string | Record<string, string | undefined>;
     paths?: string | string[];
@@ -415,5 +436,25 @@ declare const getDotenv: (options?: Partial<GetDotenvOptions>) => Promise<Proces
  */
 declare const interpolateDeep: <T>(value: T, envRef: ProcessEnv) => T;
 
-export { defineDynamic, dotenvExpand, dotenvExpandAll, dotenvExpandFromProcessEnv, generateGetDotenvCli, getDotenv, getDotenvCliOptions2Options, interpolateDeep };
-export type { GetDotenvDynamic, GetDotenvOptions, ProcessEnv };
+/**
+ * Create a get-dotenv CLI host with included plugins.
+ *
+ * Options:
+ * - alias: command name used for help/argv scaffolding (default: "getdotenv")
+ * - branding: optional help header; when omitted, brand() uses "<alias> v<version>"
+ *
+ * Usage:
+ *   import \{ createCli \} from '\@karmaniverous/get-dotenv';
+ *   await createCli(\{ alias: 'getdotenv', branding: 'getdotenv vX.Y.Z' \})
+ *     .run(process.argv.slice(2));
+ */
+type CreateCliOptions = {
+    alias?: string;
+    branding?: string;
+};
+declare function createCli(opts?: CreateCliOptions): {
+    run: (argv: string[]) => Promise<void>;
+};
+
+export { createCli, defineDynamic, dotenvExpand, dotenvExpandAll, dotenvExpandFromProcessEnv, generateGetDotenvCli, getDotenv, getDotenvCliOptions2Options, interpolateDeep };
+export type { CreateCliOptions, GetDotenvDynamic, GetDotenvOptions, ProcessEnv };

package/dist/index.d.mts

@@ -49,6 +49,27 @@ 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;
+    }
+}
+
 type RootOptionsShapeCompat = Omit<RootOptionsShape, 'vars' | 'paths'> & {
     vars?: string | Record<string, string | undefined>;
     paths?: string | string[];
@@ -415,5 +436,25 @@ declare const getDotenv: (options?: Partial<GetDotenvOptions>) => Promise<Proces
  */
 declare const interpolateDeep: <T>(value: T, envRef: ProcessEnv) => T;
 
-export { defineDynamic, dotenvExpand, dotenvExpandAll, dotenvExpandFromProcessEnv, generateGetDotenvCli, getDotenv, getDotenvCliOptions2Options, interpolateDeep };
-export type { GetDotenvDynamic, GetDotenvOptions, ProcessEnv };
+/**
+ * Create a get-dotenv CLI host with included plugins.
+ *
+ * Options:
+ * - alias: command name used for help/argv scaffolding (default: "getdotenv")
+ * - branding: optional help header; when omitted, brand() uses "<alias> v<version>"
+ *
+ * Usage:
+ *   import \{ createCli \} from '\@karmaniverous/get-dotenv';
+ *   await createCli(\{ alias: 'getdotenv', branding: 'getdotenv vX.Y.Z' \})
+ *     .run(process.argv.slice(2));
+ */
+type CreateCliOptions = {
+    alias?: string;
+    branding?: string;
+};
+declare function createCli(opts?: CreateCliOptions): {
+    run: (argv: string[]) => Promise<void>;
+};
+
+export { createCli, defineDynamic, dotenvExpand, dotenvExpandAll, dotenvExpandFromProcessEnv, generateGetDotenvCli, getDotenv, getDotenvCliOptions2Options, interpolateDeep };
+export type { CreateCliOptions, GetDotenvDynamic, GetDotenvOptions, ProcessEnv };

package/dist/index.d.ts

@@ -49,6 +49,27 @@ 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;
+    }
+}
+
 type RootOptionsShapeCompat = Omit<RootOptionsShape, 'vars' | 'paths'> & {
     vars?: string | Record<string, string | undefined>;
     paths?: string | string[];
@@ -415,5 +436,25 @@ declare const getDotenv: (options?: Partial<GetDotenvOptions>) => Promise<Proces
  */
 declare const interpolateDeep: <T>(value: T, envRef: ProcessEnv) => T;
 
-export { defineDynamic, dotenvExpand, dotenvExpandAll, dotenvExpandFromProcessEnv, generateGetDotenvCli, getDotenv, getDotenvCliOptions2Options, interpolateDeep };
-export type { GetDotenvDynamic, GetDotenvOptions, ProcessEnv };
+/**
+ * Create a get-dotenv CLI host with included plugins.
+ *
+ * Options:
+ * - alias: command name used for help/argv scaffolding (default: "getdotenv")
+ * - branding: optional help header; when omitted, brand() uses "<alias> v<version>"
+ *
+ * Usage:
+ *   import \{ createCli \} from '\@karmaniverous/get-dotenv';
+ *   await createCli(\{ alias: 'getdotenv', branding: 'getdotenv vX.Y.Z' \})
+ *     .run(process.argv.slice(2));
+ */
+type CreateCliOptions = {
+    alias?: string;
+    branding?: string;
+};
+declare function createCli(opts?: CreateCliOptions): {
+    run: (argv: string[]) => Promise<void>;
+};
+
+export { createCli, defineDynamic, dotenvExpand, dotenvExpandAll, dotenvExpandFromProcessEnv, generateGetDotenvCli, getDotenv, getDotenvCliOptions2Options, interpolateDeep };
+export type { CreateCliOptions, GetDotenvDynamic, GetDotenvOptions, ProcessEnv };