@karmaniverous/get-dotenv 3.1.19 → 4.0.0-1

package/dist/default/lib/getDotenvCli.js

@@ -1,202 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.getDotenvCli = void 0;
-var _commander = require("commander");
-var _execa = require("execa");
-var _os = _interopRequireDefault(require("os"));
-var _dotenvExpand = require("./dotenvExpand.js");
-var _getDotenv = require("./getDotenv.js");
-var _options = require("./options.js");
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-// npm imports
-
-// lib imports
-
-// Discover platform.
-const platform = _os.default.platform();
-
-/**
- * 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,
-    preHook,
-    postHook,
-    ...cliOptionsCustom
-  } = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-  const {
-    alias,
-    command,
-    debug,
-    defaultEnv,
-    description,
-    dotenvToken,
-    dynamicPath,
-    env,
-    excludeDynamic,
-    excludeEnv,
-    excludeGlobal,
-    excludePrivate,
-    excludePublic,
-    loadProcess,
-    log,
-    outputPath,
-    paths,
-    pathsDelimiter,
-    pathsDelimiterPattern,
-    privateToken,
-    varsAssignor,
-    varsAssignorPattern,
-    varsDelimiter,
-    varsDelimiterPattern
-  } = {
-    ..._options.cliDefaultOptionsGlobal,
-    ...cliOptionsCustom,
-    ..._options.cliDefaultOptionsLocal
-  };
-  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, command) => {
-    const {
-      args
-    } = command;
-    if (args.length) await (0, _execa.execaCommand)(args.join(platform === 'win32' ? '\\ ' : ' '), {
-      stdio: 'inherit',
-      shell: true
-    });
-  }), {
-    isDefault: true
-  }).hook('preSubcommand', async thisCommand => {
-    const rawOptions = thisCommand.opts();
-    if (rawOptions.debug) logger.log('\n*** raw cli options ***\n', {
-      rawOptions
-    });
-
-    // Load options.
-    let {
-      command,
-      debugOff,
-      excludeAll,
-      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.log('\n*** cli options after default resolution ***\n', {
-      cliOptions
-    });
-
-    // Execute pre-hook.
-    if (preHook) {
-      cliOptions = (await preHook(cliOptions)) ?? cliOptions;
-      if (cliOptions.debug) logger.log('\n*** cli options 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.log('\n*** getdotenv option resolution ***\n', {
-      parentGetdotenvOptions,
-      cliGetdotenvOptions,
-      getdotenvOptions
-    });
-
-    // Execute getdotenv.
-    thisCommand.getdotenvOptions = {
-      ...getdotenvOptions,
-      logger
-    };
-    const dotenv = await (0, _getDotenv.getDotenv)(thisCommand.getdotenvOptions);
-    if (cliOptions.debug) logger.log('\n*** resulting dotenv values ***\n', {
-      dotenv
-    });
-
-    // Execute post-hook.
-    if (postHook) await postHook(dotenv);
-
-    // Execute shell command.
-    if (command) await (0, _execa.execaCommand)(platform === 'win32' ? command.replace(/ /g, '\\ ') : command, {
-      env: {
-        ...process.env,
-        getdotenvOptions: JSON.stringify(getdotenvOptions)
-      },
-      shell: true,
-      stdio: 'inherit'
-    });
-  });
-};
-exports.getDotenvCli = getDotenvCli;

package/dist/default/lib/index.js

@@ -1,38 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-Object.defineProperty(exports, "dotenvExpand", {
-  enumerable: true,
-  get: function () {
-    return _dotenvExpand.dotenvExpand;
-  }
-});
-Object.defineProperty(exports, "dotenvExpandAll", {
-  enumerable: true,
-  get: function () {
-    return _dotenvExpand.dotenvExpandAll;
-  }
-});
-Object.defineProperty(exports, "getDotenv", {
-  enumerable: true,
-  get: function () {
-    return _getDotenv.getDotenv;
-  }
-});
-Object.defineProperty(exports, "getDotenvCli", {
-  enumerable: true,
-  get: function () {
-    return _getDotenvCli.getDotenvCli;
-  }
-});
-Object.defineProperty(exports, "getDotenvSync", {
-  enumerable: true,
-  get: function () {
-    return _getDotenv.getDotenvSync;
-  }
-});
-var _dotenvExpand = require("./dotenvExpand.js");
-var _getDotenv = require("./getDotenv.js");
-var _getDotenvCli = require("./getDotenvCli.js");

package/dist/default/lib/options.js

@@ -1,45 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.getdotenvDefaultOptions = exports.cliDefaultOptionsLocal = exports.cliDefaultOptionsGlobal = 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 = exports.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 = exports.cliDefaultOptionsLocal = (await _fsExtra.default.exists(cliDefaultOptionsLocalPath)) ? JSON.parse(await _fsExtra.default.readFile(cliDefaultOptionsLocalPath)) : {};
-const cli2getdotenvOptions = function () {
-  let {
-    paths,
-    pathsDelimiter,
-    pathsDelimiterPattern,
-    vars,
-    varsAssignor,
-    varsAssignorPattern,
-    varsDelimiter,
-    varsDelimiterPattern,
-    ...rest
-  } = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-  return {
-    ...(0, _lodash2.default)(rest, ['defaultEnv', 'dotenvToken', 'dynamicPath', 'env', 'excludeDynamic', 'excludeEnv', 'excludeGlobal', 'excludePrivate', 'excludePublic', 'loadProcess', 'log', 'outputPath', 'privateToken']),
-    paths: paths?.split(pathsDelimiterPattern ? RegExp(pathsDelimiterPattern) : pathsDelimiter) ?? [],
-    vars: (0, _lodash.default)(vars?.split(varsDelimiterPattern ? RegExp(varsDelimiterPattern) : varsDelimiter).map(v => v.split(varsAssignorPattern ? RegExp(varsAssignorPattern) : varsAssignor)))
-  };
-};
-exports.cli2getdotenvOptions = cli2getdotenvOptions;
-const getdotenvDefaultOptions = exports.getdotenvDefaultOptions = cli2getdotenvOptions({
-  ...cliDefaultOptionsGlobal,
-  ...cliDefaultOptionsLocal
-});

package/dist/default/lib/readDotenv.js

@@ -1,47 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.readDotenvSync = exports.readDotenv = void 0;
-var _dotenv = require("dotenv");
-var _fsExtra = _interopRequireDefault(require("fs-extra"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-/**
- * Asynchronously read a dotenv file & parse it into an object.
- *
- * @async
- * @private
- * @function readDotenv
- *
- * @param {string} path - Any value.
- *
- * @returns {Object} The parsed dotenv object.
- */
-const readDotenv = async path => {
-  try {
-    return (await _fsExtra.default.exists(path)) ? (0, _dotenv.parse)(await _fsExtra.default.readFile(path)) : {};
-  } catch {
-    return {};
-  }
-};
-
-/**
- * Synchronously reads a dotenv file & parses it into an object.
- *
- * @private
- * @function readDotenvSync
- *
- * @param {string} path - Any value.
- *
- * @returns {Object} The parsed dotenv object.
- */
-exports.readDotenv = readDotenv;
-const readDotenvSync = path => {
-  try {
-    return _fsExtra.default.existsSync(path) ? (0, _dotenv.parse)(_fsExtra.default.readFileSync(path)) : {};
-  } catch {
-    return {};
-  }
-};
-exports.readDotenvSync = readDotenvSync;

