@dotenvx/dotenvx 1.18.0 → 1.19.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.18.0...main)
+## [Unreleased](https://github.com/dotenvx/dotenvx/compare/v1.19.0...main)
+
+## 1.19.0
+
+### Added
+
+* support key glob filtering for `encrypt` and `decrypt`. example: `dotenvx encrypt -ek "NEXT_PUBLIC_*"` ([#397](https://github.com/dotenvx/dotenvx/pull/397))
+
+## 1.18.1
+
+### Added
+
+* escape user inputted regex groupings like `$1` or `$2`. ([#396](https://github.com/dotenvx/dotenvx/pull/396))
 
 ## 1.18.0
 
 ### Added
 
-* `set` and `encrypt` preserve leading spaces ([#395](https://github.com/dotenvx/dotenvx/pull/395/))
+* `set` and `encrypt` preserve leading spaces ([#395](https://github.com/dotenvx/dotenvx/pull/395))
 
 ```sh
      HELLO=world

package/README.md

@@ -1243,6 +1243,36 @@ More examples
   ✔ encrypted (.env)
   ```
 
+  Even specify a glob pattern.
+
+  ```sh
+  $ echo "HELLO=World\nHOLA=Mundo" > .env
+
+  $ dotenvx encrypt -k "HE*"
+  ✔ encrypted (.env)
+  ```
+
+  </details>
+* <details><summary>`encrypt -ek`</summary><br>
+
+  Specify the key(s) to NOT encrypt by passing `--exclude-key`.
+
+  ```sh
+  $ echo "HELLO=World\nHELLO2=Universe" > .env
+
+  $ dotenvx encrypt -ek HELLO
+  ✔ encrypted (.env)
+  ```
+
+  Even specify a glob pattern.
+
+  ```sh
+  $ echo "HELLO=World\nHOLA=Mundo" > .env
+
+  $ dotenvx encrypt -ek "HO*"
+  ✔ encrypted (.env)
+  ```
+
   </details>
 * <details><summary>`encrypt --stdout`</summary><br>
 
@@ -1295,6 +1325,52 @@ More examples
   ✔ decrypted (.env.production)
   ```
 
+  </details>
+* <details><summary>`decrypt -k`</summary><br>
+
+  Decrypt the contents of a specified key inside an encrypted `.env` file.
+
+  ```sh
+  $ echo "HELLO=World\nHOLA=Mundo" > .env
+  $ dotenvx encrypt
+  ✔ encrypted (.env)
+  $ dotenvx decrypt -k HELLO
+  ✔ decrypted (.env)
+  ```
+
+  Even specify a glob pattern.
+
+  ```sh
+  $ echo "HELLO=World\nHOLA=Mundo" > .env
+  $ dotenvx encrypt
+  ✔ encrypted (.env)
+  $ dotenvx decrypt -k "HE*"
+  ✔ encrypted (.env)
+  ```
+
+  </details>
+* <details><summary>`decrypt -ek`</summary><br>
+
+  Decrypt the contents inside an encrypted `.env` file except for an exluded key.
+
+  ```sh
+  $ echo "HELLO=World\nHOLA=Mundo" > .env
+  $ dotenvx encrypt
+  ✔ encrypted (.env)
+  $ dotenvx decrypt -ek HOLA
+  ✔ decrypted (.env)
+  ```
+
+  Even specify a glob pattern.
+
+  ```sh
+  $ echo "HELLO=World\nHOLA=Mundo" > .env
+  $ dotenvx encrypt
+  ✔ encrypted (.env)
+  $ dotenvx decrypt -ek "HO*"
+  ✔ encrypted (.env)
+  ```
+
   </details>
 * <details><summary>`decrypt --stdout`</summary><br>
 

package/package.json

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

package/src/lib/helpers/escapeDollarSigns.js

@@ -0,0 +1,5 @@
+function escapeDollarSigns (str) {
+  return str.replace(/\$/g, '$$$$')
+}
+
+module.exports = escapeDollarSigns

package/src/lib/helpers/replace.js

@@ -2,10 +2,12 @@ const util = require('util')
 const dotenv = require('dotenv')
 
 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
@@ -38,9 +40,11 @@ function replace (src, key, replaceValue) {
       'gm' // (g)lobal (m)ultiline
     )
 
+    const saferInput = escapeDollarSigns(newPart) // cleanse user inputted capture groups ($1, $2 etc)
+
     // $1 preserves spaces
     // $2 preserves export
-    output = src.replace(currentPart, `$1$2${newPart}`)
+    output = src.replace(currentPart, `$1$2${saferInput}`)
   } else {
     // append
     if (src.endsWith('\n')) {

package/src/lib/services/decrypt.js

@@ -1,6 +1,7 @@
 const fs = require('fs')
 const path = require('path')
 const dotenv = require('dotenv')
+const picomatch = require('picomatch')
 
 const smartDotenvPrivateKey = require('./../helpers/smartDotenvPrivateKey')
 const guessPrivateKeyName = require('./../helpers/guessPrivateKeyName')
@@ -29,6 +30,9 @@ class Decrypt {
     const envFilepaths = this._envFilepaths()
     const keys = this._keys()
     const excludeKeys = this._excludeKeys()
+    const exclude = picomatch(excludeKeys)
+    const include = picomatch(keys, { ignore: excludeKeys })
+
     for (const envFilepath of envFilepaths) {
       const filepath = path.resolve(envFilepath)
 
@@ -53,12 +57,12 @@ class Decrypt {
         const parsed = dotenv.parse(src)
         for (const [key, value] of Object.entries(parsed)) {
           // key excluded - don't decrypt it
-          if (excludeKeys.includes(key)) {
+          if (exclude(key)) {
             continue
           }
 
           // key effectively excluded (by not being in the list of includes) - don't encrypt it
-          if (keys.length > 0 && !keys.includes(key)) {
+          if (keys.length > 0 && !include(key)) {
             continue
           }
 

package/src/lib/services/encrypt.js

@@ -1,6 +1,7 @@
 const fs = require('fs')
 const path = require('path')
 const dotenv = require('dotenv')
+const picomatch = require('picomatch')
 
 const findOrCreatePublicKey = require('./../helpers/findOrCreatePublicKey')
 const guessPrivateKeyName = require('./../helpers/guessPrivateKeyName')
@@ -30,6 +31,9 @@ class Encrypt {
     const envFilepaths = this._envFilepaths()
     const keys = this._keys()
     const excludeKeys = this._excludeKeys()
+    const exclude = picomatch(excludeKeys)
+    const include = picomatch(keys, { ignore: excludeKeys })
+
     for (const envFilepath of envFilepaths) {
       const filepath = path.resolve(envFilepath)
 
@@ -67,12 +71,12 @@ class Encrypt {
         const parsed = dotenv.parse(src)
         for (const [key, value] of Object.entries(parsed)) {
           // key excluded - don't encrypt it
-          if (excludeKeys.includes(key)) {
+          if (exclude(key)) {
             continue
           }
 
           // key effectively excluded (by not being in the list of includes) - don't encrypt it
-          if (keys.length > 0 && !keys.includes(key)) {
+          if (keys.length > 0 && !include(key)) {
             continue
           }