@karmaniverous/get-dotenv 2.0.2 → 2.1.0

package/README.md

@@ -71,22 +71,23 @@ Load environment variables with a cascade of environment-aware
 dotenv files. You can:
 
 * Specify the directories containing your dotenv files.
-* Specify the token that identifies dotenv files (e.g. '.env').
-* Specify the token that identifies private vatiables (e.g. '.local').
+* Define dynamic variables progressively in terms of other variables and
+  other logic.
+* Specify a consolidated output file path.
 * Load variables for a specific environment or none.
 * Specify a default environment, override the default with an existing
   environment variable, and override both with a direct setting.
-* Exclude public or private variables.
-* Exclude global & dynamic or environment-specific variables.
-* Define dynamic variables progressively in terms of other variables and
-  other logic.
+* Exclude public, private, global, environment-specific, or dynamic variables.
 * Execute a &&-delimited series of shell commands after loading variables.
 * Place the shell commands inside the invocation to support npm script
   arguments for other options.
+* Specify the token that identifies dotenv files (e.g. '.env').
+* Specify the token that identifies private vatiables (e.g. '.local').
 
 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
   -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)
@@ -166,7 +167,8 @@ 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) |
-| [paths] | <code>Array.&lt;string&gt;</code> | array of target directory paths (default ['./']) |
+| [outputPath] | <code>string</code> | if populated, writes consolidated .env file to this path |
+| [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

@@ -26,18 +26,18 @@ program
       `dotenv files. You can:`,
       ``,
       `* Specify the directories containing your dotenv files.`,
-      `* Specify the token that identifies dotenv files (e.g. '.env').`,
-      `* Specify the token that identifies private vatiables (e.g. '.local').`,
+      `* Define dynamic variables progressively in terms of other variables and`,
+      `  other logic.`,
+      `* Specify a consolidated output file path.`,
       `* Load variables for a specific environment or none.`,
       `* Specify a default environment, override the default with an existing`,
       `  environment variable, and override both with a direct setting.`,
-      `* Exclude public or private variables.`,
-      `* Exclude global & dynamic or environment-specific variables.`,
-      `* Define dynamic variables progressively in terms of other variables and`,
-      `  other logic.`,
+      `* Exclude public, private, global, environment-specific, or dynamic variables.`,
       `* Execute a &&-delimited series of shell commands after loading variables.`,
       `* Place the shell commands inside the invocation to support npm script`,
       `  arguments for other options.`,
+      `* Specify the token that identifies dotenv files (e.g. '.env').`,
+      `* Specify the token that identifies private vatiables (e.g. '.local').`,
     ].join('\n')
   );
 
@@ -48,6 +48,7 @@ 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(
     '-d, --defaultEnvironment <string>',
     'default environment (prefix with $ to use environment variable)',
@@ -93,6 +94,7 @@ const {
   excludePublic,
   dynamicPath,
   log,
+  outputPath,
   paths,
   privateToken,
 } = program.opts();
@@ -113,6 +115,7 @@ await getDotenv({
   loadProcess: true,
   dynamicPath,
   log,
+  outputPath,
   paths,
   privateToken,
 });

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

@@ -28,7 +28,8 @@ 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[]} [paths] - array of target directory paths (default ['./'])
+ * @property {string} [outputPath] - if populated, writes consolidated .env file to this path
+ * @property {string[]} [paths] - array of input directory paths (default ['./'])
  * @property {string} [privateToken] - token indicating private variables (default: 'local').
  */
 
@@ -54,6 +55,7 @@ const getDotenv = async function () {
     excludePublic = false,
     loadProcess = false,
     log = false,
+    outputPath,
     paths = ['./'],
     privateToken = 'local'
   } = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
@@ -89,7 +91,9 @@ const getDotenv = async function () {
       } catch ({
         message
       }) {
-        throw new Error(`Dynamic processing failed for variable '${key}'. ${message}`);
+        Object.assign(dotenv, {
+          [key]: `ERROR: ${message}`
+        });
       }
     });
   }
@@ -99,6 +103,12 @@ const getDotenv = async function () {
 
   // 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;
 };
 
@@ -124,6 +134,7 @@ const getDotenvSync = function () {
     excludePublic = false,
     loadProcess = false,
     log = false,
+    outputPath,
     paths = ['./'],
     privateToken = 'local'
   } = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
@@ -163,6 +174,12 @@ const getDotenvSync = function () {
 
   // 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

@@ -21,7 +21,8 @@ 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[]} [paths] - array of target directory paths (default ['./'])
+ * @property {string} [outputPath] - if populated, writes consolidated .env file to this path
+ * @property {string[]} [paths] - array of input directory paths (default ['./'])
  * @property {string} [privateToken] - token indicating private variables (default: 'local').
  */
 
@@ -46,6 +47,7 @@ export const getDotenv = async ({
   excludePublic = false,
   loadProcess = false,
   log = false,
+  outputPath,
   paths = ['./'],
   privateToken = 'local',
 } = {}) => {
@@ -97,9 +99,7 @@ export const getDotenv = async ({
       try {
         Object.assign(dotenv, { [key]: dynamic[key](dotenv) });
       } catch ({ message }) {
-        throw new Error(
-          `Dynamic processing failed for variable '${key}'. ${message}`
-        );
+        Object.assign(dotenv, { [key]: `ERROR: ${message}` });
       }
     });
   }
@@ -110,6 +110,18 @@ export const getDotenv = async ({
   // Load process.env.
   if (loadProcess) Object.assign(process.env, dotenv);
 
+  // Write output file.
+  if (outputPath)
+    await fs.writeFile(
+      outputPath,
+      Object.keys(dotenv).reduce((contents, key) => {
+        const value = dotenv[key] ?? '';
+        return `${contents}${key}=${
+          value.includes('\n') ? `"${value}"` : value
+        }\n`;
+      }, '')
+    );
+
   return dotenv;
 };
 
@@ -133,6 +145,7 @@ export const getDotenvSync = ({
   excludePublic = false,
   loadProcess = false,
   log = false,
+  outputPath,
   paths = ['./'],
   privateToken = 'local',
 } = {}) => {
@@ -196,5 +209,17 @@ export const getDotenvSync = ({
   // Load process.env.
   if (loadProcess) Object.assign(process.env, dotenv);
 
+  // Write output file.
+  if (outputPath)
+    fs.writeFileSync(
+      outputPath,
+      Object.keys(dotenv).reduce((contents, key) => {
+        const value = dotenv[key] ?? '';
+        return `${contents}${key}=${
+          value.includes('\n') ? `"${value}"` : value
+        }\n`;
+      }, '')
+    );
+
   return dotenv;
 };

package/package.json

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

package/test.env

@@ -0,0 +1,7 @@
+APP_SETTING=root_app_setting
+DYNAMIC_APP_SETTING_1=root_app_setting
+DYNAMIC_APP_SETTING_2=abcroot_app_setting123
+MULTILINE="a
+b
+c"
+APP_SECRET=root_app_secret