@karmaniverous/get-dotenv 2.1.0 → 2.2.0

package/README.md

@@ -87,7 +87,7 @@ dotenv files. You can:
 Options:
   -p, --paths <strings...>           space-delimited paths to dotenv directory (default './')
   -y, --dynamic-path <string>        dynamic variables path
-  -o, --output-path <string>         consolidated output file
+  -o, --output-path <string>         consolidated output file (follows dotenv-expand rules using loaded env vars)
   -d, --defaultEnvironment <string>  default environment (prefix with $ to use environment variable)
   -e, --environment <string>         designated environment (prefix with $ to use environment variable)
   -n, --exclude-env                  exclude environment-specific variables (default: false)
@@ -167,7 +167,7 @@ get-dotenv options type
 | [excludePublic] | <code>bool</code> | exclude public variables (default: false) |
 | [loadProcess] | <code>bool</code> | load dotenv to process.env (default: false) |
 | [log] | <code>bool</code> | log result to console (default: false) |
-| [outputPath] | <code>string</code> | if populated, writes consolidated .env file to this path |
+| [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 (default ['./']) |
 | [privateToken] | <code>string</code> | token indicating private variables (default: 'local'). |
 

package/bin/getdotenv/index.js

@@ -48,7 +48,10 @@ program
     "space-delimited paths to dotenv directory (default './')"
   )
   .option('-y, --dynamic-path <string>', 'dynamic variables path')
-  .option('-o, --output-path <string>', 'consolidated output file')
+  .option(
+    '-o, --output-path <string>',
+    'consolidated output file (follows dotenv-expand rules using loaded env vars)'
+  )
   .option(
     '-d, --defaultEnvironment <string>',
     'default environment (prefix with $ to use environment variable)',

package/dist/default/lib/getDotenv/getDotenv.js

@@ -7,6 +7,7 @@ exports.getDotenvSync = exports.getDotenv = void 0;
 var _dotenvExpand = require("dotenv-expand");
 var _fsExtra = _interopRequireDefault(require("fs-extra"));
 var _path = _interopRequireDefault(require("path"));
+var _uuid = require("uuid");
 var _readDotenv = require("../readDotEnv/readDotenv.js");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 // npm imports
@@ -28,7 +29,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * @property {bool} [excludePublic] - exclude public variables (default: false)
  * @property {bool} [loadProcess] - load dotenv to process.env (default: false)
  * @property {bool} [log] - log result to console (default: false)
- * @property {string} [outputPath] - if populated, writes consolidated .env file to this path
+ * @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 (default ['./'])
  * @property {string} [privateToken] - token indicating private variables (default: 'local').
  */
@@ -70,15 +71,19 @@ const getDotenv = async function () {
       ...(excludeGlobal ? {} : await (0, _readDotenv.readDotenv)(_path.default.resolve(p, `${dotenvToken}.${privateToken}`))),
       ...(env && !excludeEnv ? await (0, _readDotenv.readDotenv)(_path.default.resolve(p, `${dotenvToken}.${env}.${privateToken}`)) : {})
     })
-  }), []);
+  }), {});
+  const outputKey = (0, _uuid.v4)();
   const {
-    error,
     parsed: dotenv
   } = (0, _dotenvExpand.expand)({
     ignoreProcessEnv: true,
-    parsed
+    parsed: {
+      ...parsed,
+      ...(outputPath ? {
+        [outputKey]: outputPath
+      } : {})
+    }
   });
-  if (error) throw new Error(error);
 
   // Process dynamic variables.
   if (dynamicPath && !excludeDynamic) {
@@ -98,17 +103,23 @@ const getDotenv = async function () {
     });
   }
 
+  // Write output file.
+  if (outputPath) {
+    outputPath = dotenv[outputKey];
+    delete dotenv[outputKey];
+    await _fsExtra.default.writeFile(outputPath, Object.keys(dotenv).reduce((contents, key) => {
+      const value = dotenv[key] ?? '';
+      return `${contents}${key}=${value.includes('\n') ? `"${value}"` : value}\n`;
+    }, ''), {
+      encoding: 'utf-8'
+    });
+  }
+
   // Log result.
   if (log) console.log(dotenv);
 
   // Load process.env.
   if (loadProcess) Object.assign(process.env, dotenv);
-
-  // Write output file.
-  if (outputPath) await _fsExtra.default.writeFile(outputPath, Object.keys(dotenv).reduce((contents, key) => {
-    const value = dotenv[key] ?? '';
-    return `${contents}${key}=${value.includes('\n') ? `"${value}"` : value}\n`;
-  }, ''));
   return dotenv;
 };
 
@@ -149,15 +160,19 @@ const getDotenvSync = function () {
       ...(excludeGlobal ? {} : (0, _readDotenv.readDotenvSync)(_path.default.resolve(p, `${dotenvToken}.${privateToken}`))),
       ...(env && !excludeEnv ? (0, _readDotenv.readDotenvSync)(_path.default.resolve(p, `${dotenvToken}.${env}.${privateToken}`)) : {})
     })
-  }), []);
+  }), {});
+  const outputKey = (0, _uuid.v4)();
   const {
-    error,
     parsed: dotenv
   } = (0, _dotenvExpand.expand)({
     ignoreProcessEnv: true,
-    parsed
+    parsed: {
+      ...parsed,
+      ...(outputPath ? {
+        [outputKey]: outputPath
+      } : {})
+    }
   });
-  if (error) throw new Error(error);
 
   // Process dynamic variables.
   if (dynamicPath && !excludeDynamic) {
@@ -169,17 +184,23 @@ const getDotenvSync = function () {
     });
   }
 
