@karmaniverous/get-dotenv 2.6.8 → 3.0.1

package/lib/getDotenv.js

@@ -2,9 +2,10 @@
 import { expand } from 'dotenv-expand';
 import fs from 'fs-extra';
 import path from 'path';
-import { v4 as uuid } from 'uuid';
+import { nanoid } from 'nanoid';
 
 // lib imports
+import { dotenvDefaults } from './dotenvDefaults.js';
 import { readDotenv, readDotenvSync } from './readDotenv.js';
 
 /**
@@ -12,19 +13,21 @@ import { readDotenv, readDotenvSync } from './readDotenv.js';
  *
  * @typedef {Object} OptionsType
  *
- * @property {string} [dotenvToken] - token indicating a dotenv file (default: '.env')
+ * @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
- * @property {bool} [excludeDynamic] - exclude dynamic variables (default: false)
- * @property {bool} [excludeEnv] - exclude environment-specific variables (default: false)
- * @property {bool} [excludeGlobal] - exclude global & dynamic variables (default: false)
- * @property {bool} [excludePrivate] - exclude private variables (default: false)
- * @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 {bool} [excludeDynamic] - exclude dynamic variables
+ * @property {bool} [excludeEnv] - exclude environment-specific variables
+ * @property {bool} [excludeGlobal] - exclude global & dynamic variables
+ * @property {bool} [excludePrivate] - exclude private variables
+ * @property {bool} [excludePublic] - exclude public variables
+ * @property {bool} [loadProcess] - load dotenv to process.env
+ * @property {bool} [log] - log result to logger
+ * @property {function} [logger] - logger function
  * @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').
+ * @property {string[]} [paths] - array of input directory paths
+ * @property {string} [privateToken] - token indicating private variables
+ * @property {object} [vars] - explicit variables to include
  */
 
 /**
@@ -37,58 +40,64 @@ import { readDotenv, readDotenvSync } from './readDotenv.js';
  *
  * @returns {Promise<object>} The combined parsed dotenv object.
  */
