@dotenvx/dotenvx 1.20.1 → 1.21.1

package/CHANGELOG.md

@@ -2,7 +2,26 @@
 
 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.20.0...main)
+## [Unreleased](https://github.com/dotenvx/dotenvx/compare/v1.21.1...main)
+
+## 1.21.1
+
+### Changed
+
+* for `--convention nextjs` ingnore `.env.local` for TEST environment ([#425](https://github.com/dotenvx/dotenvx/pull/425))
+* for `precommit` redirect missing `dotenvx` command using POSIX compliant redirection ([#424](https://github.com/dotenvx/dotenvx/pull/424))
+* make parent `dotenvx help` command less noisy by removing `[options]`. run `dotenvx COMMAND -h` to list all available options like always ([#429](https://github.com/dotenvx/dotenvx/pull/429))
+
+## 1.21.0
+
+### Changed
+
+* treat single quotes literally ([#423](https://github.com/dotenvx/dotenvx/pull/423))
+* respect user chosen quotes ([#423](https://github.com/dotenvx/dotenvx/pull/423) [#377](https://github.com/dotenvx/dotenvx/issues/377))
+
+🎓 now if you choose to single quote, double quote, no quote, or backtick your value it will be respected - including for encrypted values. this more intuitively handles complex cases like escaped characters, literals, and json.
+
+## 1.20.1
 
 ### Changed
 

package/README.md

@@ -1536,7 +1536,7 @@ More examples
 
   ```sh
   $ dotenvx help
-  Usage: dotenvx [options] [command] [command] [args...]
+  Usage: dotenvx run -- yourcommand
 
   a better dotenv–from the creator of `dotenv`
 
@@ -1549,12 +1549,13 @@ More examples
     -h, --help                   display help for command
 
   Commands:
-    run [options]                inject env at runtime [dotenvx run -- yourcommand]
-    get [options] [key]          return a single environment variable
-    set [options] <KEY> <value>  set a single environment variable
-    encrypt [options]            convert .env file(s) to encrypted .env file(s)
-    decrypt [options]            convert encrypted .env file(s) to plain .env file(s)
-    ls [options] [directory]     print all .env files in a tree structure
+    run                inject env at runtime [dotenvx run -- yourcommand]
+    get [KEY]          return a single environment variable
+    set <KEY> <value>  set a single environment variable
+    encrypt            convert .env file(s) to encrypted .env file(s)
+    decrypt            convert encrypted .env file(s) to plain .env file(s)
+    keypair [KEY]      print public/private keys for .env file(s)
+    ls [directory]     print all .env files in a tree structure
    
   Advanced: 
     pro                          🏆 pro

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.20.1",
+  "version": "1.21.1",
   "name": "@dotenvx/dotenvx",
   "description": "a better dotenv–from the creator of `dotenv`",
   "author": "@motdotla",

package/src/cli/dotenvx.js

@@ -9,6 +9,7 @@ const examples = require('./examples')
 const packageJson = require('./../lib/helpers/packageJson')
 const executeDynamic = require('./../lib/helpers/executeDynamic')
 const removeDynamicHelpSection = require('./../lib/helpers/removeDynamicHelpSection')
+const removeOptionsHelpParts = require('./../lib/helpers/removeOptionsHelpParts')
 
 // for use with run
 const envs = []
@@ -21,6 +22,7 @@ function collectEnvs (type) {
 
 // global log levels
 program
+  .usage('run -- yourcommand')
   .option('-l, --log-level <level>', 'set log level', 'info')
   .option('-q, --quiet', 'sets log level to error')
   .option('-v, --verbose', 'sets log level to verbose')
@@ -65,8 +67,9 @@ program.command('run')
 // dotenvx get
 const getAction = require('./actions/get')
 program.command('get')
+  .usage('[KEY] [options]')
   .description('return a single environment variable')
-  .argument('[key]', 'environment variable name')
+  .argument('[KEY]', 'environment variable name')
   .option('-e, --env <strings...>', 'environment variable(s) set as string (example: "HELLO=World")', collectEnvs('env'), [])
   .option('-f, --env-file <paths...>', 'path(s) to your env file(s)', collectEnvs('envFile'), [])
   .option('-fv, --env-vault-file <paths...>', 'path(s) to your .env.vault file(s)', collectEnvs('envVaultFile'), [])
@@ -83,6 +86,7 @@ program.command('get')
 // dotenvx set
 const setAction = require('./actions/set')
 program.command('set')
+  .usage('<KEY> <value> [options]')
   .description('set a single environment variable')
   .addHelpText('after', examples.set)
   .allowUnknownOption()
@@ -125,8 +129,9 @@ program.command('decrypt')
 // dotenvx keypair
 const keypairAction = require('./actions/keypair')
 program.command('keypair')
+  .usage('[KEY] [options]')
   .description('print public/private keys for .env file(s)')
-  .argument('[key]', 'environment variable key name')
+  .argument('[KEY]', 'environment variable key name')
   .option('-f, --env-file <paths...>', 'path(s) to your env file(s)')
   .option('-pp, --pretty-print', 'pretty print output')
   .option('--format <type>', 'format of the output (json, shell)', 'json')
@@ -196,6 +201,7 @@ program.helpInformation = function () {
   const lines = originalHelp.split('\n')
 
   removeDynamicHelpSection(lines)
+  removeOptionsHelpParts(lines)
 
   // Filter out the hidden command from the help output
   const filteredLines = lines.filter(line =>

package/src/lib/helpers/conventions.js

@@ -1,26 +1,14 @@
 function conventions (convention) {
   if (convention === 'nextjs') {
     const nodeEnv = process.env.NODE_ENV || 'development'
+    const canonicalEnv = ['development', 'test', 'production'].includes(nodeEnv) && nodeEnv
 
-    const envs = []
-
-    if (['development', 'test', 'production'].includes(nodeEnv)) {
-      envs.push({ type: 'envFile', value: `.env.${nodeEnv}.local` })
-    }
-
-    if (['development', 'production'].includes(nodeEnv)) {
-      envs.push({ type: 'envFile', value: '.env.local' })
-    }
-
-    if (['development', 'test', 'production'].includes(nodeEnv)) {
-      envs.push({ type: 'envFile', value: `.env.${nodeEnv}` })
-    }
-
-    if (['development', 'test', 'production'].includes(nodeEnv)) {
-      envs.push({ type: 'envFile', value: '.env' })
-    }
-
-    return envs
+    return [
+      canonicalEnv && { type: 'envFile', value: `.env.${canonicalEnv}.local` },
+      canonicalEnv !== 'test' && { type: 'envFile', value: '.env.local' },
+      canonicalEnv && { type: 'envFile', value: `.env.${canonicalEnv}` },
+      { type: 'envFile', value: '.env' }
+    ].filter(Boolean)
   } else {
     throw new Error(`INVALID_CONVENTION: '${convention}'. permitted conventions: ['nextjs']`)
   }

package/src/lib/helpers/installPrecommitHook.js

@@ -3,10 +3,10 @@ const path = require('path')
 
 const HOOK_SCRIPT = `#!/bin/sh
 
-if ! command -v dotenvx &> /dev/null
+if ! command -v dotenvx 2>&1 >/dev/null
 then
   echo "[dotenvx][precommit] 'dotenvx' command not found"
-  echo "[dotenvx][precommit] ? install it with [brew install dotenvx/brew/dotenvx]"
+  echo "[dotenvx][precommit] ? install it with [curl -fsS https://dotenvx.sh | sh]"
   echo "[dotenvx][precommit] ? other install options [https://dotenvx.com/docs/install]"
   exit 1
 fi

package/src/lib/helpers/parseDecryptEvalExpand.js

@@ -3,6 +3,7 @@ const dotenvEval = require('./dotenvEval')
 const dotenvExpand = require('./dotenvExpand')
 const decryptValue = require('./decryptValue')
 const truncate = require('./truncate')
+const quotes = require('./quotes')
 
 function warning (e, key, privateKey = null) {
   const warning = new Error(`[${e.code}] could not decrypt ${key} using private key '${truncate(privateKey)}'`)
@@ -15,8 +16,10 @@ function warning (e, key, privateKey = null) {
 function parseDecryptEvalExpand (src, privateKey = null, processEnv = process.env) {
   const warnings = []
 
-  // parse
+  // parse and quotes
   const parsed = dotenv.parse(src)
+  const _quotes = quotes(src)
+  const originalParsed = { ...parsed }
   for (const key in parsed) {
     try {
       const decryptedValue = decryptValue(parsed[key], privateKey)
@@ -39,7 +42,13 @@ function parseDecryptEvalExpand (src, privateKey = null, processEnv = process.en
     parsed: evaled
   }
   const expanded = dotenvExpand.expand(inputEvaled)
+
   for (const key in expanded.parsed) {
+    // unset eval and expansion for single quotes
+    if (_quotes[key] === "'") {
+      expanded.parsed[key] = originalParsed[key] // reset to original
+    }
+
     try {
       const decryptedValue = decryptValue(expanded.parsed[key], privateKey)
       expanded.parsed[key] = decryptedValue
@@ -48,6 +57,11 @@ function parseDecryptEvalExpand (src, privateKey = null, processEnv = process.en
     }
   }
   for (const key in processEnv) {
+    // unset eval and expansion for single quotes
+    if (_quotes[key] === "'") {
+      processEnv[key] = originalParsed[key] // reset to original
+    }
+
     try {
       const decryptedValue = decryptValue(processEnv[key], privateKey)
       processEnv[key] = decryptedValue

package/src/lib/helpers/quotes.js

@@ -0,0 +1,36 @@
+const LINE = /(?:^|^)\s*(?:export\s+)?([\w.-]+)(?:\s*=\s*?|:\s+?)(\s*'(?:\\'|[^'])*'|\s*"(?:\\"|[^"])*"|\s*`(?:\\`|[^`])*`|[^#\r\n]+)?\s*(?:#.*)?(?:$|$)/mg
+
+function quotes (src) {
+  const obj = {}
+  // Convert buffer to string
+  let lines = src.toString()
+
+  // Convert line breaks to same format
+  lines = lines.replace(/\r\n?/mg, '\n')
+
+  let match
+  while ((match = LINE.exec(lines)) != null) {
+    const key = match[1]
+
+    // Default undefined or null to empty string
+    let value = (match[2] || '')
+
+    // Remove whitespace
+    value = value.trim()
+
+    // Check if double quoted
+    const maybeQuote = value[0]
+
+    value = value.replace(/^(['"`])([\s\S]*)\1$/mg, '$2')
+
+    if (maybeQuote === value[0]) {
+      obj[key] = ''
+    } else {
+      obj[key] = maybeQuote
+    }
+  }
+
+  return obj
+}
+
+module.exports = quotes

package/src/lib/helpers/removeOptionsHelpParts.js

@@ -0,0 +1,11 @@
+// Remove [options] from help text. example:
+
+function removeOptionsHelpParts (lines) {
+  for (let i = 0; i < lines.length; i++) {
+    lines[i] = lines[i].replace(' [options]', '')
+  }
+
+  return lines
+}
+
+module.exports = removeOptionsHelpParts

package/src/lib/helpers/replace.js

@@ -1,28 +1,19 @@
-const util = require('util')
 const dotenv = require('dotenv')
 
+const quotes = require('./quotes')
 const escapeForRegex = require('./escapeForRegex')
 const escapeDollarSigns = require('./escapeDollarSigns')
 
 function replace (src, key, replaceValue) {
   let output
-  let escapedValue = util.inspect(replaceValue, { showHidden: false, depth: null, colors: false })
-
-  if (replaceValue.includes('\n')) {
-    escapedValue = JSON.stringify(replaceValue) // use JSON stringify if string contains newlines
-    escapedValue = escapedValue.replace(/\\n/g, '\n') // fix up newlines
-    escapedValue = escapedValue.replace(/\\r/g, '\r')
-  }
-
-  // prevents test\test (and similar) from becoming test\\test and then test\\\\test, etc recursively after each encrypt/decrypt combo
-  if (replaceValue.includes('\\')) {
-    escapedValue = escapedValue.replace(/\\\\/g, '\\')
-  }
-
-  let newPart = `${key}=${escapedValue}`
+  let newPart = ''
 
   const parsed = dotenv.parse(src)
+  const _quotes = quotes(src)
   if (Object.prototype.hasOwnProperty.call(parsed, key)) {
+    const quote = _quotes[key]
+    newPart += `${key}=${quote}${replaceValue}${quote}`
+
     const originalValue = parsed[key]
     const escapedOriginalValue = escapeForRegex(originalValue)
 
@@ -52,6 +43,8 @@ function replace (src, key, replaceValue) {
     // $2 preserves export
     output = src.replace(currentPart, `$1$2${saferInput}`)
   } else {
+    newPart += `${key}="${replaceValue}"`
+
     // append
     if (src.endsWith('\n')) {
       newPart = newPart + '\n'

package/src/lib/services/precommit.js

@@ -4,7 +4,6 @@ const ignore = require('ignore')
 
 const Ls = require('../services/ls')
 
-const pluralize = require('./../helpers/pluralize')
 const isFullyEncrypted = require('./../helpers/isFullyEncrypted')
 const InstallPrecommitHook = require('./../helpers/installPrecommitHook')
 const childProcess = require('child_process')
@@ -27,8 +26,8 @@ class Precommit {
         warnings: []
       }
     } else {
+      let count = 0
       const warnings = []
-      let successMessage = 'success'
       let gitignore = MISSING_GITIGNORE
 
       // 1. check for .gitignore file
@@ -45,13 +44,15 @@ class Precommit {
       const lsService = new Ls(process.cwd(), undefined, this.excludeEnvFile)
       const dotenvFiles = lsService.run()
       dotenvFiles.forEach(file => {
+        count += 1
+
         // check if file is going to be commited
         if (this._isFileToBeCommitted(file)) {
           // check if that file is being ignored
           if (ig.ignores(file)) {
             if (file === '.env.example' || file === '.env.vault') {
               const warning = new Error(`${file} (currently ignored but should not be)`)
-              warning.help = `? add !${file} to .gitignore with [echo "!${file}" >> .gitignore]`
+              warning.help = `? add !${file} to .gitignore [echo "!${file}" >> .gitignore]`
               warnings.push(warning)
             }
           } else {
@@ -61,8 +62,8 @@ class Precommit {
 
               // if contents are encrypted don't raise an error
               if (!encrypted) {
-                const error = new Error(`${file} not encrypted (or not gitignored)`)
-                error.help = `? encrypt it with [dotenvx encrypt -f ${file}] or add ${file} to .gitignore with [echo ".env*" >> .gitignore]`
+                const error = new Error(`${file} not protected (encrypted or gitignored)`)
+                error.help = `? encrypt it [dotenvx encrypt -f ${file}] or gitignore it [echo "${file}" >> .gitignore]`
                 throw error
               }
             }
@@ -70,8 +71,12 @@ class Precommit {
         }
       })
 
+      let successMessage = `.env files (${count}) protected (encrypted or gitignored)`
+      if (count === 0) {
+        successMessage = 'zero .env files'
+      }
       if (warnings.length > 0) {
-        successMessage = `success (with ${pluralize('warning', warnings.length)})`
+        successMessage += ` with warnings (${warnings.length})`
       }
 
       return {