@dotenvx/dotenvx 0.15.3 → 0.16.0

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.15.3",
+  "version": "0.16.0",
   "name": "@dotenvx/dotenvx",
   "description": "a better dotenv–from the creator of `dotenv`",
   "author": "@motdotla",
@@ -21,7 +21,9 @@
   "scripts": {
     "standard": "standard",
     "standard:fix": "standard --fix",
-    "test": "jest --verbose"
+    "test": "tap 'tests/**/*.test.js' --100",
+    "prerelease": "npm test",
+    "release": "standard-version"
   },
   "funding": "Have you seen dotenvx.com? run anywhere, cross-platform, and encrypted envs.",
   "dependencies": {
@@ -30,10 +32,12 @@
     "clipboardy": "^2.3.0",
     "commander": "^11.1.0",
     "conf": "^10.2.0",
-    "dotenv": "^16.4.2",
-    "dotenv-expand": "^11.0.3",
+    "dotenv": "^16.4.4",
+    "dotenv-expand": "^11.0.6",
     "execa": "^5.1.1",
+    "glob": "^10.3.10",
     "ignore": "^5.3.0",
+    "object-treeify": "1.1.33",
     "open": "^8.4.2",
     "ora": "^5.4.1",
     "undici": "^5.28.3",
@@ -42,15 +46,13 @@
     "xxhashjs": "^0.2.2"
   },
   "devDependencies": {
-    "jest": "^29.7.0",
-    "jest-mock-process": "^2.0.0",
+    "capture-console": "^1.0.2",
     "pkg": "^5.8.1",
-    "standard": "^17.1.0"
-  },
-  "standard": {
-    "env": [
-      "jest"
-    ]
+    "proxyquire": "^2.1.3",
+    "sinon": "^14.0.1",
+    "standard": "^17.1.0",
+    "standard-version": "^9.5.0",
+    "tap": "^16.3.0"
   },
   "publishConfig": {
     "access": "public"

package/src/cli/actions/ls.js

@@ -0,0 +1,24 @@
+const treeify = require('object-treeify')
+
+const logger = require('./../../shared/logger')
+
+const main = require('./../../lib/main')
+const ArrayToTree = require('./../../lib/helpers/arrayToTree')
+
+function ls (directory) {
+  // debug args
+  logger.debug(`directory: ${directory}`)
+
+  const options = this.opts()
+  logger.debug(`options: ${JSON.stringify(options)}`)
+
+  const filepaths = main.ls(directory, options.envFile)
+  logger.debug(`filepaths: ${JSON.stringify(filepaths)}`)
+
+  const tree = new ArrayToTree(filepaths).run()
+  logger.debug(`tree: ${JSON.stringify(tree)}`)
+
+  logger.info(treeify(tree))
+}
+
+module.exports = ls

package/src/cli/actions/precommit.js

@@ -1,15 +1,20 @@
 const fs = require('fs')
 const path = require('path')
-
 const ignore = require('ignore')
 
 const logger = require('./../../shared/logger')
+
 const helpers = require('./../helpers')
 
+const Precommit = require('./../../lib/services/precommit')
+
 function precommit () {
   const options = this.opts()
   logger.debug(`options: ${JSON.stringify(options)}`)
 
+  const precommit = new Precommit(options)
+  precommit.run()
+
   // 0. handle the --install flag
   if (options.install) {
     installPrecommitHook()

package/src/cli/actions/run.js

@@ -14,7 +14,8 @@ async function run () {
 
   // load from .env.vault file
   if (process.env.DOTENV_KEY && process.env.DOTENV_KEY.length > 0) {
-    const filepath = helpers.resolvePath('.env.vault')
+    const envVaultFilepath = options.envVaultFile // .env.vault
+    const filepath = helpers.resolvePath(envVaultFilepath)
 
     if (!fs.existsSync(filepath)) {
       logger.error(`you set DOTENV_KEY but your .env.vault file is missing: ${filepath}`)
@@ -56,7 +57,7 @@ async function run () {
         const parsed = main.parseExpand(decrypted)
         const result = main.inject(process.env, parsed, options.overload)
 
-        logger.successv(`injecting env (${result.injected.size}) from encrypted .env.vault`)
+        logger.successv(`injecting env (${result.injected.size}) from encrypted ${envVaultFilepath}`)
       } catch (e) {
         logger.error(e)
       }
@@ -78,7 +79,7 @@ async function run () {
 
       try {
         const src = fs.readFileSync(filepath, { encoding: ENCODING })
-        const parsed = main.parseExpand(src)
+        const parsed = main.parseExpand(src, options.overload)
         const result = main.inject(process.env, parsed, options.overload)
 
         readableFilepaths.add(envFilepath)

package/src/cli/dotenvx.js

@@ -56,6 +56,7 @@ program.command('run')
   .description('inject env at runtime [dotenvx run -- yourcommand]')
   .addHelpText('after', examples.run)
   .option('-f, --env-file <paths...>', 'path(s) to your env file(s)', '.env')
+  .option('-fv, --env-vault-file <path>', 'path to your .env.vault file', '.env.vault')
   .option('-o, --overload', 'override existing env variables')
   .action(require('./actions/run'))
 
@@ -96,6 +97,13 @@ program.command('genexample')
   .option('-f, --env-file <paths...>', 'path(s) to your env file(s)', '.env')
   .action(require('./actions/genexample'))
 
+// dotenvx ls
+program.command('ls')
+  .description('print all .env files in a tree structure')
+  .argument('[directory]', 'directory to list .env files from', '.')
+  .option('-f, --env-file <filenames...>', 'path(s) to your env file(s)', '.env*')
+  .action(require('./actions/ls'))
+
 // dotenvx hub
 program.addCommand(require('./commands/hub'))
 

package/src/lib/helpers/arrayToTree.js

@@ -0,0 +1,24 @@
+class ArrayToTree {
+  constructor (arr) {
+    this.arr = arr
+  }
+
+  run () {
+    const tree = {}
+
+    for (let i = 0; i < this.arr.length; i++) {
+      const parts = this.arr[i].split('/')
+      let current = tree
+
+      for (let j = 0; j < parts.length; j++) {
+        const part = parts[j]
+        current[part] = current[part] || {}
+        current = current[part]
+      }
+    }
+
+    return tree
+  }
+}
+
+module.exports = ArrayToTree

package/src/lib/helpers/installPrecommitHook.js

@@ -0,0 +1,63 @@
+const fs = require('fs')
+const path = require('path')
+
+const logger = require('./../../shared/logger')
+
+const HOOK_SCRIPT = `#!/bin/sh
+
+if ! command -v dotenvx &> /dev/null
+then
+  echo "[dotenvx][precommit] 'dotenvx' command not found"
+  echo "[dotenvx][precommit] ? install it with [brew install dotenvx/brew/dotenvx]"
+  echo "[dotenvx][precommit] ? other install options [https://dotenvx.com/docs/install]"
+  exit 1
+fi
+
+dotenvx precommit`
+
+class InstallPrecommitHook {
+  constructor () {
+    this.hookPath = path.join('.git', 'hooks', 'pre-commit')
+  }
+
+  run () {
+    try {
+      // Check if the pre-commit file already exists
+      if (this._exists()) {
+        // Check if 'dotenvx precommit' already exists in the file
+        if (!this._currentHook().includes('dotenvx precommit')) {
+          this._appendHook()
+        } else {
+          logger.warnvp(`dotenvx precommit exists [${this.hookPath}]`)
+        }
+      } else {
+        this._createHook()
+      }
+    } catch (err) {
+      logger.errorvp(`failed to modify pre-commit hook: ${err.message}`)
+    }
+  }
+
+  _exists () {
+    return fs.existsSync(this.hookPath)
+  }
+
+  _currentHook () {
+    return fs.readFileSync(this.hookPath, 'utf8')
+  }
+
+  _createHook () {
+    // If the pre-commit file doesn't exist, create a new one with the hookScript
+    fs.writeFileSync(this.hookPath, HOOK_SCRIPT)
+    fs.chmodSync(this.hookPath, '755') // Make the file executable
+    logger.successvp(`dotenvx precommit installed [${this.hookPath}]`)
+  }
+
+  _appendHook () {
+    // Append 'dotenvx precommit' to the existing file
+    fs.appendFileSync(this.hookPath, '\n' + HOOK_SCRIPT)
+    logger.successvp(`dotenvx precommit appended [${this.hookPath}]`)
+  }
+}
+
+module.exports = InstallPrecommitHook

package/src/lib/main.js

@@ -2,6 +2,9 @@ const logger = require('./../shared/logger')
 const dotenv = require('dotenv')
 const dotenvExpand = require('dotenv-expand')
 
+// services
+const Ls = require('./services/ls')
+
 const config = function (options) {
   return dotenv.config(options)
 }
@@ -36,20 +39,27 @@ const parse = function (src) {
   return result
 }
 
-const parseExpand = function (src) {
+const parseExpand = function (src, overload) {
   const parsed = dotenv.parse(src)
+
+  // consider moving this logic straight into dotenv-expand
+  let inputParsed = {}
+  if (overload) {
+    inputParsed = { ...process.env, ...parsed }
+  } else {
+    inputParsed = { ...parsed, ...process.env }
+  }
+
   const expandPlease = {
-    processEnv: {}, // https://github.com/motdotla/dotenv-expand?tab=readme-ov-file#processenv
-    parsed: { ...parsed, ...process.env } // must merge process.env in order to use pre-existing envs for expansion of parsed object
+    processEnv: {},
+    parsed: inputParsed
   }
   const expanded = dotenvExpand.expand(expandPlease).parsed
 
   // but then for logging only log the original keys existing in parsed. this feels unnecessarily complex - like dotenv-expand should support the ability to inject additional `process.env` or objects as it sees fit to the object it wants to expand
   const result = {}
   for (const key in parsed) {
-    if (Object.prototype.hasOwnProperty.call(expanded, key)) {
-      result[key] = expanded[key]
-    }
+    result[key] = expanded[key]
   }
 
   logger.debug(result)
@@ -95,11 +105,16 @@ const inject = function (processEnv = {}, parsed = {}, overload = false) {
   }
 }
 
+const ls = function (directory, envFile) {
+  return new Ls(directory, envFile).run()
+}
+
 module.exports = {
   config,
   configDotenv,
   decrypt,
   parse,
   parseExpand,
-  inject
+  inject,
+  ls
 }

package/src/lib/services/ls.js

@@ -0,0 +1,41 @@
+const path = require('path')
+const globSync = require('glob').globSync
+
+class Ls {
+  constructor (directory = './', envFile = '.env*') {
+    this.ignore = ['node_modules/**', '.git/**']
+
+    this.cwd = path.resolve(directory)
+    this.envFile = envFile
+  }
+
+  run () {
+    return this._filepaths()
+  }
+
+  _filepaths () {
+    const options = {
+      ignore: this.ignore,
+      cwd: this.cwd // context dirctory for globSync
+    }
+
+    const patterns = this._patterns()
+    return globSync(patterns, options)
+  }
+
+  _patterns () {
+    if (!Array.isArray(this.envFile)) {
+      return `**/${this.envFile}`
+    }
+
+    const out = []
+
+    for (let i = 0; i < this.envFile.length; i++) {
+      const part = this.envFile[i]
+      out.push(`**/${part}`)
+    }
+    return out
+  }
+}
+
+module.exports = Ls

package/src/lib/services/precommit.js

@@ -0,0 +1,26 @@
+const logger = require('./../../shared/logger')
+
+const InstallPrecommitHook = require('./../helpers/installPrecommitHook')
+
+class Precommit {
+  constructor (options = {}) {
+    this.install = options.install
+  }
+
+  run () {
+    if (this.install) {
+      this._installPrecommitHook()
+
+      return true
+    }
+
+    logger.info('implement')
+  }
+
+  /* istanbul ignore next */
+  _installPrecommitHook () {
+    new InstallPrecommitHook().run()
+  }
+}
+
+module.exports = Precommit

package/src/shared/logger.js

@@ -83,8 +83,6 @@ const dotenvxFormat = printf(({ level, message, label, timestamp }) => {
       return debug(formattedMessage)
     case 'blank': // custom
       return formattedMessage
-    default: // handle uncaught
-      return formattedMessage
   }
 })