@dotenvx/dotenvx 1.2.0 → 1.3.0

package/CHANGELOG.md

@@ -2,7 +2,13 @@
 
 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.2.0...main)
+## [Unreleased](https://github.com/dotenvx/dotenvx/compare/v1.3.0...main)
+
+## 1.3.0
+
+### Added
+
+* encrypt specified keys with `--key` option - `dotenvx encrypt -k HELLO` ([#281](https://github.com/dotenvx/dotenvx/pull/281))
 
 ## 1.2.0
 

package/README.md

@@ -1114,6 +1114,18 @@ More examples
   ℹ run [DOTENV_PRIVATE_KEY_PRODUCTION='bff..bc4' dotenvx run -- yourcommand] to test decryption locally
   ```
 
+  </details>
+* <details><summary>`encrypt -k`</summary><br>
+
+  Specify the key(s) to encrypt by passing `--key`.
+
+  ```sh
+  $ echo "HELLO=World\nHELLO2=Universe" > .env
+
+  $ dotenvx encrypt -k HELLO2
+  ✔ encrypted (.env)
+  ```
+
   </details>
 * <details><summary>`help`</summary><br>
 

package/package.json

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

package/src/cli/actions/encrypt.js

@@ -16,7 +16,7 @@ async function encrypt () {
       processedEnvFiles,
       changedFilepaths,
       unchangedFilepaths
-    } = main.encrypt(options.envFile)
+    } = main.encrypt(options.envFile, options.key)
 
     for (const processedEnvFile of processedEnvFiles) {
       logger.verbose(`encrypting ${processedEnvFile.envFilepath} (${processedEnvFile.filepath})`)

package/src/cli/dotenvx.js

@@ -94,6 +94,7 @@ const encryptAction = require('./actions/encrypt')
 program.command('encrypt')
   .description('convert .env file(s) to encrypted .env file(s)')
   .option('-f, --env-file <paths...>', 'path(s) to your env file(s)')
+  .option('-k, --key <keys...>', 'keys(s) to encrypt (default: all keys in file)')
   .action(encryptAction)
 
 // dotenvx pro

package/src/lib/main.d.ts

@@ -144,8 +144,9 @@ export type EncryptOutput = {
  *
  * @see https://dotenvx.com/docs
  * @param envFile - path to the .env file
+ * @param key - keys(s) to encrypt (default: all keys in .env file)
  */
-export function encrypt(envFile: string): EncryptOutput;
+export function encrypt(envFile: string, key: string): EncryptOutput;
 
 export type VaultEncryptOutput = {
   dotenvKeys: Record<string, string>;
@@ -157,6 +158,7 @@ export type VaultEncryptOutput = {
   existingVaults: string[];
   addedDotenvFilenames: string[];
   envFile: string | string[];
+  key: string | string[];
 };
 
 /**

package/src/lib/main.js

@@ -194,8 +194,8 @@ const set = function (key, value, envFile, encrypt) {
 }
 
 /** @type {import('./main').encrypt} */
-const encrypt = function (envFile) {
-  return new Encrypt(envFile).run()
+const encrypt = function (envFile, key) {
+  return new Encrypt(envFile, key).run()
 }
 
 /** @type {import('./main').status} */

package/src/lib/services/encrypt.js

@@ -11,8 +11,9 @@ const replace = require('./../helpers/replace')
 const ENCODING = 'utf8'
 
 class Encrypt {
-  constructor (envFile = '.env') {
+  constructor (envFile = '.env', key = []) {
     this.envFile = envFile
+    this.key = key
     this.processedEnvFiles = []
     this.changedFilepaths = new Set()
     this.unchangedFilepaths = new Set()
@@ -20,6 +21,7 @@ class Encrypt {
 
   run () {
     const envFilepaths = this._envFilepaths()
+    const keys = this._keys()
     for (const envFilepath of envFilepaths) {
       const filepath = path.resolve(envFilepath)
 
@@ -52,15 +54,17 @@ class Encrypt {
         // iterate over all non-encrypted values and encrypt them
         const parsed = dotenv.parse(src)
         for (const [key, value] of Object.entries(parsed)) {
-          const encrypted = isEncrypted(key, value)
-          if (!encrypted) {
-            row.keys.push(key) // track key(s)
+          if (keys.length < 1 || keys.includes(key)) { // optionally control which key to encrypt
+            const encrypted = isEncrypted(key, value)
+            if (!encrypted) {
+              row.keys.push(key) // track key(s)
 
-            const encryptedValue = encryptValue(value, publicKey)
-            // once newSrc is built write it out
-            src = replace(src, key, encryptedValue)
+              const encryptedValue = encryptValue(value, publicKey)
+              // once newSrc is built write it out
+              src = replace(src, key, encryptedValue)
 
-            row.changed = true // track change
+              row.changed = true // track change
+            }
           }
         }
 
@@ -99,6 +103,14 @@ class Encrypt {
 
     return this.envFile
   }
+
+  _keys () {
+    if (!Array.isArray(this.key)) {
+      return [this.key]
+    }
+
+    return this.key
+  }
 }
 
 module.exports = Encrypt