@karmaniverous/get-dotenv 3.0.6 → 3.1.0

package/dist/default/lib/getDotenvCli.js

@@ -0,0 +1,191 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getDotenvCli = void 0;
+var _commander = require("commander");
+var _execa = require("execa");
+var _dotenvExpand = require("./dotenvExpand.js");
+var _getDotenv = require("./getDotenv.js");
+var _options = require("./options.js");
+// npm imports
+
+// lib imports
+
+/**
+ * GetDotenv CLI Pre-hook Callback type. Transforms inbound options & executes side effects.
+ *
+ * @async
+ * @callback GetDotenvPreHookCallback
+ * @param {GetDotenvCliOptions} options - inbound GetDotenv CLI Options object
+ * @returns {GetDotenvCliOptions} transformed GetDotenv CLI Options object (undefined return value is ignored)
+ */
+
+/**
+ * GetDotenv CLI Post-hook Callback type. Executes side effects within getdotenv context.
+ *
+ * @async
+ * @callback GetDotenvPostHookCallback
+ * @param {object} dotenv - dotenv object
+ */
+
+/**
+ * Generate a CLI for get-dotenv.
+ *
+ * @function getDotenvCli
+ * @param {object} [options] - options object
+ * @param {string} [options.alias] - cli alias (used for cli help)
+ * @param {string} [options.command] - {@link https://github.com/motdotla/dotenv-expand/blob/master/tests/.env dotenv-expanded} shell command string
+ * @param {bool} [options.debug] - debug mode
+ * @param {string} [options.defaultEnv] - default target environment
+ * @param {string} [options.description] - cli description (used for cli help)
+ * @param {string} [options.dotenvToken] - {@link https://github.com/motdotla/dotenv-expand/blob/master/tests/.env dotenv-expanded} token indicating a dotenv file
+ * @param {string} [options.dynamicPath] - path to file exporting an object keyed to dynamic variable functions
+ * @param {bool} [options.excludeDynamic] - exclude dynamic dotenv variables
+ * @param {bool} [options.excludeEnv] - exclude environment-specific dotenv variables
+ * @param {bool} [options.excludeGlobal] - exclude global dotenv variables
+ * @param {bool} [options.excludePrivate] - exclude private dotenv variables
+ * @param {bool} [options.excludePublic] - exclude public dotenv variables
+ * @param {bool} [options.loadProcess] - load variables to process.env
+ * @param {bool} [options.log] - log result to console
+ * @param {function} [options.logger] - logger function
+ * @param {string} [options.outputPath] - consolidated output file, {@link https://github.com/motdotla/dotenv-expand/blob/master/tests/.env dotenv-expanded} using loaded env vars
+ * @param {string} [options.paths] - {@link https://github.com/motdotla/dotenv-expand/blob/master/tests/.env dotenv-expanded} delimited list of input directory paths
+ * @param {string} [options.pathsDelimiter] - paths delimiter string
+ * @param {string} [options.pathsDelimiterPattern] - paths delimiter regex pattern
+ * @param {GetDotenvPreHookCallback} [config.preHook] - transforms cli options & executes side effects
+ * @param {string} [options.privateToken] - {@link https://github.com/motdotla/dotenv-expand/blob/master/tests/.env dotenv-expanded} token indicating private variables
+ * @param {GetDotenvPostHookCallback} [config.postHook] - executes side effects within getdotenv context
+ * @param {string} [options.vars] - {@link https://github.com/motdotla/dotenv-expand/blob/master/tests/.env dotenv-expanded} delimited list of explicit environment variable key-value pairs
+ * @param {string} [options.varsAssignor] - variable key-value assignor string
+ * @param {string} [options.varsAssignorPattern] - variable key-value assignor regex pattern
+ * @param {string} [options.varsDelimiter] - variable key-value pair delimiter string
+ * @param {string} [options.varsDelimiterPattern] - variable key-value pair delimiter regex pattern
+ * @returns {object} The CLI command.
+ */
+const getDotenvCli = function () {
+  let {
+    logger = console.log,
+    preHook,
+    postHook,
+    ...cliOptions
+  } = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  let {
+    alias,
+    command,
+    debug,
+    defaultEnv,
+    description,
+    dotenvToken,
+    dynamicPath,
+    env,
+    excludeDynamic,
+    excludeEnv,
+    excludeGlobal,
+    excludePrivate,
+    excludePublic,
+    loadProcess,
+    log,
+    outputPath,
+    paths,
+    pathsDelimiter,
+    pathsDelimiterPattern,
+    privateToken,
+    vars,
+    varsAssignor,
+    varsAssignorPattern,
+    varsDelimiter,
+    varsDelimiterPattern
+  } = {
+    ..._options.cliDefaultOptions,
+    ...cliOptions
+  };
+  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, vars).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 {
+      args
+    } = _ref;
+    if (args.length) await (0, _execa.execaCommand)(args.join('\\ '), {
+      stdio: 'inherit',
+      shell: true
+    });
+  }), {
+    isDefault: true
+  }).hook('preSubcommand', async thisCommand => {
+    const rawOptions = thisCommand.opts();
+    if (rawOptions.debug) logger('\n*** raw options ***\n', {
+      rawOptions
+    });
+
+    // Load options.
+    let {
+      command,
+      debugOff,
+      excludeAllOff,
+      excludeDynamicOff,
+      excludeEnvOff,
+      excludeGlobalOff,
+      excludePrivateOff,
+      excludePublicOff,
+      loadProcessOff,
+      logOff,
+      ...cliOptions
+    } = rawOptions;
+
+    // Resolve flags.
+    const resolveExclusion = (exclude, excludeOff, defaultValue) => exclude ? true : excludeOff ? false : defaultValue;
+    const resolveExclusionAll = (exclude, excludeOff, defaultValue) => excludeAll && !excludeOff ? true : excludeAllOff && !exclude ? false : defaultValue;
+    cliOptions.debug = resolveExclusion(cliOptions.debug, debugOff, debug);
+    cliOptions.excludeDynamic = resolveExclusionAll(cliOptions.excludeDynamic, excludeDynamicOff, excludeDynamic);
+    cliOptions.excludeEnv = resolveExclusionAll(cliOptions.excludeEnv, excludeEnvOff, excludeEnv);
+    cliOptions.excludeGlobal = resolveExclusionAll(cliOptions.excludeGlobal, excludeGlobalOff, excludeGlobal);
+    cliOptions.excludePrivate = resolveExclusionAll(cliOptions.excludePrivate, excludePrivateOff, excludePrivate);
+    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', {
+      cliOptions
+    });
+
+    // Execute pre-hook.
+    if (preHook) {
+      cliOptions = (await preHook(cliOptions)) ?? cliOptions;
+      if (cliOptions.debug) logger('\n*** after pre-hook ***\n', cliOptions);
+    }
+
+    // Get getdotenv options from parent command.
+    const parentGetdotenvOptions = process.env['getdotenvOptions'] ? JSON.parse(process.env['getdotenvOptions']) : {};
+    const cliGetdotenvOptions = (0, _options.cli2getdotenvOptions)(cliOptions);
+    const getdotenvOptions = {
+      ...parentGetdotenvOptions,
+      ...cliGetdotenvOptions
+    };
+    if (cliOptions.debug) logger('\n*** after getdotenv option resolution ***\n', {
+      parentGetdotenvOptions,
+      cliGetdotenvOptions,
+      getdotenvOptions
+    });
+
+    // Execute getdotenv.
+    const dotenv = await (0, _getDotenv.getDotenv)({
+      ...getdotenvOptions,
+      logger
+    });
+    if (cliOptions.debug) console.log('\n*** after getdotenv execution ***\n', {
+      dotenv
+    });
+
+    // Execute post-hook.
+    if (postHook) await postHook(dotenv);
+
+    // Execute shell command.
+    if (command) await (0, _execa.execaCommand)(command.replace(/ /g, '\\ '), {
+      stdio: 'inherit',
+      shell: true
+    });
+  });
+};
+exports.getDotenvCli = getDotenvCli;

