@karmaniverous/get-dotenv 3.1.5 → 3.1.7

package/README.md

@@ -7,7 +7,7 @@ Load environment variables with a cascade of environment-aware dotenv files. You
 - Define dynamic variables progressively in terms of other variables and other logic.
 - Exclude public, private, global, environment-specific, or dynamic variables.
 - Specify explicit variables to include.
-- Extract the resulting variables to an object, `process.env`, a dotenv file, or a logger, in any combination.
+- Extract the resulting variables to an object, `process.env`, a dotenv file, or a logger object, in any combination.
 - Execute a shell command within the resulting environment. You can even nest additional `getdotenv` calls!
 - Specify the directories containing your dotenv files.
 - Specify the filename token that identifies dotenv files (e.g. '.env').
@@ -235,7 +235,7 @@ get-dotenv options type
 | [excludePublic] | <code>bool</code> | exclude public variables |
 | [loadProcess] | <code>bool</code> | load dotenv to process.env |
 | [log] | <code>bool</code> | log result to logger |
-| [logger] | <code>function</code> | logger function |
+| [logger] | <code>function</code> | logger object (defaults to console) |
 | [outputPath] | <code>string</code> | if populated, writes consolidated .env file to this path (follows [dotenv-expand rules](https://github.com/motdotla/dotenv-expand/blob/master/tests/.env)) |
 | [paths] | <code>Array.&lt;string&gt;</code> | array of input directory paths |
 | [privateToken] | <code>string</code> | token indicating private variables |

package/bin/getdotenv/index.js

@@ -1,4 +1,4 @@
-#!/usr/bin/env node
+#!/usr/bin/env node
 
 // lib imports
 import { getDotenvCli } from '../../lib/getDotenvCli.js';

package/dist/default/lib/getDotenv.js

@@ -35,7 +35,7 @@ const pruneVars = (getdotenvDefaultOptions, options) => (0, _lodash.default)({
  * @property {bool} [excludePublic] - exclude public variables
  * @property {bool} [loadProcess] - load dotenv to process.env
  * @property {bool} [log] - log result to logger
- * @property {function} [logger] - logger function
+ * @property {function} [logger] - logger object (defaults to console)
  * @property {string} [outputPath] - if populated, writes consolidated .env file to this path (follows {@link https://github.com/motdotla/dotenv-expand/blob/master/tests/.env dotenv-expand rules})
  * @property {string[]} [paths] - array of input directory paths
  * @property {string} [privateToken] - token indicating private variables
@@ -66,7 +66,7 @@ const getDotenv = async function () {
     excludePublic,
     loadProcess,
     log,
-    logger = console.log,
+    logger = console,
     outputPath,
     paths,
     privateToken
@@ -159,7 +159,7 @@ const getDotenvSync = function () {
     excludePublic,
     loadProcess,
     log,
-    logger = console.log,
+    logger = console,
     outputPath,
     paths,
     privateToken

package/dist/default/lib/getDotenvCli.js

@@ -66,7 +66,7 @@ var _options = require("./options.js");
  */
 const getDotenvCli = function () {
   let {
-    logger = console.log,
+    logger = console,
     preHook,
     postHook,
     ...cliOptionsCustom
@@ -104,10 +104,10 @@ const getDotenvCli = function () {
   const excludeAll = excludeDynamic && (excludeEnv && excludeGlobal || excludePrivate && excludePublic);
   return new _commander.Command().name(alias).description(description).enablePositionalOptions().passThroughOptions().option('-e, --env <string>', 'target environment', _dotenvExpand.dotenvExpand, env).option('-v, --vars <string>', `dotenv-expanded delimited key-value pairs: ${[['KEY1', 'VAL1'], ['KEY2', 'VAL2']].map(v => v.join(varsAssignor)).join(varsDelimiter)}`, _dotenvExpand.dotenvExpand).option('-c, --command <string>', 'dotenv-expanded shell command string', _dotenvExpand.dotenvExpand, command).option('-o, --output-path <string>', 'consolidated output file, follows dotenv-expand rules using loaded env vars', _dotenvExpand.dotenvExpand, outputPath).addOption(new _commander.Option('-p, --load-process', `load variables to process.env ON${loadProcess ? ' (default)' : ''}`).conflicts('loadProcessOff')).addOption(new _commander.Option('-P, --load-process-off', `load variables to process.env OFF${!loadProcess ? ' (default)' : ''}`).conflicts('loadProcess')).addOption(new _commander.Option('-a, --exclude-all', `exclude all dotenv variables from loading ON${excludeAll ? ' (default)' : ''}`).conflicts('excludeAllOff')).addOption(new _commander.Option('-A, --exclude-all-off', `exclude all dotenv variables from loading OFF${!excludeAll ? ' (default)' : ''}`).conflicts('excludeAll')).addOption(new _commander.Option('-z, --exclude-dynamic', `exclude dynamic dotenv variables from loading ON${excludeDynamic ? ' (default)' : ''}`).conflicts('excludeDynamicOff')).addOption(new _commander.Option('-Z, --exclude-dynamic-off', `exclude dynamic dotenv variables from loading OFF${!excludeDynamic ? ' (default)' : ''}`).conflicts('excludeDynamic')).addOption(new _commander.Option('-n, --exclude-env', `exclude environment-specific dotenv variables from loading${excludeEnv ? ' (default)' : ''}`).conflicts('excludeEnvOff')).addOption(new _commander.Option('-N, --exclude-env-off', `exclude environment-specific dotenv variables from loading OFF${!excludeEnv ? ' (default)' : ''}`).conflicts('excludeEnv')).addOption(new _commander.Option('-g, --exclude-global', `exclude global dotenv variables from loading ON${excludeGlobal ? ' (default)' : ''}`).conflicts('excludeGlobalOff')).addOption(new _commander.Option('-G, --exclude-global-off', `exclude global dotenv variables from loading OFF${!excludeGlobal ? ' (default)' : ''}`).conflicts('excludeGlobal')).addOption(new _commander.Option('-r, --exclude-private', `exclude private dotenv variables from loading ON${excludePrivate ? ' (default)' : ''}`).conflicts('excludePrivateOff')).addOption(new _commander.Option('-R, --exclude-private-off', `exclude private dotenv variables from loading OFF${!excludePrivate ? ' (default)' : ''}`).conflicts('excludePrivate')).addOption(new _commander.Option('-u, --exclude-public', `exclude public dotenv variables from loading ON${excludePublic ? ' (default)' : ''}`).conflicts('excludePublicOff')).addOption(new _commander.Option('-U, --exclude-public-off', `exclude public dotenv variables from loading OFF${!excludePublic ? ' (default)' : ''}`).conflicts('excludePublic')).addOption(new _commander.Option('-l, --log', `console log loaded variables ON${log ? ' (default)' : ''}`).conflicts('logOff')).addOption(new _commander.Option('-L, --log-off', `console log loaded variables OFF${!log ? ' (default)' : ''}`).conflicts('log')).addOption(new _commander.Option('-d, --debug', `debug mode ON${debug ? ' (default)' : ''}`).conflicts('debugOff')).addOption(new _commander.Option('-D, --debug-off', `debug mode OFF${!debug ? ' (default)' : ''}`).conflicts('debug')).option('--default-env <string>', 'default target environment', _dotenvExpand.dotenvExpand, defaultEnv).option('--dotenv-token <string>', 'dotenv-expanded token indicating a dotenv file', _dotenvExpand.dotenvExpand, dotenvToken).option('--dynamic-path <string>', 'dynamic variables path', _dotenvExpand.dotenvExpand, dynamicPath).option('--paths <string>', 'dotenv-expanded delimited list of paths to dotenv directory', _dotenvExpand.dotenvExpand, paths).option('--paths-delimiter <string>', 'paths delimiter string', pathsDelimiter).option('--paths-delimiter-pattern <string>', 'paths delimiter regex pattern', pathsDelimiterPattern).option('--private-token <string>', 'dotenv-expanded token indicating private variables', _dotenvExpand.dotenvExpand, privateToken).option('--vars-delimiter <string>', 'vars delimiter string', varsDelimiter).option('--vars-delimiter-pattern <string>', 'vars delimiter regex pattern', varsDelimiterPattern).option('--vars-assignor <string>', 'vars assignment operator string', varsAssignor).option('--vars-assignor-pattern <string>', 'vars assignment operator regex pattern', varsAssignorPattern).addCommand(new _commander.Command().name('cmd').description('execute shell command string (default command)').configureHelp({
     showGlobalOptions: true
-  }).enablePositionalOptions().passThroughOptions().action(async (options, _ref) => {
-    let {
+  }).enablePositionalOptions().passThroughOptions().action(async (options, command) => {
+    const {
       args
-    } = _ref;
+    } = command;
     if (args.length) await (0, _execa.execaCommand)(args.join('\\ '), {
       stdio: 'inherit',
       shell: true
@@ -116,7 +116,7 @@ const getDotenvCli = function () {
     isDefault: true
   }).hook('preSubcommand', async thisCommand => {
     const rawOptions = thisCommand.opts();
-    if (rawOptions.debug) logger('\n*** raw options ***\n', {
+    if (rawOptions.debug) logger('\n*** raw cli options ***\n', {
       rawOptions
     });
 
@@ -146,14 +146,14 @@ const getDotenvCli = function () {
     cliOptions.excludePublic = resolveExclusionAll(cliOptions.excludePublic, excludePublicOff, excludePublic);
     cliOptions.log = resolveExclusion(cliOptions.log, logOff, log);
     cliOptions.loadProcess = resolveExclusion(cliOptions.loadProcess, loadProcessOff, loadProcess);
-    if (cliOptions.debug) logger('\n*** after default resolution ***\n', {
+    if (cliOptions.debug) logger('\n*** cli options after default resolution ***\n', {
       cliOptions
     });
 
     // Execute pre-hook.
     if (preHook) {
       cliOptions = (await preHook(cliOptions)) ?? cliOptions;
-      if (cliOptions.debug) logger('\n*** after pre-hook ***\n', cliOptions);
+      if (cliOptions.debug) logger('\n*** cli options after pre-hook ***\n', cliOptions);
     }
 
     // Get getdotenv options from parent command.
@@ -163,23 +163,24 @@ const getDotenvCli = function () {
       ...parentGetdotenvOptions,
       ...cliGetdotenvOptions
     };
-    if (cliOptions.debug) logger('\n*** after getdotenv option resolution ***\n', {
+    if (cliOptions.debug) logger('\n*** getdotenv option resolution ***\n', {
       parentGetdotenvOptions,
       cliGetdotenvOptions,
       getdotenvOptions
     });
 
     // Execute getdotenv.
-    const dotenv = await (0, _getDotenv.getDotenv)({
+    thisCommand.getdotenvOptions = {
       ...getdotenvOptions,
       logger
-    });
-    if (cliOptions.debug) console.log('\n*** after getdotenv execution ***\n', {
-      dotenv
+    };
+    thisCommand.dotenv = await (0, _getDotenv.getDotenv)(thisCommand.getdotenvOptions);
+    if (cliOptions.debug) console.log('\n*** resulting dotenv values ***\n', {
+      dotenv: thisCommand.dotenv
     });
 
     // Execute post-hook.
-    if (postHook) await postHook(dotenv);
+    if (postHook) await postHook(thisCommand.dotenv);
 
     // Execute shell command.
     if (command) await (0, _execa.execaCommand)(command.replace(/ /g, '\\ '), {

package/lib/getDotenv.js

@@ -32,7 +32,7 @@ const pruneVars = (getdotenvDefaultOptions, options) =>
  * @property {bool} [excludePublic] - exclude public variables
  * @property {bool} [loadProcess] - load dotenv to process.env
  * @property {bool} [log] - log result to logger
- * @property {function} [logger] - logger function
+ * @property {function} [logger] - logger object (defaults to console)
  * @property {string} [outputPath] - if populated, writes consolidated .env file to this path (follows {@link https://github.com/motdotla/dotenv-expand/blob/master/tests/.env dotenv-expand rules})
  * @property {string[]} [paths] - array of input directory paths
  * @property {string} [privateToken] - token indicating private variables
@@ -62,7 +62,7 @@ export const getDotenv = async (options = {}) => {
     excludePublic,
     loadProcess,
     log,
-    logger = console.log,
+    logger = console,
     outputPath,
     paths,
     privateToken,
@@ -175,7 +175,7 @@ export const getDotenvSync = (options = {}) => {
     excludePublic,
     loadProcess,
     log,
-    logger = console.log,
+    logger = console,
     outputPath,
     paths,
     privateToken,

package/lib/getDotenvCli.js

@@ -63,7 +63,7 @@ import {
  * @returns {object} The CLI command.
  */
 export const getDotenvCli = ({
-  logger = console.log,
+  logger = console,
   preHook,
   postHook,
   ...cliOptionsCustom
@@ -326,7 +326,8 @@ export const getDotenvCli = ({
         .configureHelp({ showGlobalOptions: true })
         .enablePositionalOptions()
         .passThroughOptions()
-        .action(async (options, { args }) => {
+        .action(async (options, command) => {
+          const { args } = command;
           if (args.length)
             await execaCommand(args.join('\\ '), {
               stdio: 'inherit',
@@ -338,7 +339,8 @@ export const getDotenvCli = ({
     .hook('preSubcommand', async (thisCommand) => {
       const rawOptions = thisCommand.opts();
 
-      if (rawOptions.debug) logger('\n*** raw options ***\n', { rawOptions });
+      if (rawOptions.debug)
+        logger('\n*** raw cli options ***\n', { rawOptions });
 
       // Load options.
       let {
@@ -407,12 +409,15 @@ export const getDotenvCli = ({
       );
 
       if (cliOptions.debug)
-        logger('\n*** after default resolution ***\n', { cliOptions });
+        logger('\n*** cli options after default resolution ***\n', {
+          cliOptions,
+        });
 
       // Execute pre-hook.
       if (preHook) {
         cliOptions = (await preHook(cliOptions)) ?? cliOptions;
-        if (cliOptions.debug) logger('\n*** after pre-hook ***\n', cliOptions);
+        if (cliOptions.debug)
+          logger('\n*** cli options after pre-hook ***\n', cliOptions);
       }
 
       // Get getdotenv options from parent command.
@@ -428,20 +433,26 @@ export const getDotenvCli = ({
       };
 
       if (cliOptions.debug)
-        logger('\n*** after getdotenv option resolution ***\n', {
+        logger('\n*** getdotenv option resolution ***\n', {
           parentGetdotenvOptions,
           cliGetdotenvOptions,
           getdotenvOptions,
         });
 
       // Execute getdotenv.
-      const dotenv = await getDotenv({ ...getdotenvOptions, logger });
+      thisCommand.getdotenvOptions = {
+        ...getdotenvOptions,
+        logger,
+      };
+      thisCommand.dotenv = await getDotenv(thisCommand.getdotenvOptions);
 
       if (cliOptions.debug)
-        console.log('\n*** after getdotenv execution ***\n', { dotenv });
+        console.log('\n*** resulting dotenv values ***\n', {
+          dotenv: thisCommand.dotenv,
+        });
 
       // Execute post-hook.
-      if (postHook) await postHook(dotenv);
+      if (postHook) await postHook(thisCommand.dotenv);
 
       // Execute shell command.
       if (command)

package/package.json

@@ -3,7 +3,7 @@
   "bin": {
     "getdotenv": "bin/getdotenv/index.js"
   },
-  "version": "3.1.5",
+  "version": "3.1.7",
   "publishConfig": {
     "access": "public"
   },