@dotenvx/dotenvx 0.40.0 → 0.42.0

package/README.md

@@ -994,6 +994,37 @@ More examples
   set HELLO (.env.ci)
   ```
 
+  </details>
+* <details><summary>`convert`</summary><br>
+
+  Convert a `.env` file to an encrypted `.env` file.
+
+  ```sh
+  $ echo "HELLO=World" > .env
+
+  $ dotenvx convert
+  ✔ 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
+  ```
+
+  </details>
+* <details><summary>`convert -f`</summary><br>
+
+  Convert a specified `.env` file to an encrypted `.env` file.
+
+  ```sh
+  $ echo "HELLO=World" > .env
+  $ echo "HELLO=Production" > .env.production
+
+  $ dotenvx convert -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
+  ```
+
   </details>
 * <details><summary>`ls`</summary><br>
 

package/package.json

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

package/src/cli/actions/{encryptme.js → convert.js}

@@ -7,7 +7,7 @@ const isIgnoringDotenvKeys = require('../../lib/helpers/isIgnoringDotenvKeys')
 
 const ENCODING = 'utf8'
 
-async function encryptme () {
+async function convert () {
   const options = this.opts()
   logger.debug(`options: ${JSON.stringify(options)}`)
 
@@ -16,14 +16,14 @@ async function encryptme () {
       processedEnvFiles,
       changedFilepaths,
       unchangedFilepaths
-    } = main.encryptme(options.envFile)
+    } = main.convert(options.envFile)
 
     for (const processedEnvFile of processedEnvFiles) {
       logger.verbose(`encrypting ${processedEnvFile.envFilepath} (${processedEnvFile.filepath})`)
       if (processedEnvFile.error) {
         if (processedEnvFile.error.code === 'MISSING_ENV_FILE') {
           logger.warn(processedEnvFile.error)
-          logger.help(`? add one with [echo "HELLO=World" > ${processedEnvFile.envFilepath}] and re-run [dotenvx encryptme]`)
+          logger.help(`? add one with [echo "HELLO=World" > ${processedEnvFile.envFilepath}] and re-run [dotenvx convert]`)
         } else {
           logger.warn(processedEnvFile.error)
         }
@@ -70,4 +70,4 @@ async function encryptme () {
   }
 }
 
-module.exports = encryptme
+module.exports = convert

package/src/cli/actions/run.js

@@ -113,6 +113,12 @@ async function run () {
       envs = this.envs
     }
 
+    if (process.env.DOTENV_KEY) {
+      logger.warn('DEPRECATION NOTICE: Setting DOTENV_KEY with .env.vault is deprecated.')
+      logger.warn('DEPRECATION NOTICE: Run [dotenvx vault convert] for instructions on converting your .env.vault file to encrypted .env files (using public key encryption algorithm secp256k1)')
+      logger.warn('DEPRECATION NOTICE: Read more at [https://github.com/dotenvx/dotenvx/blob/main/CHANGELOG.md#0380]')
+    }
+
     const {
       processedEnvs,
       readableStrings,

package/src/cli/actions/vault/convert.js

@@ -0,0 +1,47 @@
+const logger = require('./../../../shared/logger')
+
+function convert (directory) {
+  // debug args
+  logger.debug(`directory: ${directory}`)
+
+  const options = this.opts()
+  logger.debug(`options: ${JSON.stringify(options)}`)
+
+  try {
+    logger.help2('To convert your .env.vault file to encrypted .env file(s):')
+    logger.help('')
+    logger.help('  1. Run [dotenvx vault decrypt]')
+    logger.help('  2. Run [ls -a .env*]')
+    logger.help('')
+    logger.help2('Lastly, convert each .env(.environment) file:')
+    logger.help('')
+    logger.help('  3. Run [dotenvx convert -f .env.production]')
+    logger.help2('')
+    logger.help2('For example:')
+    logger.help2('')
+    logger.help2('  $ dotenvx convert -f .env')
+    logger.help2('  $ dotenvx convert -f .env.ci')
+    logger.help2('  $ dotenvx convert -f .env.production')
+    logger.help2('')
+    logger.help2('Afterward:')
+    logger.help2('')
+    logger.help2('Update production with your new DOTENV_PRIVATE_KEY_PRODUCTION located in .env.keys')
+    logger.help2('')
+    logger.success('Learn more at [https://dotenvx.com/docs/quickstart#add-encryption]')
+    logger.help2('')
+  } catch (error) {
+    logger.error(error.message)
+    if (error.help) {
+      logger.help(error.help)
+    }
+    if (error.debug) {
+      logger.debug(error.debug)
+    }
+    if (error.code) {
+      logger.debug(`ERROR_CODE: ${error.code}`)
+    }
+    process.exit(1)
+  }
+}
+
+module.exports = convert

package/src/cli/commands/vault.js

@@ -7,6 +7,11 @@ const vault = new Command('vault')
 vault
   .description('manage .env.vault files')
 
+// dotenvx vault convert
+vault.command('convert')
+  .description('instructions for converting .env.vault to encrypted env file(s)')
+  .action(require('./../actions/vault/convert'))
+
 // dotenvx vault encrypt
 vault.command('encrypt')
   .description('encrypt .env.* to .env.vault')

package/src/cli/dotenvx.js

@@ -103,11 +103,11 @@ program.command('set')
   .option('-c, --encrypt', 'encrypt value')
   .action(require('./actions/set'))
 
-// dotenvx encryptme
-program.command('encryptme')
-  .description('encrypt env file(s) environment variables')
+// dotenvx convert
+program.command('convert')
+  .description('convert env file(s) to encrypted env file(s)')
   .option('-f, --env-file <paths...>', 'path(s) to your env file(s)')
-  .action(require('./actions/encryptme'))
+  .action(require('./actions/convert'))
 
 // dotenvx ls
 program.command('ls')

package/src/lib/helpers/replace.js

@@ -7,7 +7,7 @@ function replace (src, key, value) {
   const parsed = dotenv.parse(src)
   if (Object.prototype.hasOwnProperty.call(parsed, key)) {
     // replace
-    const regex = new RegExp(`^${key}=.*$`, 'm') // Regular expression to find the key and replace its value
+    const regex = new RegExp(`^${key}=(?:(["'\`])[^\\1]*\\1|[^\\n]*)(\\n[^A-Z0-9_].*)*`, 'm')
     output = src.replace(regex, formatted)
   } else {
     // append

package/src/lib/main.js

@@ -42,7 +42,7 @@ const parse = function (src) {
   return dotenv.parse(src)
 }
 
-// DEPRECATED: will became the same function as encryptme
+// DEPRECATED: will became the same function as convert
 const encrypt = function (directory, envFile) {
   return new VaultEncrypt(directory, envFile).run()
 }
@@ -67,7 +67,7 @@ const set = function (key, value, envFile, encrypt) {
   return new Sets(key, value, envFile, encrypt).run()
 }
 
-const encryptme = function (envFile) {
+const convert = function (envFile) {
   return new Encrypt(envFile).run()
 }
 
@@ -109,7 +109,7 @@ module.exports = {
   ls,
   get,
   set,
-  encryptme,
+  convert,
   status,
   genexample,
   // settings