package/dist/default/lib/index.js

@@ -9,16 +9,16 @@ Object.defineProperty(exports, "dotenvExpand", {
     return _dotenvExpand.dotenvExpand;
   }
 });
-Object.defineProperty(exports, "getCli", {
+Object.defineProperty(exports, "getDotenv", {
   enumerable: true,
   get: function () {
-    return _getCli.getCli;
+    return _getDotenv.getDotenv;
   }
 });
-Object.defineProperty(exports, "getDotenv", {
+Object.defineProperty(exports, "getDotenvCli", {
   enumerable: true,
   get: function () {
-    return _getDotenv.getDotenv;
+    return _getDotenvCli.getDotenvCli;
   }
 });
 Object.defineProperty(exports, "getDotenvSync", {
@@ -29,4 +29,4 @@ Object.defineProperty(exports, "getDotenvSync", {
 });
 var _dotenvExpand = require("./dotenvExpand.js");
 var _getDotenv = require("./getDotenv.js");
-var _getCli = require("./getCli.js");
+var _getDotenvCli = require("./getDotenvCli.js");

package/dist/default/lib/options.js

@@ -0,0 +1,51 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getdotenvDefaultOptions = exports.cliDefaultOptions = exports.cli2getdotenvOptions = void 0;
+var _fsExtra = _interopRequireDefault(require("fs-extra"));
+var _lodash = _interopRequireDefault(require("lodash.frompairs"));
+var _lodash2 = _interopRequireDefault(require("lodash.pick"));
+var _pkgDir = require("pkg-dir");
+var _path = require("path");
+var _url = require("url");
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+// npm imports
+
+const _dirname = (0, _path.dirname)((0, _url.fileURLToPath)(import.meta.url));
+
+// Load default options.
+const cliDefaultOptionsGlobalPath = (0, _path.resolve)(_dirname, '../getdotenv.config.json');
+const cliDefaultOptionsGlobal = (await _fsExtra.default.exists(cliDefaultOptionsGlobalPath)) ? JSON.parse(await _fsExtra.default.readFile(cliDefaultOptionsGlobalPath)) : {};
+const cliDefaultOptionsLocalPath = (0, _path.resolve)(await (0, _pkgDir.packageDirectory)(), 'getdotenv.config.json');
+const cliDefaultOptionsLocal = (await _fsExtra.default.exists(cliDefaultOptionsLocalPath)) ? JSON.parse(await _fsExtra.default.readFile(cliDefaultOptionsLocalPath)) : {};
+const cliDefaultOptions = {
+  ...cliDefaultOptionsGlobal,
+  ...cliDefaultOptionsLocal
+};
+exports.cliDefaultOptions = cliDefaultOptions;
+const cli2getdotenvOptions = function () {
+  let {
+    env,
+    defaultEnv,
+    paths,
+    pathsDelimiter,
+    pathsDelimiterPattern,
+    vars,
+    varsAssignor,
+    varsAssignorPattern,
+    varsDelimiter,
+    varsDelimiterPattern,
+    ...rest
+  } = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  return {
+    ...(0, _lodash2.default)(rest, ['dotenvToken', 'dynamicPath', 'excludeDynamic', 'excludeEnv', 'excludeGlobal', 'excludePrivate', 'excludePublic', 'loadProcess', 'log', 'outputPath', 'privateToken']),
+    env: env ?? defaultEnv,
+    paths: (paths === null || paths === void 0 ? void 0 : paths.split(pathsDelimiterPattern ? RegExp(pathsDelimiterPattern) : pathsDelimiter)) ?? [],
+    vars: (0, _lodash.default)(vars === null || vars === void 0 ? void 0 : vars.split(varsDelimiterPattern ? RegExp(varsDelimiterPattern) : varsDelimiter).map(v => v.split(varsAssignorPattern ? RegExp(varsAssignorPattern) : varsAssignor)))
+  };
+};
+exports.cli2getdotenvOptions = cli2getdotenvOptions;
+const getdotenvDefaultOptions = cli2getdotenvOptions(cliDefaultOptions);
+exports.getdotenvDefaultOptions = getdotenvDefaultOptions;

package/dist/default/lib/readDotenv.js

@@ -20,7 +20,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  */
 const readDotenv = async path => {
   try {
-    return (0, _dotenv.parse)(await _fsExtra.default.readFile(path));
+    return (await _fsExtra.default.exists(path)) ? (0, _dotenv.parse)(await _fsExtra.default.readFile(path)) : {};
   } catch {
     return {};
   }
@@ -39,7 +39,7 @@ const readDotenv = async path => {
 exports.readDotenv = readDotenv;
 const readDotenvSync = path => {
   try {
-    return (0, _dotenv.parse)(_fsExtra.default.readFileSync(path));
+    return _fsExtra.default.existsSync(path) ? (0, _dotenv.parse)(_fsExtra.default.readFileSync(path)) : {};
   } catch {
     return {};
   }

package/getdotenv.config.json

@@ -0,0 +1,24 @@
+{
+  "alias": "getdotenv",
+  "debug": false,
+  "defaultEnv": "dev",
+  "description": "Base CLI.",
+  "dotenvToken": ".env",
+  "dynamicPath": "./env/dynamic.js",
+  "excludeDynamic": false,
+  "excludeEnv": false,
+  "excludeGlobal": false,
+  "excludePrivate": false,
+  "excludePublic": false,
+  "loadProcess": true,
+  "log": false,
+  "paths": "./ ./env",
+  "pathsDelimiter": " ",
+  "pathsDelimiterPattern": "\\s+",
+  "privateToken": "local",
+  "vars": "",
+  "varsAssignor": "=",
+  "varsAssignorPattern": "=",
+  "varsDelimiter": " ",
+  "varsDelimiterPattern": "\\s+"
+}

package/lib/getDotenv.js

@@ -1,18 +1,27 @@
 // npm imports
 import { expand } from 'dotenv-expand';
 import fs from 'fs-extra';
+import pickBy from 'lodash.pickby';
 import path from 'path';
 import { nanoid } from 'nanoid';
 
 // lib imports
-import { dotenvDefaults } from './dotenvDefaults.js';
+import { getdotenvDefaultOptions } from './options.js';
 import { readDotenv, readDotenvSync } from './readDotenv.js';
 
+const pruneVars = (getdotenvDefaultOptions, options) =>
+  pickBy(
+    {
+      ...(getdotenvDefaultOptions.vars ?? {}),
+      ...(options.vars ?? {}),
+    },
+    (v) => v?.length
+  );
+
 /**
  * get-dotenv options type
  *
- * @typedef {Object} OptionsType
- *
+ * @typedef {Object} GetDotenvOptions
  * @property {string} [dotenvToken] - token indicating a dotenv file
  * @property {string} [dynamicPath] - path to file exporting an object keyed to dynamic variable functions
  * @property {string} [env] - target environment
@@ -36,7 +45,7 @@ import { readDotenv, readDotenvSync } from './readDotenv.js';
  * @async
  * @function getDotenv
  *
- * @param {OptionsType} [options] - options object
+ * @param {GetDotenvOptions} [options] - options object
  *
  * @returns {Promise<object>} The combined parsed dotenv object.
  */
@@ -44,8 +53,8 @@ export const getDotenv = async (options = {}) => {
   // Apply defaults.
   let {
     dotenvToken,
-    env,
     dynamicPath,
+    env,
     excludeDynamic,
     excludeEnv,
     excludeGlobal,
@@ -53,12 +62,13 @@ export const getDotenv = async (options = {}) => {
     excludePublic,
     loadProcess,
     log,
-    logger,
+    logger = console.log,
     outputPath,
     paths,
     privateToken,
-    vars = {},
-  } = { ...dotenvDefaults, ...options };
+  } = { ...getdotenvDefaultOptions, ...options };
+
+  const vars = pruneVars(getdotenvDefaultOptions, options);
 
   // Read .env files.
   const loaded = await paths.reduce(async (e, p) => {
@@ -103,7 +113,7 @@ export const getDotenv = async (options = {}) => {
   });
 
   // Process dynamic variables.
-  if (dynamicPath && !excludeDynamic) {
+  if (dynamicPath && !excludeDynamic && (await fs.exists(dynamicPath))) {
     const dynamic = new Function(
       `return ${(await fs.readFile(dynamicPath)).toString()}`
     )()(dotenv);
@@ -142,8 +152,8 @@ export const getDotenv = async (options = {}) => {
     Object.assign(process.env, dotenv, {
       getdotenvOptions: JSON.stringify({
         dotenvToken,
-        env,
         dynamicPath,
+        env,
         excludeDynamic,
         excludeEnv,
         excludeGlobal,
@@ -165,7 +175,7 @@ export const getDotenv = async (options = {}) => {
  *
  * @function getDotenvSync
  *
- * @param {OptionsType} [options] - options object
+ * @param {GetDotenvOptions} [options] - options object
  *
  * @returns {Object} The combined parsed dotenv object.
  */
@@ -173,8 +183,8 @@ export const getDotenvSync = (options = {}) => {
   // Apply defaults.
   let {
     dotenvToken,
-    env,
     dynamicPath,
+    env,
     excludeDynamic,
     excludeEnv,
     excludeGlobal,
@@ -182,11 +192,13 @@ export const getDotenvSync = (options = {}) => {
     excludePublic,
     loadProcess,
     log,
+    logger = console.log,
     outputPath,
     paths,
     privateToken,
-    vars,
-  } = { ...dotenvDefaults, ...options };
+  } = { ...getdotenvDefaultOptions, ...options };
+
+  const vars = pruneVars(getdotenvDefaultOptions, options);
 
   // Read .env files.
   const loaded = paths.reduce((e, p) => {
@@ -229,7 +241,7 @@ export const getDotenvSync = (options = {}) => {
   });
 
   // Process dynamic variables.
-  if (dynamicPath && !excludeDynamic) {
+  if (dynamicPath && !excludeDynamic && fs.existsSync(dynamicPath)) {
     const dynamic = new Function(
       `return ${fs.readFileSync(dynamicPath).toString()}`
     )()(dotenv);
@@ -261,7 +273,7 @@ export const getDotenvSync = (options = {}) => {
   }
 
   // Log result.
-  if (log) console.log(dotenv);
+  if (log) logger(dotenv);
 
   // Load process.env.
   if (loadProcess)