+  // Write output file.
+  if (outputPath) {
+    outputPath = dotenv[outputKey];
+    delete dotenv[outputKey];
+    _fsExtra.default.writeFileSync(outputPath, Object.keys(dotenv).reduce((contents, key) => {
+      const value = dotenv[key] ?? '';
+      return `${contents}${key}=${value.includes('\n') ? `"${value}"` : value}\n`;
+    }, ''), {
+      encoding: 'utf-8'
+    });
+  }
+
   // Log result.
   if (log) console.log(dotenv);
 
   // Load process.env.
   if (loadProcess) Object.assign(process.env, dotenv);
-
-  // Write output file.
-  if (outputPath) _fsExtra.default.writeFileSync(outputPath, Object.keys(dotenv).reduce((contents, key) => {
-    const value = dotenv[key] ?? '';
-    return `${contents}${key}=${value.includes('\n') ? `"${value}"` : value}\n`;
-  }, ''));
   return dotenv;
 };
 exports.getDotenvSync = getDotenvSync;

package/lib/getDotenv/getDotenv.js

@@ -2,6 +2,7 @@
 import { expand } from 'dotenv-expand';
 import fs from 'fs-extra';
 import path from 'path';
+import { v4 as uuid } from 'uuid';
 
 // lib imports
 import { readDotenv, readDotenvSync } from '../readDotEnv/readDotenv.js';
@@ -21,7 +22,7 @@ import { readDotenv, readDotenvSync } from '../readDotEnv/readDotenv.js';
  * @property {bool} [excludePublic] - exclude public variables (default: false)
  * @property {bool} [loadProcess] - load dotenv to process.env (default: false)
  * @property {bool} [log] - log result to console (default: false)
- * @property {string} [outputPath] - if populated, writes consolidated .env file to this path
+ * @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 (default ['./'])
  * @property {string} [privateToken] - token indicating private variables (default: 'local').
  */
@@ -80,16 +81,18 @@ export const getDotenv = async ({
               : {}),
           }),
     }),
-    []
+    {}
   );
 
-  const { error, parsed: dotenv } = expand({
+  const outputKey = uuid();
+  const { parsed: dotenv } = expand({
     ignoreProcessEnv: true,
-    parsed,
+    parsed: {
+      ...parsed,
+      ...(outputPath ? { [outputKey]: outputPath } : {}),
+    },
   });
 
-  if (error) throw new Error(error);
-
   // Process dynamic variables.
   if (dynamicPath && !excludeDynamic) {
     const dynamic = new Function(
@@ -104,14 +107,11 @@ export const getDotenv = async ({
     });
   }
 
-  // Log result.
-  if (log) console.log(dotenv);
-
-  // Load process.env.
-  if (loadProcess) Object.assign(process.env, dotenv);
-
   // Write output file.
-  if (outputPath)
+  if (outputPath) {
+    outputPath = dotenv[outputKey];
+    delete dotenv[outputKey];
+
     await fs.writeFile(
       outputPath,
       Object.keys(dotenv).reduce((contents, key) => {
@@ -119,8 +119,16 @@ export const getDotenv = async ({
         return `${contents}${key}=${
           value.includes('\n') ? `"${value}"` : value
         }\n`;
-      }, '')
+      }, ''),
+      { encoding: 'utf-8' }
     );
+  }
+
+  // Log result.
+  if (log) console.log(dotenv);
+
+  // Load process.env.
+  if (loadProcess) Object.assign(process.env, dotenv);
 
   return dotenv;
 };
@@ -178,16 +186,18 @@ export const getDotenvSync = ({
               : {}),
           }),
     }),
-    []
+    {}
   );
 
-  const { error, parsed: dotenv } = expand({
+  const outputKey = uuid();
+  const { parsed: dotenv } = expand({
     ignoreProcessEnv: true,
-    parsed,
+    parsed: {
+      ...parsed,
+      ...(outputPath ? { [outputKey]: outputPath } : {}),
+    },
   });
 
-  if (error) throw new Error(error);
-
   // Process dynamic variables.
   if (dynamicPath && !excludeDynamic) {
     const dynamic = new Function(
@@ -203,14 +213,11 @@ export const getDotenvSync = ({
     });
   }
 
-  // Log result.
-  if (log) console.log(dotenv);
-
-  // Load process.env.
-  if (loadProcess) Object.assign(process.env, dotenv);
-
   // Write output file.
-  if (outputPath)
+  if (outputPath) {
+    outputPath = dotenv[outputKey];
+    delete dotenv[outputKey];
+
     fs.writeFileSync(
       outputPath,
       Object.keys(dotenv).reduce((contents, key) => {
@@ -218,8 +225,16 @@ export const getDotenvSync = ({
         return `${contents}${key}=${
           value.includes('\n') ? `"${value}"` : value
         }\n`;
-      }, '')
+      }, ''),
+      { encoding: 'utf-8' }
     );
+  }
+
+  // Log result.
+  if (log) console.log(dotenv);
+
+  // Load process.env.
+  if (loadProcess) Object.assign(process.env, dotenv);
 
   return dotenv;
 };

package/package.json

@@ -3,7 +3,7 @@
   "bin": {
     "getdotenv": "bin/getdotenv/index.js"
   },
-  "version": "2.1.0",
+  "version": "2.2.0",
   "publishConfig": {
     "access": "public"
   },
@@ -36,7 +36,8 @@
     "dotenv": "^16.0.3",
     "dotenv-expand": "^10.0.0",
     "fs-extra": "^11.1.0",
-    "string-argv": "^0.3.1"
+    "string-argv": "^0.3.1",
+    "uuid": "^9.0.0"
   },
   "devDependencies": {
     "@babel/cli": "^7.21.0",