@dotenvx/dotenvx 1.27.0 → 1.29.0

package/CHANGELOG.md

@@ -2,13 +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.27.0...main)
+[Unreleased](https://github.com/dotenvx/dotenvx/compare/v1.29.0...main)
+
+## [1.29.0](https://github.com/dotenvx/dotenvx/compare/v1.28.0...v1.29.0)
+
+### Added
+
+* add `--ignore` flag to suppress specified errors. example: `dotenvx run --ignore=MISSING_ENV_FILE` ([#485](https://github.com/dotenvx/dotenvx/pull/485))
+
+## [1.28.0](https://github.com/dotenvx/dotenvx/compare/v1.27.0...v1.28.0)
+
+### Changed
+
+* `.env.keys` file is generated WITHOUT quotes going forward. This is to minimize friction around Docker gotchas to developers - old versions of Docker do not support `--env-file` containing quoted keys/values. ([#480](https://github.com/dotenvx/dotenvx/pull/480)) ([additional note](https://github.com/dotenvx/dotenvx/issues/465#issuecomment-2515279676))
 
 ## [1.27.0](https://github.com/dotenvx/dotenvx/compare/v1.26.2...v1.27.0)
 
 ### Added
 
-* add support for `\t` expansion when double quoted. (e.g. `TAB="hi\tfriend"` becomes `hi	friend`) ([#479](https://github.com/dotenvx/dotenvx/pull/479))
+* add support for `\t` expansion when double quoted. (e.g. `TAB="hi\tfriend"` becomes `hi   friend`) ([#479](https://github.com/dotenvx/dotenvx/pull/479))
 
 ## [1.26.2](https://github.com/dotenvx/dotenvx/compare/v1.26.1...v1.26.2)
 

package/README.md

@@ -983,6 +983,18 @@ More examples
 
   This can be useful in `ci` scripts where you want to fail the ci if your `.env` file could not be decrypted at runtime.
 
+  </details>
+* <details><summary>`run --ignore`</summary><br>
+
+  Ignore errors like `MISSING_ENV_FILE`.
+
+  ```sh
+  $ echo "console.log('Hello ' + process.env.HELLO)" > index.js
+
+  $ dotenvx run -f .env.missing --ignore=MISSING_ENV_FILE -- node index.js
+  ...
+  ```
+
   </details>
 * <details><summary>`run --convention=nextjs`</summary><br>
 
@@ -1695,9 +1707,17 @@ More examples
 
   ```sh
   $ dotenvx ext gitignore
-  creating .gitignore
-  appending .env* to .gitignore
-  done
+  ✔ ignored .env* (.gitignore)
+  ```
+
+  </details>
+* <details><summary>`ext gitignore --pattern`</summary><br>
+
+  Gitignore specific pattern(s) of `.env` files.
+
+  ```sh
+  $ dotenvx ext gitignore --pattern .env.keys
+  ✔ ignored .env.keys (.gitignore)
   ```
 
   </details>
@@ -1707,7 +1727,7 @@ More examples
 
   ```sh
   $ dotenvx ext precommit
-  [dotenvx][precommit] success
+  [dotenvx][precommit] .env files (1) protected (encrypted or gitignored)
   ```
 
   </details>
@@ -1717,7 +1737,7 @@ More examples
 
   ```sh
   $ dotenvx ext precommit --install
-  [dotenvx][precommit] dotenvx precommit installed [.git/hooks/pre-commit]
+  [dotenvx][precommit] dotenvx ext precommit installed [.git/hooks/pre-commit]
   ```
 
   </details>
@@ -1728,6 +1748,7 @@ More examples
   Add it to your `Dockerfile`.
 
   ```sh
+  # Dockerfile
   RUN curl -fsS https://dotenvx.sh | sh
 
   ...
@@ -1780,6 +1801,8 @@ More examples
   Hello World
   ```
 
+  It defaults to looking for a `.env` file.
+
   </details>
 * <details><summary>`config(path: ['.env.local', '.env'])` - multiple files</summary><br>
 
@@ -1811,7 +1834,7 @@ More examples
   </details>
 * <details><summary>`config(overload: true)` - overload</summary><br>
 
-  User `overload` to overwrite the prior set value.
+  Use `overload` to overwrite the prior set value.
 
   ```ini
   # .env.local
@@ -1858,6 +1881,29 @@ More examples
   Error: [MISSING_ENV_FILE] missing .env.missing file (/path/to/.env.missing)
   ```
 
+  </details>
+* <details><summary>`config(ignore:)` - ignore</summary><br>
+
+  Use `ignore` to suppress specific errors like `MISSING_ENV_FILE`.
+
+  ```ini
+  # .env
+  HELLO="World"
+  ```
+
+  ```js
+  // index.js
+  require('@dotenvx/dotenvx').config({path: ['.env.missing', '.env'], ignore: ['MISSING_ENV_FILE']})
+
+  console.log(`Hello ${process.env.HELLO}`)
+  ```
+
+  ```sh
+  $ node index.js
+  [dotenvx@1.24.5] injecting env (1) from .env.local, .env
+  Hello World
+  ```
+
   </details>
 * <details><summary>`parse(src)`</summary><br>
 

package/package.json

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

package/src/cli/actions/get.js

@@ -13,6 +13,8 @@ function get (key) {
   const options = this.opts()
   logger.debug(`options: ${JSON.stringify(options)}`)
 
+  const ignore = options.ignore || []
+
   let envs = []
   // handle shorthand conventions - like --convention=nextjs
   if (options.convention) {
@@ -27,6 +29,10 @@ function get (key) {
     for (const error of errors || []) {
       if (options.strict) throw error // throw immediately if strict
 
+      if (ignore.includes(error.code)) {
+        continue // ignore error
+      }
+
       console.error(error.message)
       if (error.help) {
         console.error(error.help)

package/src/cli/actions/run.js

@@ -14,6 +14,8 @@ async function run () {
   const options = this.opts()
   logger.debug(`options: ${JSON.stringify(options)}`)
 
+  const ignore = options.ignore || []
+
   if (commandArgs.length < 1) {
     const hasSeparator = process.argv.indexOf('--') !== -1
 
@@ -62,6 +64,11 @@ async function run () {
       for (const error of processedEnv.errors || []) {
         if (options.strict) throw error // throw immediately if strict
 
+        if (ignore.includes(error.code)) {
+          logger.verbose(`ignored: ${error.message}`)
+          continue // ignore error
+        }
+
         if (error.code === 'MISSING_ENV_FILE') {
           if (!options.convention) { // do not output error for conventions (too noisy)
             console.error(error.message)

package/src/cli/dotenvx.js

@@ -60,6 +60,7 @@ program.command('run')
   .option('-o, --overload', 'override existing env variables')
   .option('--strict', 'process.exit(1) on any errors (default: false)', false)
   .option('--convention <name>', 'load a .env convention (available conventions: [\'nextjs\'])')
+  .option('--ignore <errorCodes...>', 'error code(s) to ignore (example: --ignore=MISSING_ENV_FILE)')
   .action(function (...args) {
     this.envs = envs
     runAction.apply(this, args)
@@ -77,6 +78,7 @@ program.command('get')
   .option('-o, --overload', 'override existing env variables')
   .option('--strict', 'process.exit(1) on any errors (default: false)', false)
   .option('--convention <name>', 'load a .env convention (available conventions: [\'nextjs\'])')
+  .option('--ignore <errorCodes...>', 'error code(s) to ignore (example: --ignore=MISSING_ENV_FILE)')
   .option('-a, --all', 'include all machine envs as well')
   .option('-pp, --pretty-print', 'pretty print output')
   .option('--format <type>', 'format of the output (json, shell, eval)', 'json')

package/src/lib/helpers/errors.js

@@ -15,7 +15,7 @@ class Errors {
   missingEnvFile () {
     const code = 'MISSING_ENV_FILE'
     const message = `[${code}] missing ${this.envFilepath} file (${this.filepath})`
-    const help = `[${code}] ? add one with [echo "HELLO=World" > ${this.envFilepath}]`
+    const help = `[${code}] https://github.com/dotenvx/dotenvx/issues/484`
 
     const e = new Error(message)
     e.code = code

package/src/lib/main.js

@@ -28,6 +28,9 @@ const config = function (options = {}) {
   // overload
   const overload = options.overload || options.override
 
+  // ignore
+  const ignore = options.ignore || []
+
   // strict
   const strict = options.strict
 
@@ -86,19 +89,23 @@ const config = function (options = {}) {
       for (const error of processedEnv.errors || []) {
         if (strict) throw error // throw immediately if strict
 
+        if (ignore.includes(error.code)) {
+          continue // ignore error
+        }
+
         lastError = error // surface later in { error }
 
         if (error.code === 'MISSING_ENV_FILE') {
           if (!options.convention) { // do not output error for conventions (too noisy)
             console.error(error.message)
             if (error.help) {
-              logger.help(error.help)
+              console.error(error.help)
             }
           }
         } else {
           console.error(error.message)
           if (error.help) {
-            logger.help(error.help)
+            console.error(error.help)
           }
         }
       }

package/src/lib/services/encrypt.js

@@ -132,7 +132,7 @@ class Encrypt {
         ].join('\n')
         const appendPrivateKey = [
           `# ${filename}`,
-          `${privateKeyName}="${privateKey}"`,
+          `${privateKeyName}=${privateKey}`,
           ''
         ].join('\n')
 

package/src/lib/services/sets.js

@@ -137,7 +137,7 @@ class Sets {
           ].join('\n')
           const appendPrivateKey = [
             `# ${filename}`,
-            `${privateKeyName}="${privateKey}"`,
+            `${privateKeyName}=${privateKey}`,
             ''
           ].join('\n')