package/dist/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "commonjs"
-}

package/getdotenv.config.json

@@ -1,24 +0,0 @@
-{
-  "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/dotenvExpand.js

@@ -1,63 +0,0 @@
-// like String.prototype.search but returns the last index
-const _searchLast = (str, rgx) => {
-  const matches = Array.from(str.matchAll(rgx));
-  return matches.length > 0 ? matches.slice(-1)[0].index : -1;
-};
-
-const _interpolate = (envValue, ref) => {
-  // find the last unescaped dollar sign in the
-  // value so that we can evaluate it
-  const lastUnescapedDollarSignIndex = _searchLast(envValue, /(?!(?<=\\))\$/g);
-
-  // If we couldn't match any unescaped dollar sign
-  // let's return the string as is
-  if (lastUnescapedDollarSignIndex === -1) return envValue;
-
-  // This is the right-most group of variables in the string
-  const rightMostGroup = envValue.slice(lastUnescapedDollarSignIndex);
-
-  /**
-   * This finds the inner most variable/group divided
-   * by variable name and default value (if present)
-   * (
-   *   (?!(?<=\\))\$        // only match dollar signs that are not escaped
-   *   {?                   // optional opening curly brace
-   *     ([\w]+)            // match the variable name
-   *     (?::-([^}\\]*))?   // match an optional default value
-   *   }?                   // optional closing curly brace
-   * )
-   */
-  const matchGroup = /((?!(?<=\\))\${?([\w]+)(?::-([^}\\]*))?}?)/;
-  const match = rightMostGroup.match(matchGroup);
-
-  if (match != null) {
-    const [, group, variableName, defaultValue] = match;
-
-    return _interpolate(
-      envValue.replace(group, ref[variableName] || defaultValue || ''),
-      ref
-    );
-  }
-
-  return envValue;
-};
-
-const _resolveEscapeSequences = (value) => {
-  return value.replace(/\\\$/g, '$');
-};
-
-export const dotenvExpand = (value, ref = process.env) => {
-  if (!value || value === 'undefined') return;
-  const result = _resolveEscapeSequences(_interpolate(value, ref));
-  return result.length ? result : undefined;
-};
-
-export const dotenvExpandAll = ({
-  vars = {},
-  progressive = false,
-  ref = process.env,
-}) =>
-  Object.keys(vars).reduce((acc, key) => {
-    acc[key] = dotenvExpand(vars[key], { ...ref, ...(progressive ? acc : {}) });
-    return acc;
-  }, {});