@karmaniverous/get-dotenv 0.2.3 → 0.3.1

package/.env

@@ -1 +0,0 @@
-APP_SETTING=root_app_setting

package/README.md

@@ -6,6 +6,7 @@ Load environment variables with a cascade of environment-aware dotenv files. You
 - Specify the directory 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.
 - Load variables for a specific environment or none.
 - Exclude public or private variables.
 - Extract variables to an object, to `process.env`, or both.
@@ -40,6 +41,19 @@ const dotenvSync = await getDotenvSync(options);
 ```
 
 See [OptionsType](#optionstype--object) below for configuration options.
+
+## Dynamic Processing
+
+For the async form only (`getDotenv`, not `getDotenvSync), use the `dynamicPath` option to add a relative path to a module with a default export like this:
+
+```js
+export default {
+  SOME_DYNAMIC_VARIABLE: (dotenv) => someLogic(dotenv),
+  ANOTHER_DYNAMIC_VARIABLE: (dotenv) => someOtherLogic,
+};
+```
+
+Each function takes the current `dotenv` variable package as an argument. These variables will be processed progressively, meaning each successive one will have access to the previous ones. They can also override existing variables.
 
 # Command Line Interface
 
@@ -55,6 +69,8 @@ dotenv files. You can:
 * Specify a default environment, override the default with an existing
   environment variable, and override both with a direct setting.
 * Exclude public or private variables.
+* Define dynamic variables progressively in terms of other variables and
+  other logic.
 * Execute a shell command after loading variables.
 * Place the shell command inside the invocation to support npm script
   arguments for other options.
@@ -68,6 +84,7 @@ Options:
   -v, --variable <string>            environment from variable
   -r, --exclude-private              exclude private variables (default: false)
   -u, --exclude-public               exclude public variables (default: false)
+  -y, --dynamic-path <string>        dynamic variables path
   -c, --command <string>             shell command string
   -l, --log                          log extracted variables (default: false)
   -h, --help                         display help for command
@@ -129,6 +146,7 @@ get-dotenv options type
 | Name | Type | Description |
 | --- | --- | --- |
 | [dotenvToken] | <code>string</code> | token indicating a dotenv file (default: '.env') |
+| [dynamicPath] | <code>string</code> | path to file exporting an object keyed to dynamic variable functions |
 | [env] | <code>string</code> | target environment |
 | [excludePrivate] | <code>bool</code> | exclude private variables (default: false) |
 | [excludePublic] | <code>bool</code> | exclude public variables (default: false) |

package/bin/getdotenv/index.js

@@ -5,7 +5,7 @@ import spawn from 'cross-spawn';
 import { parseArgsStringToArgv } from 'string-argv';
 
 // Import package exports.
-import { getDotenvSync } from '@karmaniverous/get-dotenv';
+import { getDotenv } from '@karmaniverous/get-dotenv';
 
 // Create CLI.
 import { program } from 'commander';
@@ -25,6 +25,8 @@ program
       `* Specify a default environment, override the default with an existing`,
       `  environment variable, and override both with a direct setting.`,
       `* Exclude public or private variables.`,
+      `* Define dynamic variables progressively in terms of other variables and`,
+      `  other logic.`,
       `* Execute a shell command after loading variables.`,
       `* Place the shell command inside the invocation to support npm script`,
       `  arguments for other options.`,
@@ -50,6 +52,7 @@ program
   .option('-v, --variable <string>', 'environment from variable')
   .option('-r, --exclude-private', 'exclude private variables (default: false)')
   .option('-u, --exclude-public', 'exclude public variables (default: false)')
+  .option('-y, --dynamic-path <string>', 'dynamic variables path')
   .option('-c, --command <string>', 'shell command string')
   .option('-l, --log', 'log extracted variables (default: false)');
 
