@karmaniverous/get-dotenv 4.0.0-3 → 4.1.0

package/dist/index.d.cts

@@ -8,14 +8,14 @@ interface GetDotenvCliOptions extends Omit<GetDotenvOptions, 'paths' | 'vars'> {
      * Cli alias. Should align with the `bin` property in `package.json`.
      */
     alias?: string;
-    /**
-     * Cli description (appears in CLI help).
-     */
-    description?: string;
     /**
      * Logs CLI internals when true.
      */
     debug?: boolean;
+    /**
+     * Cli description (appears in CLI help).
+     */
+    description?: string;
     /**
      * A delimited string of paths to dotenv files.
      */
@@ -60,7 +60,7 @@ interface GetDotenvCliOptions extends Omit<GetDotenvOptions, 'paths' | 'vars'> {
 type ProcessEnv = Record<string, string | undefined>;
 type GetDotenvDynamicFunction = (vars: ProcessEnv) => string | undefined;
 type GetDotenvDynamic = Record<string, GetDotenvDynamicFunction | ReturnType<GetDotenvDynamicFunction>>;
-type Logger = Record<string, (...args: unknown[]) => void>;
+type Logger = Record<string, (...args: unknown[]) => void> | typeof console;
 /**
  * Options passed programmatically to `getDotenv` and `getDotEnvSync`.
  */
@@ -78,7 +78,7 @@ interface GetDotenvOptions {
      */
     dotenvToken?: string;
     /**
-     * path to file exporting an object keyed to dynamic variable functions
+     * path to JS module default-exporting an object keyed to dynamic variable functions
      */
     dynamicPath?: string;
     /**
@@ -86,31 +86,31 @@ interface GetDotenvOptions {
      */
     env?: string;
     /**
-     * exclude dynamic variables
+     * exclude dynamic variables from loading
      */
     excludeDynamic?: boolean;
     /**
-     * exclude environment-specific variables
+     * exclude environment-specific variables from loading
      */
     excludeEnv?: boolean;
     /**
-     * exclude global variables
+     * exclude global variables from loading
      */
     excludeGlobal?: boolean;
     /**
-     * exclude private variables
+     * exclude private variables from loading
      */
     excludePrivate?: boolean;
     /**
-     * exclude public variables
+     * exclude public variables from loading
      */
     excludePublic?: boolean;
     /**
-     * load dotenv to process.env
+     * load dotenv variables to `process.env`
      */
     loadProcess?: boolean;
     /**
-     * log result to logger
+     * log loaded dotenv variables to `logger`
      */
     log?: boolean;
     /**
@@ -118,7 +118,7 @@ interface GetDotenvOptions {
      */
     logger?: Logger;
     /**
-     * if populated, writes consolidated .env file to this path (follows dotenvExpand rules)
+     * if populated, writes consolidated dotenv file to this path (follows dotenvExpand rules)
      */
     outputPath?: string;
     /**
@@ -202,44 +202,11 @@ interface GetDotenvCliGenerateOptions extends Omit<GetDotenvCliOptions, 'env'> {
      */
     postHook?: GetDotenvCliPostHookCallback;
 }
+
 /**
  * Generate a Commander CLI Command for get-dotenv.
  */
-declare const generateGetDotenvCli: ({ logger, preHook, postHook, ...cliOptionsCustom }?: GetDotenvCliGenerateOptions) => Command<[], {
-    env?: string | undefined;
-    vars?: string | undefined;
-    command?: string | undefined;
-    outputPath?: string | undefined;
-    loadProcess?: true | undefined;
-    loadProcessOff?: true | undefined;
-    excludeAll?: true | undefined;
-    excludeAllOff?: true | undefined;
-    excludeDynamic?: true | undefined;
-    excludeDynamicOff?: true | undefined;
-    excludeEnv?: true | undefined;
-    excludeEnvOff?: true | undefined;
-    excludeGlobal?: true | undefined;
-    excludeGlobalOff?: true | undefined;
-    excludePrivate?: true | undefined;
-    excludePrivateOff?: true | undefined;
-    excludePublic?: true | undefined;
-    excludePublicOff?: true | undefined;
-    log?: true | undefined;
-    logOff?: true | undefined;
-    debug?: true | undefined;
-    debugOff?: true | undefined;
-    defaultEnv?: string | undefined;
-    dotenvToken?: string | undefined;
-    dynamicPath?: string | undefined;
-    paths?: string | undefined;
-    pathsDelimiter: string;
-    pathsDelimiterPattern: string;
-    privateToken?: string | undefined;
-    varsDelimiter: string;
-    varsDelimiterPattern: string;
-    varsAssignor: string;
-    varsAssignorPattern: string;
-}>;
+declare const generateGetDotenvCli: ({ logger, preHook, postHook, ...cliOptionsCustom }?: GetDotenvCliGenerateOptions) => Command;
 
 /**
  * Asynchronously process dotenv files of the form `.env[.<ENV>][.<PRIVATE_TOKEN>]`

package/dist/index.d.mts

@@ -8,14 +8,14 @@ interface GetDotenvCliOptions extends Omit<GetDotenvOptions, 'paths' | 'vars'> {
      * Cli alias. Should align with the `bin` property in `package.json`.
      */
     alias?: string;
-    /**
-     * Cli description (appears in CLI help).
-     */
-    description?: string;
     /**
      * Logs CLI internals when true.
      */
     debug?: boolean;
+    /**
+     * Cli description (appears in CLI help).
+     */
+    description?: string;
     /**
      * A delimited string of paths to dotenv files.
      */
@@ -60,7 +60,7 @@ interface GetDotenvCliOptions extends Omit<GetDotenvOptions, 'paths' | 'vars'> {
 type ProcessEnv = Record<string, string | undefined>;
 type GetDotenvDynamicFunction = (vars: ProcessEnv) => string | undefined;
 type GetDotenvDynamic = Record<string, GetDotenvDynamicFunction | ReturnType<GetDotenvDynamicFunction>>;
-type Logger = Record<string, (...args: unknown[]) => void>;
+type Logger = Record<string, (...args: unknown[]) => void> | typeof console;
 /**
  * Options passed programmatically to `getDotenv` and `getDotEnvSync`.
  */
@@ -78,7 +78,7 @@ interface GetDotenvOptions {
      */
     dotenvToken?: string;
     /**
-     * path to file exporting an object keyed to dynamic variable functions
+     * path to JS module default-exporting an object keyed to dynamic variable functions
      */
     dynamicPath?: string;
     /**
@@ -86,31 +86,31 @@ interface GetDotenvOptions {
      */
     env?: string;
     /**
-     * exclude dynamic variables
+     * exclude dynamic variables from loading
      */
     excludeDynamic?: boolean;
     /**
-     * exclude environment-specific variables
+     * exclude environment-specific variables from loading
      */
     excludeEnv?: boolean;
     /**
-     * exclude global variables
+     * exclude global variables from loading
      */
     excludeGlobal?: boolean;
     /**
-     * exclude private variables
+     * exclude private variables from loading
      */
     excludePrivate?: boolean;
     /**
-     * exclude public variables
+     * exclude public variables from loading
      */
     excludePublic?: boolean;
     /**
-     * load dotenv to process.env
+     * load dotenv variables to `process.env`
      */
     loadProcess?: boolean;
     /**
-     * log result to logger
+     * log loaded dotenv variables to `logger`
      */
     log?: boolean;
     /**
@@ -118,7 +118,7 @@ interface GetDotenvOptions {
      */
     logger?: Logger;
     /**
-     * if populated, writes consolidated .env file to this path (follows dotenvExpand rules)
+     * if populated, writes consolidated dotenv file to this path (follows dotenvExpand rules)
      */
     outputPath?: string;
     /**
@@ -202,44 +202,11 @@ interface GetDotenvCliGenerateOptions extends Omit<GetDotenvCliOptions, 'env'> {
      */
     postHook?: GetDotenvCliPostHookCallback;
 }
+
 /**
  * Generate a Commander CLI Command for get-dotenv.
  */
-declare const generateGetDotenvCli: ({ logger, preHook, postHook, ...cliOptionsCustom }?: GetDotenvCliGenerateOptions) => Command<[], {
-    env?: string | undefined;
-    vars?: string | undefined;
-    command?: string | undefined;
-    outputPath?: string | undefined;
-    loadProcess?: true | undefined;
-    loadProcessOff?: true | undefined;
-    excludeAll?: true | undefined;
-    excludeAllOff?: true | undefined;
-    excludeDynamic?: true | undefined;
-    excludeDynamicOff?: true | undefined;
-    excludeEnv?: true | undefined;
-    excludeEnvOff?: true | undefined;
-    excludeGlobal?: true | undefined;
-    excludeGlobalOff?: true | undefined;
-    excludePrivate?: true | undefined;
-    excludePrivateOff?: true | undefined;
-    excludePublic?: true | undefined;
-    excludePublicOff?: true | undefined;
-    log?: true | undefined;
-    logOff?: true | undefined;
-    debug?: true | undefined;
-    debugOff?: true | undefined;
-    defaultEnv?: string | undefined;
-    dotenvToken?: string | undefined;
-    dynamicPath?: string | undefined;
-    paths?: string | undefined;
-    pathsDelimiter: string;
-    pathsDelimiterPattern: string;
-    privateToken?: string | undefined;
-    varsDelimiter: string;
-    varsDelimiterPattern: string;
-    varsAssignor: string;
-    varsAssignorPattern: string;
-}>;
+declare const generateGetDotenvCli: ({ logger, preHook, postHook, ...cliOptionsCustom }?: GetDotenvCliGenerateOptions) => Command;
 
 /**
  * Asynchronously process dotenv files of the form `.env[.<ENV>][.<PRIVATE_TOKEN>]`

package/dist/index.d.ts

@@ -8,14 +8,14 @@ interface GetDotenvCliOptions extends Omit<GetDotenvOptions, 'paths' | 'vars'> {
      * Cli alias. Should align with the `bin` property in `package.json`.
      */
     alias?: string;
-    /**
-     * Cli description (appears in CLI help).
-     */
-    description?: string;
     /**
      * Logs CLI internals when true.
      */
     debug?: boolean;
+    /**
+     * Cli description (appears in CLI help).
+     */
+    description?: string;
     /**
      * A delimited string of paths to dotenv files.
      */
@@ -60,7 +60,7 @@ interface GetDotenvCliOptions extends Omit<GetDotenvOptions, 'paths' | 'vars'> {
 type ProcessEnv = Record<string, string | undefined>;
 type GetDotenvDynamicFunction = (vars: ProcessEnv) => string | undefined;
 type GetDotenvDynamic = Record<string, GetDotenvDynamicFunction | ReturnType<GetDotenvDynamicFunction>>;
-type Logger = Record<string, (...args: unknown[]) => void>;
+type Logger = Record<string, (...args: unknown[]) => void> | typeof console;
 /**
  * Options passed programmatically to `getDotenv` and `getDotEnvSync`.
  */
@@ -78,7 +78,7 @@ interface GetDotenvOptions {
      */
     dotenvToken?: string;
     /**
-     * path to file exporting an object keyed to dynamic variable functions
+     * path to JS module default-exporting an object keyed to dynamic variable functions
      */
     dynamicPath?: string;
     /**
@@ -86,31 +86,31 @@ interface GetDotenvOptions {
      */
     env?: string;
     /**
-     * exclude dynamic variables
+     * exclude dynamic variables from loading
      */
     excludeDynamic?: boolean;
     /**
-     * exclude environment-specific variables
+     * exclude environment-specific variables from loading
      */
     excludeEnv?: boolean;
     /**
-     * exclude global variables
+     * exclude global variables from loading
      */
     excludeGlobal?: boolean;
     /**
-     * exclude private variables
+     * exclude private variables from loading
      */
     excludePrivate?: boolean;
     /**
-     * exclude public variables
+     * exclude public variables from loading
      */
     excludePublic?: boolean;
     /**
-     * load dotenv to process.env
+     * load dotenv variables to `process.env`
      */
     loadProcess?: boolean;
     /**
-     * log result to logger
+     * log loaded dotenv variables to `logger`
      */
     log?: boolean;
     /**
@@ -118,7 +118,7 @@ interface GetDotenvOptions {
      */
     logger?: Logger;
     /**
-     * if populated, writes consolidated .env file to this path (follows dotenvExpand rules)
+     * if populated, writes consolidated dotenv file to this path (follows dotenvExpand rules)
      */
     outputPath?: string;
     /**
@@ -202,44 +202,11 @@ interface GetDotenvCliGenerateOptions extends Omit<GetDotenvCliOptions, 'env'> {
      */
     postHook?: GetDotenvCliPostHookCallback;
 }
+
 /**
  * Generate a Commander CLI Command for get-dotenv.
  */
-declare const generateGetDotenvCli: ({ logger, preHook, postHook, ...cliOptionsCustom }?: GetDotenvCliGenerateOptions) => Command<[], {
-    env?: string | undefined;
-    vars?: string | undefined;
-    command?: string | undefined;
-    outputPath?: string | undefined;
-    loadProcess?: true | undefined;
-    loadProcessOff?: true | undefined;
-    excludeAll?: true | undefined;
-    excludeAllOff?: true | undefined;
-    excludeDynamic?: true | undefined;
-    excludeDynamicOff?: true | undefined;
-    excludeEnv?: true | undefined;
-    excludeEnvOff?: true | undefined;
-    excludeGlobal?: true | undefined;
-    excludeGlobalOff?: true | undefined;
-    excludePrivate?: true | undefined;
-    excludePrivateOff?: true | undefined;
-    excludePublic?: true | undefined;
-    excludePublicOff?: true | undefined;
-    log?: true | undefined;
-    logOff?: true | undefined;
-    debug?: true | undefined;
-    debugOff?: true | undefined;
-    defaultEnv?: string | undefined;
-    dotenvToken?: string | undefined;
-    dynamicPath?: string | undefined;
-    paths?: string | undefined;
-    pathsDelimiter: string;
-    pathsDelimiterPattern: string;
-    privateToken?: string | undefined;
-    varsDelimiter: string;
-    varsDelimiterPattern: string;
-    varsAssignor: string;
-    varsAssignorPattern: string;
-}>;
+declare const generateGetDotenvCli: ({ logger, preHook, postHook, ...cliOptionsCustom }?: GetDotenvCliGenerateOptions) => Command;
 
 /**
  * Asynchronously process dotenv files of the form `.env[.<ENV>][.<PRIVATE_TOKEN>]`