@dotenvx/dotenvx 0.17.1 → 0.19.0

package/README.md

@@ -56,6 +56,18 @@ see [extended quickstart guide](https://dotenvx.com/docs/quickstart)
 
 More examples
 
+* <details><summary>TypeScript 📘</summary><br>
+
+  ```sh
+  $ echo "HELLO=World" > .env
+  $ echo "console.log('Hello ' + process.env.HELLO)" > index.ts
+
+  $ dotenvx run -- npx ts-node index.ts
+  Hello World
+  ```
+
+  </details>
+
 * <details><summary>Python 🐍</summary><br>
 
   ```sh

package/package.json

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

package/src/cli/actions/encrypt.js

@@ -7,20 +7,6 @@ const helpers = require('./../helpers')
 const createSpinner = require('./../../shared/createSpinner')
 const spinner = createSpinner('encrypting')
 
-const RESERVED_ENV_FILES = ['.env.vault', '.env.project', '.env.keys', '.env.me', '.env.x']
-
-const findEnvFiles = function (directory) {
-  const files = fs.readdirSync(directory)
-
-  const envFiles = files.filter(file =>
-    file.startsWith('.env') &&
-    !file.endsWith('.previous') &&
-    !RESERVED_ENV_FILES.includes(file)
-  )
-
-  return envFiles
-}
-
 async function encrypt (directory) {
   spinner.start()
   await helpers.sleep(500) // better dx
@@ -30,8 +16,6 @@ async function encrypt (directory) {
   const options = this.opts()
   logger.debug(`options: ${JSON.stringify(options)}`)
 
-  const optionEnvFile = options.envFile || findEnvFiles(directory)
-
   try {
     const {
       dotenvKeys,
@@ -41,10 +25,11 @@ async function encrypt (directory) {
       dotenvVaultFile,
       addedVaults,
       existingVaults,
-      addedDotenvFilenames
-    } = main.encrypt(directory, optionEnvFile)
+      addedDotenvFilenames,
+      envFile
+    } = main.encrypt(directory, options.envFile)
 
-    logger.verbose(`generating .env.keys from ${optionEnvFile}`)
+    logger.verbose(`generating .env.keys from ${envFile}`)
     if (addedKeys.length > 0) {
       logger.verbose(`generated ${addedKeys}`)
     }
@@ -53,7 +38,7 @@ async function encrypt (directory) {
     }
     fs.writeFileSync(path.resolve(directory, '.env.keys'), dotenvKeysFile)
 
-    logger.verbose(`generating .env.vault from ${optionEnvFile}`)
+    logger.verbose(`generating .env.vault from ${envFile}`)
     if (addedVaults.length > 0) {
       logger.verbose(`encrypting ${addedVaults}`)
     }
@@ -66,7 +51,7 @@ async function encrypt (directory) {
       spinner.succeed(`encrypted to .env.vault (${addedDotenvFilenames})`)
       logger.help2('ℹ commit .env.vault to code: [git commit -am ".env.vault"]')
     } else {
-      spinner.done(`no changes (${optionEnvFile})`)
+      spinner.done(`no changes (${envFile})`)
     }
 
     if (addedKeys.length > 0) {

package/src/cli/actions/get.js

@@ -0,0 +1,24 @@
+const logger = require('./../../shared/logger')
+
+const main = require('./../../lib/main')
+
+function get (key) {
+  logger.debug(`key: ${key}`)
+
+  const options = this.opts()
+  logger.debug(`options: ${JSON.stringify(options)}`)
+
+  const value = main.get(key, options.envFile, options.overload, options.all)
+
+  if (typeof value === 'object' && value !== null) {
+    if (options.prettyPrint) {
+      logger.blank(JSON.stringify(value, null, 2))
+    } else {
+      logger.blank(value)
+    }
+  } else {
+    logger.blank(value)
+  }
+}
+
+module.exports = get

package/src/cli/actions/scan.js

@@ -0,0 +1,27 @@
+const execa = require('execa')
+
+const logger = require('./../../shared/logger')
+
+async function scan () {
+  const options = this.opts()
+  logger.debug(`options: ${JSON.stringify(options)}`)
+
+  try {
+    await execa('gitleaks', ['version'])
+  } catch (error) {
+    logger.error('gitleaks command not found')
+    logger.help('? install gitleaks:      [brew install gitleaks]')
+    logger.help2('? other install options: [https://github.com/gitleaks/gitleaks]')
+    process.exit(1)
+  }
+
+  try {
+    const { stderr } = await execa('gitleaks', ['detect', '-v'])
+    logger.blank(stderr) // gitleaks sends output as stderr for strange reason
+  } catch (error) {
+    logger.error(error.message)
+    process.exit(1)
+  }
+}
+
+module.exports = scan

package/src/cli/dotenvx.js

@@ -97,6 +97,11 @@ program.command('genexample')
   .option('-f, --env-file <paths...>', 'path(s) to your env file(s)', '.env')
   .action(require('./actions/genexample'))
 
+// dotenvx scan
+program.command('scan')
+  .description('scan for leaked secrets')
+  .action(require('./actions/scan'))
+
 // dotenvx ls
 program.command('ls')
   .description('print all .env files in a tree structure')
@@ -104,6 +109,16 @@ program.command('ls')
   .option('-f, --env-file <filenames...>', 'path(s) to your env file(s)', '.env*')
   .action(require('./actions/ls'))
 
+// dotenvx get
+program.command('get')
+  .description('Return environment variable(s)')
+  .argument('[key]', 'environment variable name')
+  .option('-f, --env-file <paths...>', 'path(s) to your env file(s)', '.env')
+  .option('-o, --overload', 'override existing env variables')
+  .option('-a, --all', 'include all machine envs as well')
+  .option('-pp, --pretty-print', 'pretty print output')
+  .action(require('./actions/get'))
+
 // dotenvx hub
 program.addCommand(require('./commands/hub'))
 

package/src/lib/main.js

@@ -5,6 +5,7 @@ const dotenvExpand = require('dotenv-expand')
 // services
 const Encrypt = require('./services/encrypt')
 const Ls = require('./services/ls')
+const Get = require('./services/get')
 
 const config = function (options) {
   return dotenv.config(options)
@@ -114,6 +115,10 @@ const ls = function (directory, envFile) {
   return new Ls(directory, envFile).run()
 }
 
+const get = function (key, envFile, overload, all) {
+  return new Get(key, envFile, overload, all).run()
+}
+
 module.exports = {
   config,
   configDotenv,
@@ -121,6 +126,7 @@ module.exports = {
   parse,
   parseExpand,
   inject,
+  encrypt,
   ls,
-  encrypt
+  get
 }

package/src/lib/services/encrypt.js

@@ -6,11 +6,12 @@ const DotenvKeys = require('./../helpers/dotenvKeys')
 const DotenvVault = require('./../helpers/dotenvVault')
 
 const ENCODING = 'utf8'
+const RESERVED_ENV_FILES = ['.env.vault', '.env.project', '.env.keys', '.env.me', '.env.x']
 
 class Encrypt {
-  constructor (directory = '.', envFile = '.env') {
+  constructor (directory = '.', envFile) {
     this.directory = directory
-    this.envFile = envFile
+    this.envFile = envFile || this._findEnvFiles()
     // calculated
     this.envKeysFilepath = path.resolve(this.directory, '.env.keys')
     this.envVaultFilepath = path.resolve(this.directory, '.env.vault')
@@ -83,7 +84,8 @@ class Encrypt {
       dotenvVaultFile,
       addedVaults,
       existingVaults,
-      addedDotenvFilenames
+      addedDotenvFilenames,
+      envFile: this.envFile
     }
   }
 
@@ -110,6 +112,17 @@ class Encrypt {
 
     return dotenv.configDotenv(options).parsed
   }
+
+  _findEnvFiles () {
+    const files = fs.readdirSync(this.directory)
+    const envFiles = files.filter(file =>
+      file.startsWith('.env') &&
+      !file.endsWith('.previous') &&
+      !RESERVED_ENV_FILES.includes(file)
+    )
+
+    return envFiles
+  }
 }
 
 module.exports = Encrypt

package/src/lib/services/get.js

@@ -0,0 +1,47 @@
+const dotenv = require('dotenv')
+const dotenvExpand = require('dotenv-expand')
+
+class Get {
+  constructor (key, envFile = '.env', overload = false, all = false) {
+    this.key = key
+    this.envFile = envFile
+    this.overload = overload
+    this.all = all
+  }
+
+  run () {
+    const clonedEnv = { ...process.env }
+    const options = {
+      processEnv: clonedEnv,
+      path: this.envFile,
+      override: this.overload
+    }
+    const parsed = dotenv.config(options).parsed
+
+    const expandedEnv = { ...clonedEnv }
+    const expandOptions = {
+      processEnv: expandedEnv,
+      parsed
+    }
+    dotenvExpand.expand(expandOptions)
+
+    if (!this.key) {
+      // if user wants to return ALL envs (even prior set on machine)
+      if (this.all) {
+        return expandedEnv
+      }
+
+      // typical scenario - return only envs that were identified in the .env file
+      const result = {}
+      for (const key of Object.keys(parsed)) {
+        result[key] = expandedEnv[key]
+      }
+
+      return result
+    }
+
+    return expandedEnv[this.key]
+  }
+}
+
+module.exports = Get