@@ -62,6 +65,7 @@ const {
   environment,
   excludePrivate,
   excludePublic,
+  dynamicPath,
   log,
   paths,
   privateToken,
@@ -74,12 +78,13 @@ if (command && program.args.length) program.error('command specified twice');
 const env = environment ?? process.env[variable] ?? defaultEnvironment;
 
 // Load dotenvs.
-getDotenvSync({
+await getDotenv({
   dotenvToken,
   env,
   excludePrivate,
   excludePublic,
   loadProcess: true,
+  dynamicPath,
   log,
   paths,
   privateToken,

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

@@ -7,13 +7,19 @@ exports.getDotenvSync = exports.getDotenv = void 0;
 var _path = _interopRequireDefault(require("path"));
 var _dotenvExpand = require("dotenv-expand");
 var _readDotenv = require("../readDotEnv/readDotenv.js");
+var _url = require("url");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+const _dirname = (0, _url.fileURLToPath)(new _url.URL('.', import.meta.url));
+
 /**
  * get-dotenv options type
  *
  * @typedef {Object} OptionsType
  *
  * @property {string} [dotenvToken] - token indicating a dotenv file (default: '.env')
+ * @property {string} [dynamicPath] - path to file exporting an object keyed to dynamic variable functions
  * @property {string} [env] - target environment
  * @property {bool} [excludePrivate] - exclude private variables (default: false)
  * @property {bool} [excludePublic] - exclude public variables (default: false)
@@ -37,6 +43,7 @@ const getDotenv = async function () {
   let {
     dotenvToken = '.env',
     env,
+    dynamicPath,
     excludePrivate = false,
     excludePublic = false,
     loadProcess = false,
@@ -57,6 +64,18 @@ const getDotenv = async function () {
     })
   }), []));
 
+  // Process dynamic variables.
+  if (dynamicPath) {
+    const {
+      default: dynamic
+    } = await Promise.resolve(`${_path.default.relative(_dirname, dynamicPath).replace(/\\/g, '/')}`).then(s => _interopRequireWildcard(require(s)));
+    Object.keys(dynamic).forEach(key => {
+      Object.assign(dotenv, {
+        [key]: dynamic[key](dotenv)
+      });
+    });
+  }
+
   // Log result.
   if (log) console.log(dotenv);
 
@@ -78,6 +97,7 @@ exports.getDotenv = getDotenv;
 const getDotenvSync = function () {
   let {
     dotenvToken = '.env',
+    dynamicPath,
     env,
     excludePrivate = false,
     excludePublic = false,
@@ -99,6 +119,9 @@ const getDotenvSync = function () {
     })
   }), []));
 
+  // Throw error if dynamicPath is set.
+  if (dynamicPath) throw new Error('dynamicPath not supported in sync mode');
+
   // Log result.
   if (log) console.log(dotenv);
 

package/lib/getDotenv/getDotenv.js

@@ -1,6 +1,8 @@
 import path from 'path';
 import { expand } from 'dotenv-expand';
 import { readDotenv, readDotenvSync } from '../readDotEnv/readDotenv.js';
+import { URL, fileURLToPath } from 'url';
+const __dirname = fileURLToPath(new URL('.', import.meta.url));
 
 /**
  * get-dotenv options type
@@ -8,6 +10,7 @@ import { readDotenv, readDotenvSync } from '../readDotEnv/readDotenv.js';
  * @typedef {Object} OptionsType
  *
  * @property {string} [dotenvToken] - token indicating a dotenv file (default: '.env')
+ * @property {string} [dynamicPath] - path to file exporting an object keyed to dynamic variable functions
  * @property {string} [env] - target environment
  * @property {bool} [excludePrivate] - exclude private variables (default: false)
  * @property {bool} [excludePublic] - exclude public variables (default: false)
@@ -30,6 +33,7 @@ import { readDotenv, readDotenvSync } from '../readDotEnv/readDotenv.js';
 export const getDotenv = async ({
   dotenvToken = '.env',
   env,
+  dynamicPath,
   excludePrivate = false,
   excludePublic = false,
   loadProcess = false,
@@ -67,6 +71,17 @@ export const getDotenv = async ({
     )
   );
 
+  // Process dynamic variables.
+  if (dynamicPath) {
+    const { default: dynamic } = await import(
+      path.relative(__dirname, dynamicPath).replace(/\\/g, '/')
+    );
+
+    Object.keys(dynamic).forEach((key) => {
+      Object.assign(dotenv, { [key]: dynamic[key](dotenv) });
+    });
+  }
+
   // Log result.
   if (log) console.log(dotenv);
 
@@ -87,6 +102,7 @@ export const getDotenv = async ({
  */
 export const getDotenvSync = ({
   dotenvToken = '.env',
+  dynamicPath,
   env,
   excludePrivate = false,
   excludePublic = false,
@@ -125,6 +141,9 @@ export const getDotenvSync = ({
     )
   );
 
+  // Throw error if dynamicPath is set.
+  if (dynamicPath) throw new Error('dynamicPath not supported in sync mode');
+
   // Log result.
   if (log) console.log(dotenv);
 

package/package.json

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

package/.env.dev

@@ -1 +0,0 @@
-ENV_SETTING=root_dev_setting

package/.env.dev.secret

@@ -1 +0,0 @@
-ENV_SECRET=root_dev_secret

package/.env.secret

@@ -1 +0,0 @@
-APP_SECRET=root_app_secret

package/.env.test

@@ -1 +0,0 @@
-ENV_SETTING=root_test_setting