-export const getDotenv = async ({
-  dotenvToken = '.env',
-  env,
-  dynamicPath,
-  excludeDynamic = false,
-  excludeEnv = false,
-  excludeGlobal = false,
-  excludePrivate = false,
-  excludePublic = false,
-  loadProcess = false,
-  log = false,
-  outputPath,
-  paths = ['./'],
-  privateToken = 'local',
-} = {}) => {
+export const getDotenv = async (options = {}) => {
+  // Apply defaults.
+  let {
+    dotenvToken,
+    env,
+    dynamicPath,
+    excludeDynamic,
+    excludeEnv,
+    excludeGlobal,
+    excludePrivate,
+    excludePublic,
+    loadProcess,
+    log,
+    logger,
+    outputPath,
+    paths,
+    privateToken,
+    vars = {},
+  } = { ...dotenvDefaults, ...options };
+
   // Read .env files.
-  const parsed = await paths.reduce(
-    async (e, p) => ({
-      ...(await e),
-      ...(excludePublic
+  const loaded = await paths.reduce(async (e, p) => {
+    let publicGlobal =
+      excludePublic || excludeGlobal
+        ? {}
+        : readDotenv(path.resolve(p, dotenvToken));
+    let publicEnv =
+      excludePublic || excludeEnv
         ? {}
-        : {
-            ...(excludeGlobal
-              ? {}
-              : await readDotenv(path.resolve(p, dotenvToken))),
-            ...(env && !excludeEnv
-              ? await readDotenv(path.resolve(p, `${dotenvToken}.${env}`))
-              : {}),
-          }),
-      ...(excludePrivate
+        : readDotenv(path.resolve(p, `${dotenvToken}.${env}`));
+    let privateGlobal =
+      excludePrivate || excludeGlobal
         ? {}
-        : {
-            ...(excludeGlobal
-              ? {}
-              : await readDotenv(
-                  path.resolve(p, `${dotenvToken}.${privateToken}`)
-                )),
-            ...(env && !excludeEnv
-              ? await readDotenv(
-                  path.resolve(p, `${dotenvToken}.${env}.${privateToken}`)
-                )
-              : {}),
-          }),
-    }),
-    {}
-  );
+        : readDotenv(path.resolve(p, `${dotenvToken}.${privateToken}`));
+    let privateEnv =
+      excludePrivate || excludeEnv
+        ? {}
+        : readDotenv(path.resolve(p, `${dotenvToken}.${env}.${privateToken}`));
+
+    [e, publicGlobal, publicEnv, privateGlobal, privateEnv] = await Promise.all(
+      [e, publicGlobal, publicEnv, privateGlobal, privateEnv]
+    );
+
+    return {
+      ...e,
+      ...publicGlobal,
+      ...publicEnv,
+      ...privateGlobal,
+      ...privateEnv,
+    };
+  }, {});
 
-  const outputKey = uuid();
+  const outputKey = nanoid();
   const { parsed: dotenv } = expand({
     ignoreProcessEnv: true,
     parsed: {
-      ...parsed,
+      ...loaded,
+      ...vars,
       ...(outputPath ? { [outputKey]: outputPath } : {}),
     },
   });
@@ -126,15 +135,15 @@ export const getDotenv = async ({
   }
 
   // Log result.
-  if (log) console.log(dotenv);
+  if (log) logger(dotenv);
 
   // Load process.env.
   if (loadProcess)
     Object.assign(process.env, dotenv, {
       getdotenvOptions: JSON.stringify({
         dotenvToken,
-        dynamicPath,
         env,
+        dynamicPath,
         excludeDynamic,
         excludeEnv,
         excludeGlobal,
@@ -160,58 +169,61 @@ export const getDotenv = async ({
  *
  * @returns {Object} The combined parsed dotenv object.
  */
-export const getDotenvSync = ({
-  dotenvToken = '.env',
-  dynamicPath,
-  env,
-  excludeDynamic = false,
-  excludeEnv = false,
-  excludeGlobal = false,
-  excludePrivate = false,
-  excludePublic = false,
-  loadProcess = false,
-  log = false,
-  outputPath,
-  paths = ['./'],
-  privateToken = 'local',
-} = {}) => {
+export const getDotenvSync = (options = {}) => {
+  // Apply defaults.
+  let {
+    dotenvToken,
+    env,
+    dynamicPath,
+    excludeDynamic,
+    excludeEnv,
+    excludeGlobal,
+    excludePrivate,
+    excludePublic,
+    loadProcess,
+    log,
+    outputPath,
+    paths,
+    privateToken,
+    vars,
+  } = { ...dotenvDefaults, ...options };
+
   // Read .env files.
-  const parsed = paths.reduce(
-    (e, p) => ({
-      ...e,
-      ...(excludePublic
+  const loaded = paths.reduce((e, p) => {
+    let publicGlobal =
+      excludePublic || excludeGlobal
         ? {}
-        : {
-            ...(excludeGlobal
-              ? {}
-              : readDotenvSync(path.resolve(p, dotenvToken))),
-            ...(env && !excludeEnv
-              ? readDotenvSync(path.resolve(p, `${dotenvToken}.${env}`))
-              : {}),
-          }),
-      ...(excludePrivate
+        : readDotenvSync(path.resolve(p, dotenvToken));
+    let publicEnv =
+      excludePublic || excludeEnv
         ? {}
-        : {
-            ...(excludeGlobal
-              ? {}
-              : readDotenvSync(
-                  path.resolve(p, `${dotenvToken}.${privateToken}`)
-                )),
-            ...(env && !excludeEnv
-              ? readDotenvSync(
-                  path.resolve(p, `${dotenvToken}.${env}.${privateToken}`)
-                )
-              : {}),
-          }),
-    }),
-    {}
-  );
+        : readDotenvSync(path.resolve(p, `${dotenvToken}.${env}`));
+    let privateGlobal =
+      excludePrivate || excludeGlobal
+        ? {}
+        : readDotenvSync(path.resolve(p, `${dotenvToken}.${privateToken}`));
+    let privateEnv =
+      excludePrivate || excludeEnv
+        ? {}
+        : readDotenvSync(
+            path.resolve(p, `${dotenvToken}.${env}.${privateToken}`)
+          );
+
+    return {
+      ...e,
+      ...publicGlobal,
+      ...publicEnv,
+      ...privateGlobal,
+      ...privateEnv,
+    };
+  }, {});
 
-  const outputKey = uuid();
+  const outputKey = nanoid();
   const { parsed: dotenv } = expand({
     ignoreProcessEnv: true,
     parsed: {
-      ...parsed,
+      ...loaded,
+      ...vars,
       ...(outputPath ? { [outputKey]: outputPath } : {}),
     },
   });

package/lib/index.js

@@ -1,4 +1,3 @@
 export { dotenvExpand } from './dotenvExpand.js';
-export { getAwsSsoCredentials } from './getAwsSsoCredentials.js';
 export { getDotenv, getDotenvSync } from './getDotenv.js';
-export { parseBranch } from './parseBranch.js';
+export { getCli } from './getCli.js';

package/package.json

@@ -3,7 +3,7 @@
   "bin": {
     "getdotenv": "bin/getdotenv/index.js"
   },
-  "version": "2.6.8",
+  "version": "3.0.1",
   "publishConfig": {
     "access": "public"
   },
@@ -31,14 +31,15 @@
   ],
   "license": "BSD-3-Clause",
   "dependencies": {
+    "boolean": "^3.2.0",
     "commander": "^11.0.0",
-    "cross-spawn": "^7.0.3",
     "dotenv": "^16.3.1",
     "dotenv-expand": "^10.0.0",
+    "execa": "^7.1.1",
     "fs-extra": "^11.1.1",
-    "git-branch": "^2.0.1",
-    "string-argv": "^0.3.2",
-    "uuid": "^9.0.0"
+    "lodash.frompairs": "^4.0.1",
+    "lodash.isstring": "^4.0.1",
+    "nanoid": "^4.0.2"
   },
   "devDependencies": {
     "@babel/cli": "^7.22.5",
@@ -46,10 +47,10 @@
     "@babel/eslint-parser": "^7.22.5",
     "@babel/preset-env": "^7.22.5",
     "@babel/register": "^7.22.5",
-    "@types/node": "^20.3.1",
+    "@types/node": "^20.3.3",
     "chai": "^4.3.7",
     "concat-md": "^0.5.1",
-    "eslint": "^8.43.0",
+    "eslint": "^8.44.0",
     "eslint-plugin-mocha": "^10.1.0",
     "eslint-plugin-promise": "^6.1.1",
     "jsdoc-to-markdown": "^8.0.0",

package/dist/default/lib/getAwsSsoCredentials.js

@@ -1,33 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.getAwsSsoCredentials = void 0;
-var _crossSpawn = _interopRequireDefault(require("cross-spawn"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-// npm imports
-
-const getAwsSsoCredentials = localProfile => {
-  if (!(localProfile !== null && localProfile !== void 0 && localProfile.length)) {
-    delete process.env.AWS_ACCESS_KEY_ID;
-    delete process.env.AWS_SECRET_ACCESS_KEY;
-    delete process.env.AWS_SESSION_TOKEN;
-    return;
-  }
-  const {
-    status,
-    stderr,
-    stdout
-  } = _crossSpawn.default.sync('aws', ['configure', 'export-credentials', '--profile', localProfile]);
-  if (status) throw new Error(stderr.toString());
-  const {
-    AccessKeyId,
-    SecretAccessKey,
-    SessionToken
-  } = JSON.parse(stdout.toString());
-  process.env.AWS_ACCESS_KEY_ID = AccessKeyId;
-  process.env.AWS_SECRET_ACCESS_KEY = SecretAccessKey;
-  process.env.AWS_SESSION_TOKEN = SessionToken;
-};
-exports.getAwsSsoCredentials = getAwsSsoCredentials;

package/dist/default/lib/parseBranch.js

@@ -1,21 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.parseBranch = void 0;
-var _gitBranch = _interopRequireDefault(require("git-branch"));
-var _lodash = _interopRequireDefault(require("lodash"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-// npm imports
-
-const parseBranch = branchName => {
-  var _branchName$match;
-  try {
-    branchName ??= _gitBranch.default.sync() ?? '';
-  } catch {
-    branchName ??= '';
-  }
-  return _lodash.default.omitBy(((_branchName$match = branchName.match(/^(?:(?<branchType>[^/\s]+)\/(?:(?<branchLabel>[^/\s]+)))?(?:\/?(?<envToken>[^/\s]+))?$/)) === null || _branchName$match === void 0 ? void 0 : _branchName$match.groups) ?? {}, _lodash.default.isNil);
-};
-exports.parseBranch = parseBranch;

package/lib/getAwsSsoCredentials.js

@@ -1,28 +0,0 @@
-// npm imports
-import spawn from 'cross-spawn';
-
-export const getAwsSsoCredentials = (localProfile) => {
-  if (!localProfile?.length) {
-    delete process.env.AWS_ACCESS_KEY_ID;
-    delete process.env.AWS_SECRET_ACCESS_KEY;
-    delete process.env.AWS_SESSION_TOKEN;
-    return;
-  }
-
-  const { status, stderr, stdout } = spawn.sync('aws', [
-    'configure',
-    'export-credentials',
-    '--profile',
-    localProfile,
-  ]);
-
-  if (status) throw new Error(stderr.toString());
-
-  const { AccessKeyId, SecretAccessKey, SessionToken } = JSON.parse(
-    stdout.toString()
-  );
-
-  process.env.AWS_ACCESS_KEY_ID = AccessKeyId;
-  process.env.AWS_SECRET_ACCESS_KEY = SecretAccessKey;
-  process.env.AWS_SESSION_TOKEN = SessionToken;
-};

package/lib/parseBranch.js

@@ -1,18 +0,0 @@
-// npm imports
-import branch from 'git-branch';
-import _ from 'lodash';
-
-export const parseBranch = (branchName) => {
-  try {
-    branchName ??= branch.sync() ?? '';
-  } catch {
-    branchName ??= '';
-  }
-
-  return _.omitBy(
-    branchName.match(
-      /^(?:(?<branchType>[^/\s]+)\/(?:(?<branchLabel>[^/\s]+)))?(?:\/?(?<envToken>[^/\s]+))?$/
-    )?.groups ?? {},
-    _.isNil
-  );
-};