@dotenvx/dotenvx 0.30.0 → 0.30.2

package/README.md

@@ -686,6 +686,13 @@ $ dotenvx hub push
 * [`dotenvx gitignore`](https://dotenvx.com/docs/features/gitignore) – gitignore your `.env` files
 * [`dotenvx prebuild`](https://dotenvx.com/docs/features/prebuild) – prevent `.env` files from being built into your docker container
 * [`dotenvx precommit`](https://dotenvx.com/docs/features/precommit) – prevent `.env` files from being committed to code
+* [`dotenvx scan`](https://dotenvx.com/docs/features/scan) – scan for leaked secrets in code
+
+> Convenience
+
+* [`dotenvx get`](https://dotenvx.com/docs/features/get) – return a single environment variable
+* [`dotenvx ls`](https://dotenvx.com/docs/features/ls) – list all .env files in your repo
+* [`dotenvx settings`](https://dotenvx.com/docs/features/settings) – print current dotenvx settings
 
  
 

package/package.json

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

package/src/cli/actions/decrypt.js

@@ -2,9 +2,11 @@ const fs = require('fs')
 const dotenv = require('dotenv')
 
 const logger = require('./../../shared/logger')
-const helpers = require('./../helpers')
 const createSpinner = require('./../../shared/createSpinner')
+
 const libDecrypt = require('./../../lib/helpers/decrypt')
+const sleep = require('./../../lib/helpers/sleep')
+const resolvePath = require('./../../lib/helpers/resolvePath')
 
 const spinner = createSpinner('decrypting')
 
@@ -13,13 +15,13 @@ const ENCODING = 'utf8'
 
 async function decrypt () {
   spinner.start()
-  await helpers.sleep(500) // better dx
+  await sleep(500) // better dx
 
   const options = this.opts()
   logger.debug(`options: ${JSON.stringify(options)}`)
 
-  const vaultFilepath = helpers.resolvePath('.env.vault')
-  const keysFilepath = helpers.resolvePath('.env.keys')
+  const vaultFilepath = resolvePath('.env.vault')
+  const keysFilepath = resolvePath('.env.keys')
   const changedEnvFilenames = new Set()
   const unchangedEnvFilenames = new Set()
 

package/src/cli/actions/encrypt.js

@@ -3,13 +3,15 @@ const path = require('path')
 
 const main = require('./../../lib/main')
 const logger = require('./../../shared/logger')
-const helpers = require('./../helpers')
 const createSpinner = require('./../../shared/createSpinner')
+const sleep = require('./../../lib/helpers/sleep')
+const pluralize = require('./../../lib/helpers/pluralize')
+
 const spinner = createSpinner('encrypting')
 
 async function encrypt (directory) {
   spinner.start()
-  await helpers.sleep(500) // better dx
+  await sleep(500) // better dx
 
   logger.debug(`directory: ${directory}`)
 
@@ -55,7 +57,7 @@ async function encrypt (directory) {
     }
 
     if (addedKeys.length > 0) {
-      spinner.succeed(`${helpers.pluralize('key', addedKeys.length)} added to .env.keys (${addedKeys})`)
+      spinner.succeed(`${pluralize('key', addedKeys.length)} added to .env.keys (${addedKeys})`)
       logger.help2('ℹ push .env.keys up to hub: [dotenvx hub push]')
     }
 

package/src/cli/actions/genexample.js

@@ -1,16 +1,17 @@
 const fs = require('fs')
 const main = require('./../../lib/main')
-const helpers = require('./../helpers')
 const logger = require('./../../shared/logger')
 const createSpinner = require('./../../shared/createSpinner')
 
+const sleep = require('./../../lib/helpers/sleep')
+
 const spinner = createSpinner('generating')
 
 const ENCODING = 'utf8'
 
 async function genexample (directory) {
   spinner.start()
-  await helpers.sleep(500) // better dx
+  await sleep(500) // better dx
 
   logger.debug(`directory: ${directory}`)
 

package/src/cli/actions/hub/open.js

@@ -3,29 +3,59 @@ const confirm = require('@inquirer/confirm').default
 
 const createSpinner = require('./../../../shared/createSpinner')
 const logger = require('./../../../shared/logger')
-const helpers = require('./../../helpers')
+
+const isGitRepo = require('./../../../lib/helpers/isGitRepo')
+const isGithub = require('./../../../lib/helpers/isGithub')
+const gitUrl = require('./../../../lib/helpers/gitUrl')
+const gitRoot = require('./../../../lib/helpers/gitRoot')
+const extractUsernameName = require('./../../../lib/helpers/extractUsernameName')
+const sleep = require('./../../../lib/helpers/sleep')
+
+const spinner = createSpinner('opening')
 
 async function open () {
+  // debug opts
   const options = this.opts()
   logger.debug(`options: ${JSON.stringify(options)}`)
 
-  const hostname = options.hostname
-  const remoteOriginUrl = helpers.getRemoteOriginUrl()
-  const usernameName = helpers.extractUsernameName(remoteOriginUrl)
+  // must be a git repo
+  if (!isGitRepo()) {
+    spinner.fail('oops, must be a git repository')
+    logger.help('? create one with [git init .]')
+    process.exit(1)
+  }
+  // must be a git root
+  const gitroot = gitRoot()
+  if (!gitroot) {
+    spinner.fail('oops, could not determine git repository\'s root')
+    logger.help('? create one with [git init .]')
+    process.exit(1)
+  }
+  // must have a remote origin url
+  const giturl = gitUrl()
+  if (!giturl) {
+    spinner.fail('oops, must have a remote origin (git remote -v)')
+    logger.help('? create it at [github.com/new] and then run [git remote add origin git@github.com:username/repository.git]')
+    process.exit(1)
+  }
+  // must be a github remote
+  if (!isGithub(giturl)) {
+    spinner.fail('oops, must be a github.com remote origin (git remote -v)')
+    logger.help('? create it at [github.com/new] and then run [git remote add origin git@github.com:username/repository.git]')
+    logger.help2('ℹ need support for other origins? [please tell us](https://github.com/dotenvx/dotenvx/issues)')
+    process.exit(1)
+  }
 
-  const openUrl = `${hostname}/gh/${usernameName}`
+  const usernameName = extractUsernameName(giturl)
+  const openUrl = `${options.hostname}/gh/${usernameName}`
 
   // optionally allow user to open browser
   const answer = await confirm({ message: `press Enter to open [${openUrl}]...` })
 
   if (answer) {
-    const spinner = createSpinner('opening')
     spinner.start()
-
-    await helpers.sleep(500) // better dx
-
+    await sleep(500) // better dx
     await openBrowser(openUrl)
-
     spinner.succeed(`opened [${usernameName}]`)
   }
 }

package/src/cli/actions/hub/pull.js

@@ -4,13 +4,14 @@ const { request } = require('undici')
 
 const store = require('./../../../shared/store')
 const logger = require('./../../../shared/logger')
-const helpers = require('./../../helpers')
 const createSpinner = require('./../../../shared/createSpinner')
 
 const isGitRepo = require('./../../../lib/helpers/isGitRepo')
 const isGithub = require('./../../../lib/helpers/isGithub')
 const gitUrl = require('./../../../lib/helpers/gitUrl')
 const gitRoot = require('./../../../lib/helpers/gitRoot')
+const extractUsernameName = require('./../../../lib/helpers/extractUsernameName')
+const sleep = require('./../../../lib/helpers/sleep')
 
 const spinner = createSpinner('pulling')
 
@@ -20,7 +21,7 @@ const ENCODING = 'utf8'
 // Create a simple-git instance for the current directory
 async function pull (directory) {
   spinner.start()
-  await helpers.sleep(500) // better dx
+  await sleep(500) // better dx
 
   // debug args
   logger.debug(`directory: ${directory}`)
@@ -61,7 +62,7 @@ async function pull (directory) {
   const hostname = options.hostname
   const pullUrl = `${hostname}/v1/pull`
   const oauthToken = store.getToken()
-  const usernameName = helpers.extractUsernameName(giturl)
+  const usernameName = extractUsernameName(giturl)
   const relativeEnvKeysFilepath = path.relative(gitroot, path.join(process.cwd(), directory, '.env.keys')).replace(/\\/g, '/') // smartly determine path/to/.env.keys file from repository root - where user is cd-ed inside a folder or at repo root
 
   try {
@@ -83,7 +84,7 @@ async function pull (directory) {
       logger.http(responseData)
       spinner.fail(responseData.error.message)
       if (response.statusCode === 404) {
-        logger.help(`? try visiting [${hostname}gh/${usernameName}] in your browser`)
+        logger.help(`? try visiting [${hostname}/gh/${usernameName}] in your browser`)
       }
       process.exit(1)
     }

package/src/cli/actions/hub/push.js

@@ -4,13 +4,14 @@ const { request } = require('undici')
 
 const store = require('./../../../shared/store')
 const logger = require('./../../../shared/logger')
-const helpers = require('./../../helpers')
 const createSpinner = require('./../../../shared/createSpinner')
 
 const isGitRepo = require('./../../../lib/helpers/isGitRepo')
 const isGithub = require('./../../../lib/helpers/isGithub')
 const gitUrl = require('./../../../lib/helpers/gitUrl')
 const gitRoot = require('./../../../lib/helpers/gitRoot')
+const extractUsernameName = require('./../../../lib/helpers/extractUsernameName')
+const sleep = require('./../../../lib/helpers/sleep')
 
 const spinner = createSpinner('pushing')
 
@@ -20,7 +21,7 @@ const ENCODING = 'utf8'
 // Create a simple-git instance for the current directory
 async function push (directory) {
   spinner.start()
-  await helpers.sleep(500) // better dx
+  await sleep(500) // better dx
 
   // debug args
   logger.debug(`directory: ${directory}`)
@@ -69,7 +70,7 @@ async function push (directory) {
   const pushUrl = `${hostname}/v1/push`
   const oauthToken = store.getToken()
   const dotenvKeysContent = fs.readFileSync(envKeysFilepath, ENCODING)
-  const usernameName = helpers.extractUsernameName(giturl)
+  const usernameName = extractUsernameName(giturl)
   const relativeEnvKeysFilepath = path.relative(gitroot, path.join(process.cwd(), directory, '.env.keys')).replace(/\\/g, '/') // smartly determine path/to/.env.keys file from repository root - where user is cd-ed inside a folder or at repo root
 
   try {
@@ -92,7 +93,7 @@ async function push (directory) {
       logger.http(responseData)
       spinner.fail(responseData.error.message)
       if (response.statusCode === 404) {
-        logger.help(`? try visiting [${hostname}gh/${usernameName}] in your browser`)
+        logger.help(`? try visiting [${hostname}/gh/${usernameName}] in your browser`)
       }
       process.exit(1)
     }

package/src/cli/actions/prebuild.js

@@ -3,7 +3,7 @@ const fs = require('fs')
 const ignore = require('ignore')
 
 const logger = require('./../../shared/logger')
-const helpers = require('./../helpers')
+const pluralize = require('./../../lib/helpers/pluralize')
 
 function prebuild () {
   const options = this.opts()
@@ -55,7 +55,7 @@ function prebuild () {
 
   // 3. outpout success
   if (warningCount > 0) {
-    logger.successvpb(`success (with ${helpers.pluralize('warning', warningCount)})`)
+    logger.successvpb(`success (with ${pluralize('warning', warningCount)})`)
   } else {
     logger.successvpb('success')
   }

package/src/cli/commands/hub.js

@@ -5,7 +5,7 @@ const store = require('./../../shared/store')
 const hub = new Command('hub')
 
 hub
-  .description('Interact with the hub')
+  .description('interact with dotenvx hub')
 
 hub
   .command('login')

package/src/cli/dotenvx.js

@@ -12,7 +12,7 @@ const packageJson = require('./../lib/helpers/packageJson')
 const notice = new UpdateNotice()
 notice.check()
 if (notice.update) {
-  logger.warn(`Update available ${notice.packageVersion} → ${notice.latestVersion} [see changelog](dotenvx.com/changelog)`)
+  logger.warn(`Update available ${notice.packageVersion} → ${notice.latestVersion}\nchangelog: https://dotenvx.com/changelog`)
 }
 
 // for use with run
@@ -75,6 +75,23 @@ program.command('run')
     runAction.apply(this, args)
   })
 
+// dotenvx get
+const getAction = require('./actions/get')
+program.command('get')
+  .description('return a single environment variable')
+  .argument('[key]', 'environment variable name')
+  .option('-e, --env <strings...>', 'environment variable(s) set as string (example: "HELLO=World")', collectEnvs('env'), [])
+  .option('-f, --env-file <paths...>', 'path(s) to your env file(s)', collectEnvs('envFile'), [])
+  .option('-fv, --env-vault-file <paths...>', 'path(s) to your .env.vault file(s)', collectEnvs('envVaultFile'), [])
+  .option('-o, --overload', 'override existing env variables')
+  .option('-a, --all', 'include all machine envs as well')
+  .option('-pp, --pretty-print', 'pretty print output')
+  .action(function (...args) {
+    this.envs = envs
+
+    getAction.apply(this, args)
+  })
+
 // dotenvx encrypt
 program.command('encrypt')
   .description('encrypt .env.* to .env.vault')
@@ -88,31 +105,31 @@ program.command('decrypt')
   .description('decrypt .env.vault to .env*')
   .action(require('./actions/decrypt'))
 
+// dotenvx genexample
+program.command('genexample')
+  .description('generate .env.example')
+  .argument('[directory]', 'directory to generate from', '.')
+  .option('-f, --env-file <paths...>', 'path(s) to your env file(s)', '.env')
+  .action(require('./actions/genexample'))
+
 // dotenvx gitignore
 program.command('gitignore')
   .description('append to .gitignore file (and if existing, .dockerignore, .npmignore, and .vercelignore)')
   .addHelpText('after', examples.gitignore)
   .action(require('./actions/gitignore'))
 
-// dotenvx precommit
-program.command('precommit')
-  .description('prevent committing .env files to code')
-  .addHelpText('after', examples.precommit)
-  .option('-i, --install', 'install to .git/hooks/pre-commit')
-  .action(require('./actions/precommit'))
-
 // dotenvx prebuild
 program.command('prebuild')
   .description('prevent including .env files in docker builds')
   .addHelpText('after', examples.prebuild)
   .action(require('./actions/prebuild'))
 
-// dotenvx genexample
-program.command('genexample')
-  .description('generate .env.example')
-  .argument('[directory]', 'directory to generate from', '.')
-  .option('-f, --env-file <paths...>', 'path(s) to your env file(s)', '.env')
-  .action(require('./actions/genexample'))
+// dotenvx precommit
+program.command('precommit')
+  .description('prevent committing .env files to code')
+  .addHelpText('after', examples.precommit)
+  .option('-i, --install', 'install to .git/hooks/pre-commit')
+  .action(require('./actions/precommit'))
 
 // dotenvx scan
 program.command('scan')
@@ -126,23 +143,6 @@ program.command('ls')
   .option('-f, --env-file <filenames...>', 'path(s) to your env file(s)', '.env*')
   .action(require('./actions/ls'))
 
-// dotenvx get
-const getAction = require('./actions/get')
-program.command('get')
-  .description('return environment variable(s)')
-  .argument('[key]', 'environment variable name')
-  .option('-e, --env <strings...>', 'environment variable(s) set as string (example: "HELLO=World")', collectEnvs('env'), [])
-  .option('-f, --env-file <paths...>', 'path(s) to your env file(s)', collectEnvs('envFile'), [])
-  .option('-fv, --env-vault-file <paths...>', 'path(s) to your .env.vault file(s)', collectEnvs('envVaultFile'), [])
-  .option('-o, --overload', 'override existing env variables')
-  .option('-a, --all', 'include all machine envs as well')
-  .option('-pp, --pretty-print', 'pretty print output')
-  .action(function (...args) {
-    this.envs = envs
-
-    getAction.apply(this, args)
-  })
-
 // dotenvx settings
 program.command('settings')
   .description('print current dotenvx settings')

package/src/lib/helpers/extractUsernameName.js

@@ -0,0 +1,10 @@
+function extractUsernameName (url) {
+  // Removing the protocol part and splitting by slashes and colons
+  // Removing the protocol part and .git suffix, then splitting by slashes and colons
+  const parts = url.replace(/(^\w+:|^)\/\//, '').replace(/\.git$/, '').split(/[/:]/)
+
+  // Extract the 'username/repository' part
+  return parts.slice(-2).join('/')
+}
+
+module.exports = extractUsernameName

package/src/lib/helpers/gitRoot.js

@@ -1,10 +1,11 @@
-const { execSync } = require('child_process')
+const execa = require('execa')
 
 function gitRoot () {
   try {
     // Redirect standard error to null to suppress Git error messages
-    const root = execSync('git rev-parse --show-toplevel 2> /dev/null').toString().trim()
-    return root
+    const raw = execa.sync('git', ['rev-parse', '--show-toplevel'], { stderr: 'ignore' })
+    const result = raw.stdout.toString().trim()
+    return result
   } catch (_error) {
     return null
   }

package/src/lib/helpers/gitUrl.js

@@ -1,10 +1,10 @@
-const { execSync } = require('child_process')
+const execa = require('execa')
 
 function gitUrl () {
   try {
-    // Redirect standard error to null to suppress Git error messages
-    const url = execSync('git remote get-url origin 2> /dev/null').toString().trim()
-    return url
+    const raw = execa.sync('git', ['remote', 'get-url', 'origin'])
+
+    return raw.stdout.toString().trim()
   } catch (_error) {
     return null
   }

package/src/lib/helpers/isGitRepo.js

@@ -1,9 +1,9 @@
-const { execSync } = require('child_process')
+const execa = require('execa')
 
 function isGitRepo () {
   try {
-    // Redirect standard error to null to suppress Git error messages
-    const result = execSync('git rev-parse --is-inside-work-tree 2> /dev/null').toString().trim()
+    const raw = execa.sync('git', ['rev-parse', '--is-inside-work-tree'], { stderr: 'ignore' })
+    const result = raw.stdout.toString().trim()
     return result === 'true'
   } catch (_error) {
     return false

package/src/lib/helpers/resolvePath.js

@@ -0,0 +1,8 @@
+const path = require('path')
+
+// resolve path based on current running process location
+function resolvePath (filepath) {
+  return path.resolve(process.cwd(), filepath)
+}
+
+module.exports = resolvePath

package/src/lib/helpers/sleep.js

@@ -0,0 +1,5 @@
+function sleep (ms) {
+  return new Promise(resolve => setTimeout(resolve, ms))
+}
+
+module.exports = sleep

package/src/cli/helpers.js

@@ -1,46 +0,0 @@
-const path = require('path')
-const childProcess = require('child_process')
-
-const sleep = function (ms) {
-  return new Promise(resolve => setTimeout(resolve, ms))
-}
-
-// resolve path based on current running process location
-const resolvePath = function (filepath) {
-  return path.resolve(process.cwd(), filepath)
-}
-
-const pluralize = function (word, count) {
-  // simple pluralization: add 's' at the end
-  if (count === 0 || count > 1) {
-    return word + 's'
-  } else {
-    return word
-  }
-}
-
-const getRemoteOriginUrl = function () {
-  try {
-    const url = childProcess.execSync('git remote get-url origin 2> /dev/null').toString().trim()
-    return url
-  } catch (_error) {
-    return null
-  }
-}
-
-const extractUsernameName = function (url) {
-  // Removing the protocol part and splitting by slashes and colons
-  // Removing the protocol part and .git suffix, then splitting by slashes and colons
-  const parts = url.replace(/(^\w+:|^)\/\//, '').replace(/\.git$/, '').split(/[/:]/)
-
-  // Extract the 'username/repository' part
-  return parts.slice(-2).join('/')
-}
-
-module.exports = {
-  sleep,
-  resolvePath,
-  pluralize,
-  getRemoteOriginUrl,
-  extractUsernameName
-}