@dotenvx/dotenvx 1.33.0 → 1.35.0

package/CHANGELOG.md

@@ -2,7 +2,22 @@
 
 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.33.0...main)
+[Unreleased](https://github.com/dotenvx/dotenvx/compare/v1.35.0...main)
+
+## [1.35.0](https://github.com/dotenvx/dotenvx/compare/v1.34.0...v1.35.0)
+
+### Added
+
+* `npx dotenvx precommit` support as a convenience ([#523](https://github.com/dotenvx/dotenvx/pull/523))
+* `main.get` method ([#524](https://github.com/dotenvx/dotenvx/pull/524))
+
+The addition of `main.get` facilitates what we term Decryption at Access, a concept explored in greater detail in our [whitepaper](https://dotenvx.com/dotenvx.pdf).
+
+## [1.34.0](https://github.com/dotenvx/dotenvx/compare/v1.33.0...v1.34.0)
+
+### Added
+
+* `main.set` method now writes to files ([#517](https://github.com/dotenvx/dotenvx/pull/517))
 
 ## [1.33.0](https://github.com/dotenvx/dotenvx/compare/v1.32.1...v1.33.0)
 

package/README.md

@@ -19,7 +19,7 @@ npm install @dotenvx/dotenvx --save
 ```js
 // index.js
 require('@dotenvx/dotenvx').config()
-// or import('@dotenvx/dotenvx/config') if you're using esm
+// or import '@dotenvx/dotenvx/config' // for esm
 
 console.log(`Hello ${process.env.HELLO}`)
 ```

package/package.json

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

package/src/lib/helpers/installPrecommitHook.js

@@ -3,15 +3,19 @@ const path = require('path')
 
 const HOOK_SCRIPT = `#!/bin/sh
 
-if ! command -v dotenvx 2>&1 >/dev/null
+if command -v dotenvx 2>&1 >/dev/null
 then
+  dotenvx ext precommit
+elif npx dotenvx -V >/dev/null 2>&1
+then
+  npx dotenvx ext precommit
+else
   echo "[dotenvx][precommit] 'dotenvx' command not found"
   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
-
-dotenvx ext precommit`
+`
 
 class InstallPrecommitHook {
   constructor () {

package/src/lib/main.d.ts

@@ -194,6 +194,13 @@ export interface SetOptions {
    * Set a .env convention (available conventions: 'nextjs')
    */
   convention?: string;
+
+  /**
+   * Specify whether the variable has to be encrypted
+   * @default true
+   * @example require('@dotenvx/dotenvx').config(key, value, { encrypt: false } })
+   */
+  encrypt?: boolean;
 }
 
 export type SetOutput = {

package/src/lib/main.js

@@ -9,12 +9,15 @@ const { getColor, bold } = require('./../shared/colors')
 const Ls = require('./services/ls')
 const Run = require('./services/run')
 const Sets = require('./services/sets')
+const Get = require('./services/get')
 const Keypair = require('./services/keypair')
 const Genexample = require('./services/genexample')
 
 // helpers
 const buildEnvs = require('./helpers/buildEnvs')
 const Parse = require('./helpers/parse')
+const fsx = require('./helpers/fsx')
+const isIgnoringDotenvKeys = require('./helpers/isIgnoringDotenvKeys')
 
 /** @type {import('./main').config} */
 const config = function (options = {}) {
@@ -55,7 +58,6 @@ const config = function (options = {}) {
     let lastError
     /** @type {Record<string, string>} */
     const parsedAll = {}
-
     for (const processedEnv of processedEnvs) {
       if (processedEnv.type === 'envVaultFile') {
         logger.verbose(`loading env from encrypted ${processedEnv.filepath} (${path.resolve(processedEnv.filepath)})`)
@@ -169,13 +171,119 @@ const set = function (key, value, options = {}) {
     encrypt = false
   }
 
-  // envKeysFile
-  const envKeysFile = options.envKeysFile
+  const envs = buildEnvs(options)
+  const envKeysFilepath = options.envKeysFile
+
+  const {
+    processedEnvs,
+    changedFilepaths,
+    unchangedFilepaths
+  } = new Sets(key, value, envs, encrypt, envKeysFilepath).run()
+
+  let withEncryption = ''
+
+  if (encrypt) {
+    withEncryption = ' with encryption'
+  }
+
+  for (const processedEnv of processedEnvs) {
+    logger.verbose(`setting for ${processedEnv.envFilepath}`)
+
+    if (processedEnv.error) {
+      if (processedEnv.error.code === 'MISSING_ENV_FILE') {
+        logger.warn(processedEnv.error.message)
+        logger.help(`? add one with [echo "HELLO=World" > ${processedEnv.envFilepath}] and re-run [dotenvx set]`)
+      } else {
+        logger.warn(processedEnv.error.message)
+        if (processedEnv.error.help) {
+          logger.help(processedEnv.error.help)
+        }
+      }
+    } else {
+      fsx.writeFileX(processedEnv.filepath, processedEnv.envSrc)
+
+      logger.verbose(`${processedEnv.key} set${withEncryption} (${processedEnv.envFilepath})`)
+      logger.debug(`${processedEnv.key} set${withEncryption} to ${processedEnv.value} (${processedEnv.envFilepath})`)
+    }
+  }
 
-  // envs
+  if (changedFilepaths.length > 0) {
+    logger.success(`✔ set ${key}${withEncryption} (${changedFilepaths.join(',')})`)
+  } else if (unchangedFilepaths.length > 0) {
+    logger.info(`no changes (${unchangedFilepaths})`)
+  } else {
+    // do nothing
+  }
+
+  for (const processedEnv of processedEnvs) {
+    if (processedEnv.privateKeyAdded) {
+      logger.success(`✔ key added to ${processedEnv.envKeysFilepath} (${processedEnv.privateKeyName})`)
+
+      if (!isIgnoringDotenvKeys()) {
+        logger.help('⮕  next run [dotenvx ext gitignore --pattern .env.keys] to gitignore .env.keys')
+      }
+
+      logger.help(`⮕  next run [${processedEnv.privateKeyName}='${processedEnv.privateKey}' dotenvx get ${key}] to test decryption locally`)
+    }
+  }
+
+  return {
+    processedEnvs,
+    changedFilepaths,
+    unchangedFilepaths
+  }
+}
+
+/* @type {import('./main').get} */
+const get = function (key, options = {}) {
   const envs = buildEnvs(options)
 
-  return new Sets(key, value, envs, encrypt, envKeysFile).run()
+  // ignore
+  const ignore = options.ignore || []
+
+  const { parsed, errors } = new Get(key, envs, options.overload, process.env.DOTENV_KEY, options.all, options.envKeysFile).run()
+
+  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)
+    }
+  }
+
+  if (key) {
+    const single = parsed[key]
+    if (single === undefined) {
+      return undefined
+    } else {
+      return single
+    }
+  } else {
+    if (options.format === 'eval') {
+      let inline = ''
+      for (const [key, value] of Object.entries(parsed)) {
+        inline += `${key}=${escape(value)}\n`
+      }
+      inline = inline.trim()
+
+      return inline
+    } else if (options.format === 'shell') {
+      let inline = ''
+      for (const [key, value] of Object.entries(parsed)) {
+        inline += `${key}=${value} `
+      }
+      inline = inline.trim()
+
+      return inline
+    } else {
+      return parsed
+    }
+  }
 }
 
 /** @type {import('./main').ls} */
@@ -204,6 +312,7 @@ module.exports = {
   parse,
   // actions related
   set,
+  get,
   ls,
   keypair,
   genexample,