@karmaniverous/get-dotenv 4.2.1 → 4.2.3

package/dist/index.d.cts

@@ -4,18 +4,10 @@ import { Command } from '@commander-js/extra-typings';
  * Options passed programmatically to `getDotenvCli`.
  */
 interface GetDotenvCliOptions extends Omit<GetDotenvOptions, 'paths' | 'vars'> {
-    /**
-     * CLI alias. Should align with the `bin` property in `package.json`.
-     */
-    alias?: string;
     /**
      * Logs CLI internals when true.
      */
     debug?: boolean;
-    /**
-     * Cli description (appears in CLI help).
-     */
-    description?: string;
     /**
      * A delimited string of paths to dotenv files.
      */
@@ -30,6 +22,10 @@ interface GetDotenvCliOptions extends Omit<GetDotenvOptions, 'paths' | 'vars'> {
      * `pathsDelimiter`.
      */
     pathsDelimiterPattern?: string;
+    /**
+     * Shell scripts that can be executed from the CLI, either individually or via the batch subcommand.
+     */
+    shellScripts?: Record<string, string>;
     /**
      * A delimited string of key-value pairs declaratively specifying variables &
      * values to be loaded in addition to any dotenv files.
@@ -62,13 +58,9 @@ type GetDotenvDynamicFunction = (vars: ProcessEnv) => string | undefined;
 type GetDotenvDynamic = Record<string, GetDotenvDynamicFunction | ReturnType<GetDotenvDynamicFunction>>;
 type Logger = Record<string, (...args: unknown[]) => void> | typeof console;
 /**
- * Options passed programmatically to `getDotenv` and `getDotEnvSync`.
+ * Options passed programmatically to `getDotenv`.
  */
 interface GetDotenvOptions {
-    /**
-     * log internals to logger
-     */
-    debug?: boolean;
     /**
      * default target environment (used if `env` is not provided)
      */
@@ -76,7 +68,7 @@ interface GetDotenvOptions {
     /**
      * token indicating a dotenv file
      */
-    dotenvToken?: string;
+    dotenvToken: string;
     /**
      * path to JS module default-exporting an object keyed to dynamic variable functions
      */
@@ -129,10 +121,6 @@ interface GetDotenvOptions {
      * filename token indicating private variables
      */
     privateToken?: string;
-    /**
-     * Shell scripts that can be executed from the CLI, either individually or via the batch subcommand.
-     */
-    shellScripts?: Record<string, string>;
     /**
      * explicit variables to include
      */
@@ -190,11 +178,23 @@ type GetDotenvCliPostHookCallback = (dotenv: ProcessEnv) => Promise<void>;
  * sets defaults that can be overridden by local `getdotenv.config.json` in
  * projects that import the CLI.
  */
-interface GetDotenvCliGenerateOptions extends Omit<GetDotenvCliOptions, 'env'> {
+interface GetDotenvCliGenerateOptions extends GetDotenvCliOptions {
+    /**
+     * CLI alias. Should align with the `bin` property in `package.json`.
+     */
+    alias: string;
+    /**
+     * Cli description (appears in CLI help).
+     */
+    description: string;
+    /**
+     * The `import.meta.url` of the module generating the CLI.
+     */
+    importMetaUrl: string;
     /**
      * Logger object (defaults to console)
      */
-    logger?: Logger;
+    logger: Logger;
     /**
      * Mutates inbound options & executes side effects within the `getDotenv`
      * context before executing CLI commands.
@@ -210,7 +210,7 @@ interface GetDotenvCliGenerateOptions extends Omit<GetDotenvCliOptions, 'env'> {
 /**
  * Generate a Commander CLI Command for get-dotenv.
  */
-declare const generateGetDotenvCli: ({ logger, preHook, postHook, ...cliOptionsCustom }?: GetDotenvCliGenerateOptions) => Command;
+declare const generateGetDotenvCli: (customOptions: Pick<GetDotenvCliGenerateOptions, 'importMetaUrl'> & Partial<Omit<GetDotenvCliGenerateOptions, 'importMetaUrl'>>) => Promise<Command>;
 
 /**
  * Asynchronously process dotenv files of the form `.env[.<ENV>][.<PRIVATE_TOKEN>]`
@@ -218,6 +218,6 @@ declare const generateGetDotenvCli: ({ logger, preHook, postHook, ...cliOptionsC
  * @param options - `GetDotenvOptions` object
  * @returns The combined parsed dotenv object.
  */
-declare const getDotenv: (options?: GetDotenvOptions) => Promise<ProcessEnv>;
+declare const getDotenv: (options?: Partial<GetDotenvOptions>) => Promise<ProcessEnv>;
 
 export { type GetDotenvDynamic, type GetDotenvOptions, type ProcessEnv, dotenvExpand, dotenvExpandAll, dotenvExpandFromProcessEnv, generateGetDotenvCli, getDotenv };

package/dist/index.d.mts

@@ -4,18 +4,10 @@ import { Command } from '@commander-js/extra-typings';
  * Options passed programmatically to `getDotenvCli`.
  */
 interface GetDotenvCliOptions extends Omit<GetDotenvOptions, 'paths' | 'vars'> {
-    /**
-     * CLI alias. Should align with the `bin` property in `package.json`.
-     */
-    alias?: string;
     /**
      * Logs CLI internals when true.
      */
     debug?: boolean;
-    /**
-     * Cli description (appears in CLI help).
-     */
-    description?: string;
     /**
      * A delimited string of paths to dotenv files.
      */
@@ -30,6 +22,10 @@ interface GetDotenvCliOptions extends Omit<GetDotenvOptions, 'paths' | 'vars'> {
      * `pathsDelimiter`.
      */
     pathsDelimiterPattern?: string;
+    /**
+     * Shell scripts that can be executed from the CLI, either individually or via the batch subcommand.
+     */
+    shellScripts?: Record<string, string>;
     /**
      * A delimited string of key-value pairs declaratively specifying variables &
      * values to be loaded in addition to any dotenv files.
@@ -62,13 +58,9 @@ type GetDotenvDynamicFunction = (vars: ProcessEnv) => string | undefined;
 type GetDotenvDynamic = Record<string, GetDotenvDynamicFunction | ReturnType<GetDotenvDynamicFunction>>;
 type Logger = Record<string, (...args: unknown[]) => void> | typeof console;
 /**
- * Options passed programmatically to `getDotenv` and `getDotEnvSync`.
+ * Options passed programmatically to `getDotenv`.
  */
 interface GetDotenvOptions {
-    /**
-     * log internals to logger
-     */
-    debug?: boolean;
     /**
      * default target environment (used if `env` is not provided)
      */
@@ -76,7 +68,7 @@ interface GetDotenvOptions {
     /**
      * token indicating a dotenv file
      */
-    dotenvToken?: string;
+    dotenvToken: string;
     /**
      * path to JS module default-exporting an object keyed to dynamic variable functions
      */
@@ -129,10 +121,6 @@ interface GetDotenvOptions {
      * filename token indicating private variables
      */
     privateToken?: string;
-    /**
-     * Shell scripts that can be executed from the CLI, either individually or via the batch subcommand.
-     */
-    shellScripts?: Record<string, string>;
     /**
      * explicit variables to include
      */
@@ -190,11 +178,23 @@ type GetDotenvCliPostHookCallback = (dotenv: ProcessEnv) => Promise<void>;
  * sets defaults that can be overridden by local `getdotenv.config.json` in
  * projects that import the CLI.
  */
-interface GetDotenvCliGenerateOptions extends Omit<GetDotenvCliOptions, 'env'> {
+interface GetDotenvCliGenerateOptions extends GetDotenvCliOptions {
+    /**
+     * CLI alias. Should align with the `bin` property in `package.json`.
+     */
+    alias: string;
+    /**
+     * Cli description (appears in CLI help).
+     */
+    description: string;
+    /**
+     * The `import.meta.url` of the module generating the CLI.
+     */
+    importMetaUrl: string;
     /**
      * Logger object (defaults to console)
      */
-    logger?: Logger;
+    logger: Logger;
     /**
      * Mutates inbound options & executes side effects within the `getDotenv`
      * context before executing CLI commands.
@@ -210,7 +210,7 @@ interface GetDotenvCliGenerateOptions extends Omit<GetDotenvCliOptions, 'env'> {
 /**
  * Generate a Commander CLI Command for get-dotenv.
  */
-declare const generateGetDotenvCli: ({ logger, preHook, postHook, ...cliOptionsCustom }?: GetDotenvCliGenerateOptions) => Command;
+declare const generateGetDotenvCli: (customOptions: Pick<GetDotenvCliGenerateOptions, 'importMetaUrl'> & Partial<Omit<GetDotenvCliGenerateOptions, 'importMetaUrl'>>) => Promise<Command>;
 
 /**
  * Asynchronously process dotenv files of the form `.env[.<ENV>][.<PRIVATE_TOKEN>]`
@@ -218,6 +218,6 @@ declare const generateGetDotenvCli: ({ logger, preHook, postHook, ...cliOptionsC
  * @param options - `GetDotenvOptions` object
  * @returns The combined parsed dotenv object.
  */
-declare const getDotenv: (options?: GetDotenvOptions) => Promise<ProcessEnv>;
+declare const getDotenv: (options?: Partial<GetDotenvOptions>) => Promise<ProcessEnv>;
 
 export { type GetDotenvDynamic, type GetDotenvOptions, type ProcessEnv, dotenvExpand, dotenvExpandAll, dotenvExpandFromProcessEnv, generateGetDotenvCli, getDotenv };

package/dist/index.d.ts

@@ -4,18 +4,10 @@ import { Command } from '@commander-js/extra-typings';
  * Options passed programmatically to `getDotenvCli`.
  */
 interface GetDotenvCliOptions extends Omit<GetDotenvOptions, 'paths' | 'vars'> {
-    /**
-     * CLI alias. Should align with the `bin` property in `package.json`.
-     */
-    alias?: string;
     /**
      * Logs CLI internals when true.
      */
     debug?: boolean;
-    /**
-     * Cli description (appears in CLI help).
-     */
-    description?: string;
     /**
      * A delimited string of paths to dotenv files.
      */
@@ -30,6 +22,10 @@ interface GetDotenvCliOptions extends Omit<GetDotenvOptions, 'paths' | 'vars'> {
      * `pathsDelimiter`.
      */
     pathsDelimiterPattern?: string;
+    /**
+     * Shell scripts that can be executed from the CLI, either individually or via the batch subcommand.
+     */
+    shellScripts?: Record<string, string>;
     /**
      * A delimited string of key-value pairs declaratively specifying variables &
      * values to be loaded in addition to any dotenv files.
@@ -62,13 +58,9 @@ type GetDotenvDynamicFunction = (vars: ProcessEnv) => string | undefined;
 type GetDotenvDynamic = Record<string, GetDotenvDynamicFunction | ReturnType<GetDotenvDynamicFunction>>;
 type Logger = Record<string, (...args: unknown[]) => void> | typeof console;
 /**
- * Options passed programmatically to `getDotenv` and `getDotEnvSync`.
+ * Options passed programmatically to `getDotenv`.
  */
 interface GetDotenvOptions {
-    /**
-     * log internals to logger
-     */
-    debug?: boolean;
     /**
      * default target environment (used if `env` is not provided)
      */
@@ -76,7 +68,7 @@ interface GetDotenvOptions {
     /**
      * token indicating a dotenv file
      */
-    dotenvToken?: string;
+    dotenvToken: string;
     /**
      * path to JS module default-exporting an object keyed to dynamic variable functions
      */
@@ -129,10 +121,6 @@ interface GetDotenvOptions {
      * filename token indicating private variables
      */
     privateToken?: string;
-    /**
-     * Shell scripts that can be executed from the CLI, either individually or via the batch subcommand.
-     */
-    shellScripts?: Record<string, string>;
     /**
      * explicit variables to include
      */
@@ -190,11 +178,23 @@ type GetDotenvCliPostHookCallback = (dotenv: ProcessEnv) => Promise<void>;
  * sets defaults that can be overridden by local `getdotenv.config.json` in
  * projects that import the CLI.
  */
-interface GetDotenvCliGenerateOptions extends Omit<GetDotenvCliOptions, 'env'> {
+interface GetDotenvCliGenerateOptions extends GetDotenvCliOptions {
+    /**
+     * CLI alias. Should align with the `bin` property in `package.json`.
+     */
+    alias: string;
+    /**
+     * Cli description (appears in CLI help).
+     */
+    description: string;
+    /**
+     * The `import.meta.url` of the module generating the CLI.
+     */
+    importMetaUrl: string;
     /**
      * Logger object (defaults to console)
      */
-    logger?: Logger;
+    logger: Logger;
     /**
      * Mutates inbound options & executes side effects within the `getDotenv`
      * context before executing CLI commands.
@@ -210,7 +210,7 @@ interface GetDotenvCliGenerateOptions extends Omit<GetDotenvCliOptions, 'env'> {
 /**
  * Generate a Commander CLI Command for get-dotenv.
  */
-declare const generateGetDotenvCli: ({ logger, preHook, postHook, ...cliOptionsCustom }?: GetDotenvCliGenerateOptions) => Command;
+declare const generateGetDotenvCli: (customOptions: Pick<GetDotenvCliGenerateOptions, 'importMetaUrl'> & Partial<Omit<GetDotenvCliGenerateOptions, 'importMetaUrl'>>) => Promise<Command>;
 
 /**
  * Asynchronously process dotenv files of the form `.env[.<ENV>][.<PRIVATE_TOKEN>]`
@@ -218,6 +218,6 @@ declare const generateGetDotenvCli: ({ logger, preHook, postHook, ...cliOptionsC
  * @param options - `GetDotenvOptions` object
  * @returns The combined parsed dotenv object.
  */
-declare const getDotenv: (options?: GetDotenvOptions) => Promise<ProcessEnv>;
+declare const getDotenv: (options?: Partial<GetDotenvOptions>) => Promise<ProcessEnv>;
 
 export { type GetDotenvDynamic, type GetDotenvOptions, type ProcessEnv, dotenvExpand, dotenvExpandAll, dotenvExpandFromProcessEnv, generateGetDotenvCli, getDotenv };