@dotenvx/dotenvx 1.45.2 → 1.46.0

package/CHANGELOG.md

@@ -2,7 +2,15 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
-[Unreleased](https://github.com/dotenvx/dotenvx/compare/v1.45.2...main)
+[Unreleased](https://github.com/dotenvx/dotenvx/compare/v1.46.0...main)
+
+## Added
+
+* Add error when hoisting issue experienced around commander.js ([#623](https://github.com/dotenvx/dotenvx/pull/623))
+
+## Removed
+
+* Remove `git-dotenvx` and `git dotenvx` shorthand ([#621](https://github.com/dotenvx/dotenvx/pull/621))
 
 ## 1.45.2
 

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.45.2",
+  "version": "1.46.0",
   "name": "@dotenvx/dotenvx",
   "description": "a better dotenv–from the creator of `dotenv`",
   "author": "@motdotla",
@@ -30,8 +30,7 @@
     "./package.json": "./package.json"
   },
   "bin": {
-    "dotenvx": "./src/cli/dotenvx.js",
-    "git-dotenvx": "./src/cli/dotenvx.js"
+    "dotenvx": "./src/cli/dotenvx.js"
   },
   "scripts": {
     "standard": "standard",

package/src/cli/dotenvx.js

@@ -7,6 +7,8 @@ const program = new Command()
 const { setLogLevel, logger } = require('../shared/logger')
 const examples = require('./examples')
 const packageJson = require('./../lib/helpers/packageJson')
+const Errors = require('./../lib/helpers/errors')
+const getCommanderVersion = require('./../lib/helpers/getCommanderVersion')
 const executeDynamic = require('./../lib/helpers/executeDynamic')
 const removeDynamicHelpSection = require('./../lib/helpers/removeDynamicHelpSection')
 const removeOptionsHelpParts = require('./../lib/helpers/removeOptionsHelpParts')
@@ -20,6 +22,15 @@ function collectEnvs (type) {
   }
 }
 
+// surface hoisting problems
+const commanderVersion = getCommanderVersion()
+if (commanderVersion && parseInt(commanderVersion.split('.')[0], 10) >= 12) {
+  const message = `dotenvx depends on commander@11.x.x but you are attempting to hoist commander@${commanderVersion}`
+  const error = new Errors({ message }).dangerousDependencyHoist()
+  logger.error(error.message)
+  if (error.help) logger.error(error.help)
+}
+
 // global log levels
 program
   .usage('run -- yourcommand')

package/src/lib/helpers/errors.js

@@ -96,6 +96,17 @@ class Errors {
     e.help = help
     return e
   }
+
+  dangerousDependencyHoist () {
+    const code = 'DANGEROUS_DEPENDENCY_HOIST'
+    const message = `[${code}] your environment has hoisted an incompatible version of a dotenvx dependency: ${this.message}`
+    const help = `[${code}] https://github.com/dotenvx/dotenvx/issues/622`
+
+    const e = new Error(message)
+    e.code = code
+    e.help = help
+    return e
+  }
 }
 
 module.exports = Errors

package/src/lib/helpers/getCommanderVersion.js

@@ -0,0 +1,10 @@
+const fs = require('fs')
+const path = require('path')
+
+function getCommanderVersion () {
+  const commanderMain = require.resolve('commander')
+  const pkgPath = path.join(commanderMain, '..', 'package.json')
+  return JSON.parse(fs.readFileSync(pkgPath, 'utf8')).version
+}
+
+module.exports = getCommanderVersion