@karmaniverous/get-dotenv 2.4.0 → 2.4.2

package/README.md

@@ -77,7 +77,7 @@ dotenv files. You can:
 * 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.
-* Drive the current git branch to an environment variable.
+* Derive the default environment from the current git branch
 * Exclude public, private, global, environment-specific, or dynamic variables.
 * Execute a &&-delimited series of shell commands after loading variables,
   optionally ignoring errors.
@@ -90,8 +90,8 @@ 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 (follows dotenv-expand rules using loaded env vars)
-  -b, --git-branch <string>           environment variable to populate with current git branch
   -d, --default-environment <string>  default environment (prefix with $ to use environment variable)
+  -b, --branch-to-default             derive default environment from the current git branch (default: false)
   -e, --environment <string>          designated environment (prefix with $ to use environment variable)
   -n, --exclude-env                   exclude environment-specific variables (default: false)
   -g, --exclude-global                exclude global & dynamic variables (default: false)
@@ -169,7 +169,6 @@ get-dotenv options type
 | [excludeGlobal] | <code>bool</code> | exclude global & dynamic variables (default: false) |
 | [excludePrivate] | <code>bool</code> | exclude private variables (default: false) |
 | [excludePublic] | <code>bool</code> | exclude public variables (default: false) |
-| [gitBranch] | <code>string</code> | environment variable to populate with current git branch |
 | [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 (follows [dotenv-expand rules](https://github.com/motdotla/dotenv-expand/blob/master/tests/.env)) |

package/bin/getdotenv/index.js

@@ -6,7 +6,7 @@ import _ from 'lodash';
 import { parseArgsStringToArgv } from 'string-argv';
 
 // Import package exports.
-import { getDotenv } from '@karmaniverous/get-dotenv';
+import { getDotenv, parseBranch } from '@karmaniverous/get-dotenv';
 
 // Create CLI.
 import { program } from 'commander';
@@ -32,7 +32,7 @@ program
       `* 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.`,
-      `* Drive the current git branch to an environment variable.`,
+      `* Derive the default environment from the current git branch`,
       `* Exclude public, private, global, environment-specific, or dynamic variables.`,
       `* Execute a &&-delimited series of shell commands after loading variables,`,
       `  optionally ignoring errors.`,
@@ -55,13 +55,13 @@ program
     'consolidated output file (follows dotenv-expand rules using loaded env vars)'
   )
   .option(
-    '-b, --git-branch <string>',
-    'environment variable to populate with current git branch',
+    '-d, --default-environment <string>',
+    'default environment (prefix with $ to use environment variable)',
     envMerge
   )
   .option(
-    '-d, --default-environment <string>',
-    'default environment (prefix with $ to use environment variable)',
+    '-b, --branch-to-default',
+    'derive default environment from the current git branch (default: false)',
     envMerge
   )
   .option(
@@ -98,6 +98,7 @@ program
 // Parse CLI options from command line.
 program.parse();
 const {
+  branchToDefault,
   command,
   defaultEnvironment,
   dotenvToken,
@@ -107,7 +108,6 @@ const {
   excludeGlobal,
   excludePrivate,
   excludePublic,
-  gitBranch,
   log,
   outputPath,
   paths,
@@ -117,8 +117,12 @@ const {
 
 if (command && program.args.length) program.error('command specified twice');
 
+if (branchToDefault) {
+  var { envToken } = parseBranch();
+}
+
 // Get environment.
-const env = environment ?? defaultEnvironment;
+const env = environment ?? envToken ?? defaultEnvironment;
 
 // Load dotenvs.
 await getDotenv({
@@ -128,7 +132,6 @@ await getDotenv({
   excludeGlobal,
   excludePrivate,
   excludePublic,
-  gitBranch,
   loadProcess: true,
   dynamicPath,
   log,

package/dist/default/lib/{getDotenv/getDotenv.js → getDotenv.js}

@@ -6,10 +6,9 @@ Object.defineProperty(exports, "__esModule", {
 exports.getDotenvSync = exports.getDotenv = void 0;
 var _dotenvExpand = require("dotenv-expand");
 var _fsExtra = _interopRequireDefault(require("fs-extra"));
-var _gitBranch = _interopRequireDefault(require("git-branch"));
 var _path = _interopRequireDefault(require("path"));
 var _uuid = require("uuid");
-var _readDotenv = require("../readDotEnv/readDotenv.js");
+var _readDotenv = require("./readDotenv.js");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 // npm imports
 
@@ -28,7 +27,6 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * @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 {string} [gitBranch] - environment variable to populate with current git branch
  * @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 (follows {@link https://github.com/motdotla/dotenv-expand/blob/master/tests/.env dotenv-expand rules})
@@ -56,7 +54,6 @@ const getDotenv = async function () {
     excludeGlobal = false,
     excludePrivate = false,
     excludePublic = false,
-    gitBranch,
     loadProcess = false,
     log = false,
     outputPath,
@@ -88,9 +85,6 @@ const getDotenv = async function () {
     }
   });
 
-  // Add git branch.
-  if (gitBranch) dotenv[gitBranch] = await (0, _gitBranch.default)();
-
   // Process dynamic variables.
   if (dynamicPath && !excludeDynamic) {
     const dynamic = new Function(`return ${(await _fsExtra.default.readFile(dynamicPath)).toString()}`)()(dotenv);
@@ -127,7 +121,6 @@ const getDotenv = async function () {
       excludeGlobal,
       excludePrivate,
       excludePublic,
-      gitBranch,
       loadProcess,
       log,
       outputPath,
@@ -158,7 +151,6 @@ const getDotenvSync = function () {
     excludeGlobal = false,
     excludePrivate = false,
     excludePublic = false,
-    gitBranch,
     loadProcess = false,
     log = false,
     outputPath,
@@ -190,9 +182,6 @@ const getDotenvSync = function () {
     }
   });
 
-  // Add git branch.
-  if (gitBranch) dotenv[gitBranch] = _gitBranch.default.sync();
-
   // Process dynamic variables.
   if (dynamicPath && !excludeDynamic) {
     const dynamic = new Function(`return ${_fsExtra.default.readFileSync(dynamicPath).toString()}`)()(dotenv);
@@ -229,7 +218,6 @@ const getDotenvSync = function () {
       excludeGlobal,
       excludePrivate,
       excludePublic,
-      gitBranch,
       loadProcess,
       log,
       outputPath,

package/dist/default/lib/index.js

@@ -15,4 +15,11 @@ Object.defineProperty(exports, "getDotenvSync", {
     return _getDotenv.getDotenvSync;
   }
 });
-var _getDotenv = require("./getDotenv/getDotenv.js");
+Object.defineProperty(exports, "parseBranch", {
+  enumerable: true,
+  get: function () {
+    return _parseBranch.parseBranch;
+  }
+});
+var _getDotenv = require("./getDotenv.js");
+var _parseBranch = require("./parseBranch.js");

package/dist/default/lib/parseBranch.js

@@ -0,0 +1,20 @@
+"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 => {
+  try {
+    branchName ??= _gitBranch.default.sync();
+  } catch {
+    branchName ??= '';
+  }
+  return _lodash.default.omitBy(branchName.match(/^(?<branchType>[^/\s]+)(?:\/(?<branchLabel>[^/\s]+)(?:\/(?<envToken>[^/\s]+))?)?$/)?.groups ?? {}, _lodash.default.isNil);
+};
+exports.parseBranch = parseBranch;

package/lib/{getDotenv/getDotenv.js → getDotenv.js}

@@ -1,12 +1,11 @@
 // npm imports
 import { expand } from 'dotenv-expand';
 import fs from 'fs-extra';
-import branch from 'git-branch';
 import path from 'path';
 import { v4 as uuid } from 'uuid';
 
 // lib imports
-import { readDotenv, readDotenvSync } from '../readDotEnv/readDotenv.js';
+import { readDotenv, readDotenvSync } from './readDotenv.js';
 
 /**
  * get-dotenv options type
@@ -21,7 +20,6 @@ import { readDotenv, readDotenvSync } from '../readDotEnv/readDotenv.js';
  * @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 {string} [gitBranch] - environment variable to populate with current git branch
  * @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 (follows {@link https://github.com/motdotla/dotenv-expand/blob/master/tests/.env dotenv-expand rules})
@@ -48,7 +46,6 @@ export const getDotenv = async ({
   excludeGlobal = false,
   excludePrivate = false,
   excludePublic = false,
-  gitBranch,
   loadProcess = false,
   log = false,
   outputPath,
@@ -96,9 +93,6 @@ export const getDotenv = async ({
     },
   });
 
-  // Add git branch.
-  if (gitBranch) dotenv[gitBranch] = await branch();
-
   // Process dynamic variables.
   if (dynamicPath && !excludeDynamic) {
     const dynamic = new Function(
@@ -146,7 +140,6 @@ export const getDotenv = async ({
         excludeGlobal,
         excludePrivate,
         excludePublic,
-        gitBranch,
         loadProcess,
         log,
         outputPath,
@@ -176,7 +169,6 @@ export const getDotenvSync = ({
   excludeGlobal = false,
   excludePrivate = false,
   excludePublic = false,
-  gitBranch,
   loadProcess = false,
   log = false,
   outputPath,
@@ -224,9 +216,6 @@ export const getDotenvSync = ({
     },
   });
 
-  // Add git branch.
-  if (gitBranch) dotenv[gitBranch] = branch.sync();
-
   // Process dynamic variables.
   if (dynamicPath && !excludeDynamic) {
     const dynamic = new Function(
@@ -274,7 +263,6 @@ export const getDotenvSync = ({
         excludeGlobal,
         excludePrivate,
         excludePublic,
-        gitBranch,
         loadProcess,
         log,
         outputPath,

package/lib/index.js

@@ -1 +1,2 @@
-export { getDotenv, getDotenvSync } from './getDotenv/getDotenv.js';
+export { getDotenv, getDotenvSync } from './getDotenv.js';
+export { parseBranch } from './parseBranch.js';

package/lib/parseBranch.js

@@ -0,0 +1,18 @@
+// 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
+  );
+};

package/package.json

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