@dotenvx/dotenvx 1.21.0 → 1.22.0

package/CHANGELOG.md

@@ -2,7 +2,25 @@
 
 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.21.0...main)
+## [Unreleased](https://github.com/dotenvx/dotenvx/compare/v1.22.0...main)
+
+## 1.22.0
+
+### Added
+
+* add `--pattern` argument to `ext gitignore` (`dotenvx ext gitignore --pattern .env.keys`) ([#430](https://github.com/dotenvx/dotenvx/pull/430))
+
+### Changed
+
+* clarify next steps after first time encrypting ([#430](https://github.com/dotenvx/dotenvx/pull/430))
+
+## 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
 

package/README.md

@@ -1222,8 +1222,8 @@ More examples
   $ dotenvx encrypt
   ✔ encrypted (.env)
   ✔ key added to .env.keys (DOTENV_PRIVATE_KEY)
-  ℹ add .env.keys to .gitignore: [echo ".env.keys" >> .gitignore]
-  ℹ run [DOTENV_PRIVATE_KEY='122...0b8' dotenvx run -- yourcommand] to test decryption locally
+  ⮕  next run [dotenvx ext gitignore --pattern .env.keys] to gitignore .env.keys
+  ⮕  next run [DOTENV_PRIVATE_KEY='122...0b8' dotenvx run -- yourcommand] to test decryption locally
   ```
 
   </details>
@@ -1238,8 +1238,8 @@ More examples
   $ dotenvx encrypt -f .env.production
   ✔ encrypted (.env.production)
   ✔ key added to .env.keys (DOTENV_PRIVATE_KEY_PRODUCTION)
-  ℹ add .env.keys to .gitignore: [echo ".env.keys" >> .gitignore]
-  ℹ run [DOTENV_PRIVATE_KEY_PRODUCTION='bff..bc4' dotenvx run -- yourcommand] to test decryption locally
+  ⮕  next run [dotenvx ext gitignore --pattern .env.keys] to gitignore .env.keys
+  ⮕  next run [DOTENV_PRIVATE_KEY='bff...bc4' dotenvx run -- yourcommand] to test decryption locally
   ```
 
   </details>
@@ -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.21.0",
+  "version": "1.22.0",
   "name": "@dotenvx/dotenvx",
   "description": "a better dotenv–from the creator of `dotenv`",
   "author": "@motdotla",

package/src/cli/actions/encrypt.js

@@ -64,10 +64,10 @@ function encrypt () {
           logger.success(`✔ key added to .env.keys (${processedEnv.privateKeyName})`)
 
           if (!isIgnoringDotenvKeys()) {
-            logger.help2('ℹ add .env.keys to .gitignore: [echo ".env.keys" >> .gitignore]')
+            logger.help('⮕  next run [dotenvx ext gitignore --pattern .env.keys] to gitignore .env.keys')
           }
 
-          logger.help2(`ℹ run [${processedEnv.privateKeyName}='${processedEnv.privateKey}' dotenvx run -- yourcommand] to test decryption locally`)
+          logger.help(`⮕  next run [${processedEnv.privateKeyName}='${processedEnv.privateKey}' dotenvx run -- yourcommand] to test decryption locally`)
         }
       }
     } catch (error) {

package/src/cli/actions/ext/gitignore.js

@@ -1,12 +1,12 @@
 const fsx = require('./../../../lib/helpers/fsx')
 
-const FORMATS = ['.env*', '!.env.vault']
+const DEFAULT_PATTERNS = ['.env*']
 const { logger } = require('./../../../shared/logger')
 
 class Generic {
-  constructor (filename, touchFile = false) {
+  constructor (filename, patterns = DEFAULT_PATTERNS, touchFile = false) {
     this.filename = filename
-    this.formats = FORMATS
+    this.patterns = patterns
     this.touchFile = touchFile
   }
 
@@ -15,10 +15,9 @@ class Generic {
   }
 
   run () {
+    const changedPatterns = []
     if (!fsx.existsSync(this.filename)) {
-      if (this.touchFile === true) {
-        logger.info(`creating ${this.filename}`)
-
+      if (this.touchFile === true && this.patterns.length > 0) {
         fsx.writeFileX(this.filename, '')
       } else {
         return
@@ -26,41 +25,63 @@ class Generic {
     }
 
     const lines = fsx.readFileX(this.filename).split(/\r?\n/)
-    this.formats.forEach(format => {
-      if (!lines.includes(format.trim())) {
-        logger.info(`appending ${format} to ${this.filename}`)
+    this.patterns.forEach(pattern => {
+      if (!lines.includes(pattern.trim())) {
+        this.append(pattern)
 
-        this.append(format)
+        changedPatterns.push(pattern.trim())
       }
     })
+
+    if (changedPatterns.length > 0) {
+      logger.success(`✔ ignored ${this.patterns} (${this.filename})`)
+    } else {
+      logger.info(`no changes (${this.filename})`)
+    }
   }
 }
 
 class Git {
+  constructor (patterns = DEFAULT_PATTERNS) {
+    this.patterns = patterns
+  }
+
   run () {
-    logger.verbose('appending to .gitignore')
-    new Generic('.gitignore', true).run()
+    logger.verbose('add to .gitignore')
+    new Generic('.gitignore', this.patterns, true).run()
   }
 }
 
 class Docker {
+  constructor (patterns = DEFAULT_PATTERNS) {
+    this.patterns = patterns
+  }
+
   run () {
-    logger.verbose('appending to .dockerignore (if existing)')
-    new Generic('.dockerignore').run()
+    logger.verbose('add to .dockerignore (if exists)')
+    new Generic('.dockerignore', this.patterns).run()
   }
 }
 
 class Npm {
+  constructor (patterns = DEFAULT_PATTERNS) {
+    this.patterns = patterns
+  }
+
   run () {
-    logger.verbose('appending to .npmignore (if existing)')
-    new Generic('.npmignore').run()
+    logger.verbose('add to .npmignore (if existing)')
+    new Generic('.npmignore', this.patterns).run()
   }
 }
 
 class Vercel {
+  constructor (patterns = DEFAULT_PATTERNS) {
+    this.patterns = patterns
+  }
+
   run () {
-    logger.verbose('appending to .vercelignore (if existing)')
-    new Generic('.vercelignore').run()
+    logger.verbose('add to .vercelignore (if existing)')
+    new Generic('.vercelignore', this.patterns).run()
   }
 }
 
@@ -68,12 +89,12 @@ function gitignore () {
   const options = this.opts()
   logger.debug(`options: ${JSON.stringify(options)}`)
 
-  new Git().run()
-  new Docker().run()
-  new Npm().run()
-  new Vercel().run()
+  const patterns = options.pattern
 
-  logger.success('done')
+  new Git(patterns).run()
+  new Docker(patterns).run()
+  new Npm(patterns).run()
+  new Vercel(patterns).run()
 }
 
 module.exports = gitignore

package/src/cli/actions/set.js

@@ -68,10 +68,10 @@ function set (key, value) {
         logger.success(`✔ key added to .env.keys (${processedEnv.privateKeyName})`)
 
         if (!isIgnoringDotenvKeys()) {
-          logger.help2('ℹ add .env.keys to .gitignore: [echo ".env.keys" >> .gitignore]')
+          logger.help('⮕  next run [dotenvx ext gitignore --pattern .env.keys] to gitignore .env.keys')
         }
 
-        logger.help2(`ℹ run [${processedEnv.privateKeyName}='${processedEnv.privateKey}' dotenvx get ${key}] to test decryption locally`)
+        logger.help(`⮕  next run [${processedEnv.privateKeyName}='${processedEnv.privateKey}' dotenvx get ${key}] to test decryption locally`)
       }
     }
   } catch (error) {

package/src/cli/commands/ext.js

@@ -40,6 +40,7 @@ ext.command('genexample')
 ext.command('gitignore')
   .description('append to .gitignore file (and if existing, .dockerignore, .npmignore, and .vercelignore)')
   .addHelpText('after', examples.gitignore)
+  .option('--pattern <patterns...>', 'pattern(s) to gitignore', ['.env*'])
   .action(require('./../actions/ext/gitignore'))
 
 // dotenvx ext prebuild

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/cli/examples.js

@@ -63,13 +63,14 @@ Examples:
 
   \`\`\`
   $ dotenvx ext gitignore
+  $ dotenvx ext gitignore --pattern .env.keys
   \`\`\`
 
 Try it:
 
   \`\`\`
   $ dotenvx ext gitignore
-  done
+  ✔ ignored .env* (.gitignore)
   \`\`\`
   `
 }

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/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/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 {