@karmaniverous/get-dotenv 3.0.0 → 3.0.2

package/README.md

@@ -79,7 +79,8 @@ Usage: getdotenv [options] [command]
 Base CLI. All options except delimiters follow dotenv-expand rules.
 
 Options:
-  -e, --env <string>            environment name
+  -e, --env <string>            target environment
+  --default-env <string>        default target environment (default: "dev")
   -p, --paths <string>          delimited list of paths to dotenv directory (default: "./")
   --paths-delimiter <string>    regex paths delimiter (default: "\\s+")
   -v, --vars <string>           delimited list KEY=VALUE pairs
@@ -193,6 +194,7 @@ GetDotenv CLI Options type
 | Name | Type | Description |
 | --- | --- | --- |
 | [cliInvocation] | <code>string</code> | cli invocation string (used for cli help) |
+| [defaultEnv] | <code>string</code> | default target environment |
 | [dotenvToken] | <code>string</code> | token indicating a dotenv file |
 | [dynamicPath] | <code>string</code> | path to file exporting an object keyed to dynamic variable functions |
 | [env] | <code>string</code> | target environment |
@@ -272,6 +274,7 @@ get-dotenv options type
 | [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 |
+| [vars] | <code>object</code> | explicit variables to include |
 
 
 ---

package/dist/default/lib/getCli.js

@@ -24,6 +24,7 @@ const booleanExpand = value => (0, _boolean.boolean)((0, _dotenvExpand.dotenvExp
  *
  * @typedef {Object} GetDotenvCliOptions
  * @property {string} [cliInvocation] - cli invocation string (used for cli help)
+ * @property {string} [defaultEnv] - default target environment
  * @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
@@ -84,6 +85,7 @@ const getCli = function () {
   let {
     cliInvocation = 'getdotenv',
     command,
+    defaultEnv = 'dev',
     dotenvToken,
     dynamicPath,
     env,
@@ -109,7 +111,7 @@ const getCli = function () {
   if (Array.isArray(paths)) paths = paths.join(' ');
   return new _commander.Command().name(cliInvocation)
   // .usage('[options] [command] [command options] [commad args]')
-  .description('Base CLI. All options except delimiters follow dotenv-expand rules.').enablePositionalOptions().passThroughOptions().option('-e, --env <string>', 'environment name', _dotenvExpand.dotenvExpand, env).option('-p, --paths <string>', 'delimited list of paths to dotenv directory', _dotenvExpand.dotenvExpand, paths).option('--paths-delimiter <string>', 'regex paths delimiter', pathsDelimiter).option('-v, --vars <string>', 'delimited list KEY=VALUE pairs', _dotenvExpand.dotenvExpand, vars).option('--vars-delimiter <string>', 'regex vars delimiter', varsDelimiter).option('--vars-assignor <string>', 'regex vars assignment operator', varsAssignor).option('-y, --dynamic-path <string>', 'dynamic variables path', _dotenvExpand.dotenvExpand, dynamicPath).option('-o, --output-path <string>', 'consolidated output file, follows dotenv-expand rules using loaded env vars', _dotenvExpand.dotenvExpand, outputPath).option('-n, --exclude-env [bool]', 'exclude environment-specific variables', booleanExpand, excludeEnv ?? false).option('-g, --exclude-global [bool]', 'exclude global & dynamic variables', booleanExpand, excludeGlobal ?? false).option('-r, --exclude-private [bool]', 'exclude private variables', booleanExpand, excludePrivate ?? false).option('-u, --exclude-public [bool]', 'exclude public variables', booleanExpand, excludePublic ?? false).option('-z, --exclude-dynamic [bool]', 'exclude dynamic variables', booleanExpand, excludeDynamic ?? false).option('-l, --log [bool]', 'console log extracted variables', booleanExpand, log ?? false).option('-x, --suppress-dotenv', 'suppress dotenv loading', booleanExpand, suppressDotenv ?? false).option('-c, --command <string>', 'shell command string', _dotenvExpand.dotenvExpand, command).option('-s, --shell <string>', 'execa shell option', _dotenvExpand.dotenvExpand, shell).option('--dotenv-token <string>', 'token indicating a dotenv file', _dotenvExpand.dotenvExpand, dotenvToken).option('--private-token <string>', 'token indicating private variables', _dotenvExpand.dotenvExpand, privateToken).addCommand(new _commander.Command().name('cmd').description('execute shell command string (default command)').configureHelp({
+  .description('Base CLI. All options except delimiters follow dotenv-expand rules.').enablePositionalOptions().passThroughOptions().option('-e, --env <string>', 'target environment', _dotenvExpand.dotenvExpand, env).option('--default-env <string>', 'default target environment', _dotenvExpand.dotenvExpand, defaultEnv).option('-p, --paths <string>', 'delimited list of paths to dotenv directory', _dotenvExpand.dotenvExpand, paths).option('--paths-delimiter <string>', 'regex paths delimiter', pathsDelimiter).option('-v, --vars <string>', 'delimited list KEY=VALUE pairs', _dotenvExpand.dotenvExpand, vars).option('--vars-delimiter <string>', 'regex vars delimiter', varsDelimiter).option('--vars-assignor <string>', 'regex vars assignment operator', varsAssignor).option('-y, --dynamic-path <string>', 'dynamic variables path', _dotenvExpand.dotenvExpand, dynamicPath).option('-o, --output-path <string>', 'consolidated output file, follows dotenv-expand rules using loaded env vars', _dotenvExpand.dotenvExpand, outputPath).option('-n, --exclude-env [bool]', 'exclude environment-specific variables', booleanExpand, excludeEnv ?? false).option('-g, --exclude-global [bool]', 'exclude global & dynamic variables', booleanExpand, excludeGlobal ?? false).option('-r, --exclude-private [bool]', 'exclude private variables', booleanExpand, excludePrivate ?? false).option('-u, --exclude-public [bool]', 'exclude public variables', booleanExpand, excludePublic ?? false).option('-z, --exclude-dynamic [bool]', 'exclude dynamic variables', booleanExpand, excludeDynamic ?? false).option('-l, --log [bool]', 'console log extracted variables', booleanExpand, log ?? false).option('-x, --suppress-dotenv', 'suppress dotenv loading', booleanExpand, suppressDotenv ?? false).option('-c, --command <string>', 'shell command string', _dotenvExpand.dotenvExpand, command).option('-s, --shell <string>', 'execa shell option', _dotenvExpand.dotenvExpand, shell).option('--dotenv-token <string>', 'token indicating a dotenv file', _dotenvExpand.dotenvExpand, dotenvToken).option('--private-token <string>', 'token indicating private variables', _dotenvExpand.dotenvExpand, privateToken).addCommand(new _commander.Command().name('cmd').description('execute shell command string (default command)').configureHelp({
     showGlobalOptions: true
   }).enablePositionalOptions().passThroughOptions().action(async (options, _ref) => {
     let {
@@ -136,17 +138,19 @@ const getCli = function () {
     // Get options.
     let {
       command,
+      defaultEnv,
+      env,
       paths,
       pathsDelimiter,
       suppressDotenv,
-      vars,
+      vars: varsStr,
       varsDelimiter,
       varsAssignor,
       ...rest
     } = options;
 
     // Parse vars.
-    if (vars !== null && vars !== void 0 && vars.length) Object.assign(process.env, (0, _lodash.default)(vars.split(new RegExp(varsDelimiter)).map(v => v.split(new RegExp(varsAssignor)))));
+    const vars = varsStr !== null && varsStr !== void 0 && varsStr.length ? (0, _lodash.default)(varsStr.split(new RegExp(varsDelimiter)).map(v => v.split(new RegExp(varsAssignor)))) : undefined;
 
     // Execute getdotenv.
     if ((_paths = paths) !== null && _paths !== void 0 && _paths.length && !suppressDotenv) {
@@ -154,8 +158,10 @@ const getCli = function () {
       if ((0, _lodash2.default)(paths)) paths = (_paths2 = paths) === null || _paths2 === void 0 ? void 0 : _paths2.split(new RegExp(pathsDelimiter));
       var dotenv = await (0, _getDotenv.getDotenv)({
         ...rest,
+        env: env ?? defaultEnv,
         loadProcess: true,
-        paths
+        paths,
+        vars
       });
     }
 

package/dist/default/lib/getDotenv.js

@@ -34,6 +34,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * @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
+ * @property {object} [vars] - explicit variables to include
  */
 
 /**
@@ -63,14 +64,15 @@ const getDotenv = async function () {
     logger,
     outputPath,
     paths,
-    privateToken
+    privateToken,
+    vars = {}
   } = {
     ..._dotenvDefaults.dotenvDefaults,
     ...options
   };
 
   // Read .env files.
-  const parsed = await paths.reduce(async (e, p) => {
+  const loaded = await paths.reduce(async (e, p) => {
     let publicGlobal = excludePublic || excludeGlobal ? {} : (0, _readDotenv.readDotenv)(_path.default.resolve(p, dotenvToken));
     let publicEnv = excludePublic || excludeEnv ? {} : (0, _readDotenv.readDotenv)(_path.default.resolve(p, `${dotenvToken}.${env}`));
     let privateGlobal = excludePrivate || excludeGlobal ? {} : (0, _readDotenv.readDotenv)(_path.default.resolve(p, `${dotenvToken}.${privateToken}`));
@@ -90,7 +92,8 @@ const getDotenv = async function () {
   } = (0, _dotenvExpand.expand)({
     ignoreProcessEnv: true,
     parsed: {
-      ...parsed,
+      ...loaded,
+      ...vars,
       ...(outputPath ? {
         [outputKey]: outputPath
       } : {})
@@ -169,14 +172,15 @@ const getDotenvSync = function () {
     log,
     outputPath,
     paths,
-    privateToken
+    privateToken,
+    vars
   } = {
     ..._dotenvDefaults.dotenvDefaults,
     ...options
   };
 
   // Read .env files.
-  const parsed = paths.reduce((e, p) => {
+  const loaded = paths.reduce((e, p) => {
     let publicGlobal = excludePublic || excludeGlobal ? {} : (0, _readDotenv.readDotenvSync)(_path.default.resolve(p, dotenvToken));
     let publicEnv = excludePublic || excludeEnv ? {} : (0, _readDotenv.readDotenvSync)(_path.default.resolve(p, `${dotenvToken}.${env}`));
     let privateGlobal = excludePrivate || excludeGlobal ? {} : (0, _readDotenv.readDotenvSync)(_path.default.resolve(p, `${dotenvToken}.${privateToken}`));
@@ -195,7 +199,8 @@ const getDotenvSync = function () {
   } = (0, _dotenvExpand.expand)({
     ignoreProcessEnv: true,
     parsed: {
-      ...parsed,
+      ...loaded,
+      ...vars,
       ...(outputPath ? {
         [outputKey]: outputPath
       } : {})

package/lib/getCli.js

@@ -17,6 +17,7 @@ const booleanExpand = (value) => boolean(dotenvExpand(value));
  *
  * @typedef {Object} GetDotenvCliOptions
  * @property {string} [cliInvocation] - cli invocation string (used for cli help)
+ * @property {string} [defaultEnv] - default target environment
  * @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
@@ -72,6 +73,7 @@ export const getCli = ({ defaultOptions = {}, preHook, postHook } = {}) => {
   let {
     cliInvocation = 'getdotenv',
     command,
+    defaultEnv = 'dev',
     dotenvToken,
     dynamicPath,
     env,
@@ -106,7 +108,13 @@ export const getCli = ({ defaultOptions = {}, preHook, postHook } = {}) => {
       )
       .enablePositionalOptions()
       .passThroughOptions()
-      .option('-e, --env <string>', 'environment name', dotenvExpand, env)
+      .option('-e, --env <string>', 'target environment', dotenvExpand, env)
+      .option(
+        '--default-env <string>',
+        'default target environment',
+        dotenvExpand,
+        defaultEnv
+      )
       .option(
         '-p, --paths <string>',
         'delimited list of paths to dotenv directory',
@@ -238,25 +246,25 @@ export const getCli = ({ defaultOptions = {}, preHook, postHook } = {}) => {
         // Get options.
         let {
           command,
+          defaultEnv,
+          env,
           paths,
           pathsDelimiter,
           suppressDotenv,
-          vars,
+          vars: varsStr,
           varsDelimiter,
           varsAssignor,
           ...rest
         } = options;
 
         // Parse vars.
-        if (vars?.length)
-          Object.assign(
-            process.env,
-            fromPairs(
-              vars
+        const vars = varsStr?.length
+          ? fromPairs(
+              varsStr
                 .split(new RegExp(varsDelimiter))
                 .map((v) => v.split(new RegExp(varsAssignor)))
             )
-          );
+          : undefined;
 
         // Execute getdotenv.
         if (paths?.length && !suppressDotenv) {
@@ -264,8 +272,10 @@ export const getCli = ({ defaultOptions = {}, preHook, postHook } = {}) => {
 
           var dotenv = await getDotenv({
             ...rest,
+            env: env ?? defaultEnv,
             loadProcess: true,
             paths,
+            vars,
           });
         }
 

package/lib/getDotenv.js

@@ -27,6 +27,7 @@ import { readDotenv, readDotenvSync } from './readDotenv.js';
  * @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
+ * @property {object} [vars] - explicit variables to include
  */
 
 /**
@@ -56,10 +57,11 @@ export const getDotenv = async (options = {}) => {
     outputPath,
     paths,
     privateToken,
+    vars = {},
   } = { ...dotenvDefaults, ...options };
 
   // Read .env files.
-  const parsed = await paths.reduce(async (e, p) => {
+  const loaded = await paths.reduce(async (e, p) => {
     let publicGlobal =
       excludePublic || excludeGlobal
         ? {}
@@ -94,7 +96,8 @@ export const getDotenv = async (options = {}) => {
   const { parsed: dotenv } = expand({
     ignoreProcessEnv: true,
     parsed: {
-      ...parsed,
+      ...loaded,
+      ...vars,
       ...(outputPath ? { [outputKey]: outputPath } : {}),
     },
   });
@@ -182,10 +185,11 @@ export const getDotenvSync = (options = {}) => {
     outputPath,
     paths,
     privateToken,
+    vars,
   } = { ...dotenvDefaults, ...options };
 
   // Read .env files.
-  const parsed = paths.reduce((e, p) => {
+  const loaded = paths.reduce((e, p) => {
     let publicGlobal =
       excludePublic || excludeGlobal
         ? {}
@@ -218,7 +222,8 @@ export const getDotenvSync = (options = {}) => {
   const { parsed: dotenv } = expand({
     ignoreProcessEnv: true,
     parsed: {
-      ...parsed,
+      ...loaded,
+      ...vars,
       ...(outputPath ? { [outputKey]: outputPath } : {}),
     },
   });

package/package.json

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