@dotenvx/dotenvx 0.45.0 → 1.0.0

package/package.json

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

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

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

package/src/cli/actions/{genexample.js → ext/genexample.js}

@@ -1,9 +1,9 @@
 const fs = require('fs')
-const main = require('./../../lib/main')
-const { logger } = require('./../../shared/logger')
-const createSpinner = require('./../../shared/createSpinner')
+const main = require('./../../../lib/main')
+const { logger } = require('./../../../shared/logger')
+const createSpinner = require('./../../../shared/createSpinner')
 
-const sleep = require('./../../lib/helpers/sleep')
+const sleep = require('./../../../lib/helpers/sleep')
 
 const spinner = createSpinner('generating')
 

package/src/cli/actions/{gitignore.js → ext/gitignore.js}

@@ -1,7 +1,7 @@
 const fs = require('fs')
 
 const FORMATS = ['.env*', '!.env.vault']
-const { logger } = require('./../../shared/logger')
+const { logger } = require('./../../../shared/logger')
 
 class Generic {
   constructor (filename, touchFile = false) {

package/src/cli/actions/{hub → ext/hub}/login.js

@@ -1,11 +1,11 @@
 const open = require('open')
 const { request } = require('undici')
-const clipboardy = require('./../../../lib/helpers/clipboardy')
+const clipboardy = require('./../../../../lib/helpers/clipboardy')
 const confirm = require('@inquirer/confirm').default
 
-const createSpinner = require('./../../../shared/createSpinner')
-const store = require('./../../../shared/store')
-const { logger } = require('./../../../shared/logger')
+const createSpinner = require('./../../../../shared/createSpinner')
+const store = require('./../../../../shared/store')
+const { logger } = require('./../../../../shared/logger')
 
 const OAUTH_CLIENT_ID = 'oac_dotenvxcli'
 

package/src/cli/actions/{hub → ext/hub}/logout.js

@@ -1,10 +1,10 @@
 const openBrowser = require('open')
 const confirm = require('@inquirer/confirm').default
 
-const createSpinner = require('./../../../shared/createSpinner')
-const store = require('./../../../shared/store')
-const { logger } = require('./../../../shared/logger')
-const sleep = require('./../../../lib/helpers/sleep')
+const createSpinner = require('./../../../../shared/createSpinner')
+const store = require('./../../../../shared/store')
+const { logger } = require('./../../../../shared/logger')
+const sleep = require('./../../../../lib/helpers/sleep')
 
 const username = store.getUsername()
 const usernamePart = username ? ` [${username}]` : ''

package/src/cli/actions/{hub → ext/hub}/open.js

@@ -1,15 +1,15 @@
 const openBrowser = require('open')
 const confirm = require('@inquirer/confirm').default
 
-const createSpinner = require('./../../../shared/createSpinner')
-const { logger } = require('./../../../shared/logger')
-
-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 createSpinner = require('./../../../../shared/createSpinner')
+const { logger } = require('./../../../../shared/logger')
+
+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')
 

package/src/cli/actions/{hub → ext/hub}/pull.js

@@ -2,16 +2,16 @@ const fs = require('fs')
 const path = require('path')
 const { request } = require('undici')
 
-const store = require('./../../../shared/store')
-const { logger } = require('./../../../shared/logger')
-const createSpinner = require('./../../../shared/createSpinner')
+const store = require('./../../../../shared/store')
+const { logger } = require('./../../../../shared/logger')
+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 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')
 

package/src/cli/actions/{hub → ext/hub}/push.js

@@ -2,17 +2,17 @@ const fs = require('fs')
 const path = require('path')
 const { request } = require('undici')
 
-const store = require('./../../../shared/store')
-const { logger } = require('./../../../shared/logger')
-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 forgivingDirectory = require('./../../../lib/helpers/forgivingDirectory')
+const store = require('./../../../../shared/store')
+const { logger } = require('./../../../../shared/logger')
+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 forgivingDirectory = require('./../../../../lib/helpers/forgivingDirectory')
 
 const spinner = createSpinner('pushing')
 
@@ -106,7 +106,7 @@ async function push (directory) {
   }
 
   spinner.succeed(`pushed [${usernameName}]`)
-  logger.help2('ℹ run [dotenvx hub open] to view on hub')
+  logger.help2('ℹ run [dotenvx ext hub open] to view on hub')
 }
 
 module.exports = push

package/src/cli/actions/{hub → ext/hub}/status.js

@@ -1,5 +1,5 @@
-const store = require('./../../../shared/store')
-const { logger } = require('./../../../shared/logger')
+const store = require('./../../../../shared/store')
+const { logger } = require('./../../../../shared/logger')
 
 async function status () {
   logger.info(`logged in to ${store.getHostname()} as ${store.getUsername()}`)

package/src/cli/actions/{hub → ext/hub}/token.js

@@ -1,5 +1,5 @@
-const store = require('./../../../shared/store')
-const { logger } = require('./../../../shared/logger')
+const store = require('./../../../../shared/store')
+const { logger } = require('./../../../../shared/logger')
 
 async function token () {
   logger.debug(store.configPath())

package/src/cli/actions/{ls.js → ext/ls.js}

@@ -1,9 +1,9 @@
 const treeify = require('object-treeify')
 
-const { logger } = require('./../../shared/logger')
+const { logger } = require('./../../../shared/logger')
 
-const main = require('./../../lib/main')
-const ArrayToTree = require('./../../lib/helpers/arrayToTree')
+const main = require('./../../../lib/main')
+const ArrayToTree = require('./../../../lib/helpers/arrayToTree')
 
 function ls (directory) {
   // debug args

package/src/cli/actions/{prebuild.js → ext/prebuild.js}

@@ -2,8 +2,8 @@ const fs = require('fs')
 
 const ignore = require('ignore')
 
-const { logger } = require('./../../shared/logger')
-const pluralize = require('./../../lib/helpers/pluralize')
+const { logger } = require('./../../../shared/logger')
+const pluralize = require('./../../../lib/helpers/pluralize')
 
 function prebuild () {
   const options = this.opts()

package/src/cli/actions/{precommit.js → ext/precommit.js}

@@ -1,6 +1,6 @@
-const { logger } = require('./../../shared/logger')
+const { logger } = require('./../../../shared/logger')
 
-const Precommit = require('./../../lib/services/precommit')
+const Precommit = require('./../../../lib/services/precommit')
 
 function precommit () {
   const options = this.opts()

package/src/cli/actions/{scan.js → ext/scan.js}

@@ -1,6 +1,6 @@
 const execa = require('execa')
 
-const { logger } = require('./../../shared/logger')
+const { logger } = require('./../../../shared/logger')
 
 async function scan () {
   const options = this.opts()

package/src/cli/actions/{settings.js → ext/settings.js}

@@ -1,6 +1,6 @@
-const { logger } = require('./../../shared/logger')
+const { logger } = require('./../../../shared/logger')
 
-const main = require('./../../lib/main')
+const main = require('./../../../lib/main')
 
 function settings (key = null) {
   logger.debug(`key: ${key}`)

package/src/cli/actions/{vault → ext/vault}/decrypt.js

@@ -1,10 +1,10 @@
 const fs = require('fs')
 
-const { logger } = require('./../../../shared/logger')
-const createSpinner = require('./../../../shared/createSpinner')
-const sleep = require('./../../../lib/helpers/sleep')
+const { logger } = require('./../../../../shared/logger')
+const createSpinner = require('./../../../../shared/createSpinner')
+const sleep = require('./../../../../lib/helpers/sleep')
 
-const Decrypt = require('./../../../lib/services/decrypt')
+const Decrypt = require('./../../../../lib/services/decrypt')
 
 const spinner = createSpinner('decrypting')
 

package/src/cli/actions/{vault → ext/vault}/encrypt.js

@@ -1,11 +1,11 @@
 const fs = require('fs')
 const path = require('path')
 
-const main = require('./../../../lib/main')
-const { logger } = require('./../../../shared/logger')
-const createSpinner = require('./../../../shared/createSpinner')
-const sleep = require('./../../../lib/helpers/sleep')
-const pluralize = require('./../../../lib/helpers/pluralize')
+const main = require('./../../../../lib/main')
+const { logger } = require('./../../../../shared/logger')
+const createSpinner = require('./../../../../shared/createSpinner')
+const sleep = require('./../../../../lib/helpers/sleep')
+const pluralize = require('./../../../../lib/helpers/pluralize')
 
 const spinner = createSpinner('encrypting')
 
@@ -29,7 +29,7 @@ async function encrypt (directory) {
       existingVaults,
       addedDotenvFilenames,
       envFile
-    } = main.encrypt(directory, options.envFile)
+    } = main.vaultEncrypt(directory, options.envFile)
 
     logger.verbose(`generating .env.keys from ${envFile}`)
     if (addedKeys.length > 0) {

package/src/cli/actions/{vault → ext/vault}/migrate.js

@@ -1,4 +1,4 @@
-const { logger } = require('./../../../shared/logger')
+const { logger } = require('./../../../../shared/logger')
 
 function migrate (directory) {
   // debug args
@@ -10,18 +10,18 @@ function migrate (directory) {
   try {
     logger.help2('To migrate your .env.vault file to encrypted .env file(s):')
     logger.help('')
-    logger.help('  1. Run [dotenvx vault decrypt]')
+    logger.help('  1. Run [dotenvx ext vault decrypt]')
     logger.help('  2. Run [ls -a .env*]')
     logger.help('')
-    logger.help2('Lastly, convert each .env(.environment) file:')
+    logger.help2('Lastly, encrypt each .env(.environment) file:')
     logger.help('')
-    logger.help('  3. Run [dotenvx convert -f .env.production]')
+    logger.help('  3. Run [dotenvx encrypt -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('  $ dotenvx encrypt -f .env')
+    logger.help2('  $ dotenvx encrypt -f .env.ci')
+    logger.help2('  $ dotenvx encrypt -f .env.production')
     logger.help2('')
     logger.help2('Afterward:')
     logger.help2('')

package/src/cli/actions/{vault → ext/vault}/status.js

@@ -1,6 +1,6 @@
-const { logger } = require('./../../../shared/logger')
+const { logger } = require('./../../../../shared/logger')
 
-const main = require('./../../../lib/main')
+const main = require('./../../../../lib/main')
 
 function status (directory) {
   // debug args

package/src/cli/actions/run.js

@@ -115,7 +115,7 @@ async function run () {
 
     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: Run [dotenvx ext vault migrate] 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]')
     }
 

package/src/cli/actions/set.js

@@ -14,16 +14,22 @@ function set (key, value) {
   const options = this.opts()
   logger.debug(`options: ${JSON.stringify(options)}`)
 
+  // encrypt
+  let encrypt = true
+  if (options.plain) {
+    encrypt = false
+  }
+
   try {
     const {
       processedEnvFiles,
       changedFilepaths,
       unchangedFilepaths
-    } = main.set(key, value, options.envFile, options.encrypt)
+    } = main.set(key, value, options.envFile, encrypt)
 
     let withEncryption = ''
 
-    if (options.encrypt) {
+    if (encrypt) {
       withEncryption = ' with encryption'
     }
 

package/src/cli/commands/ext/hub.js

@@ -0,0 +1,89 @@
+const { Command } = require('commander')
+
+const store = require('./../../../shared/store')
+const { logger } = require('./../../../shared/logger')
+
+const hub = new Command('hub')
+
+hub
+  .description('🚫 DEPRECATED: to be replaced by [dotenvx pro]')
+
+const loginAction = require('./../../actions/ext/hub/login')
+hub
+  .command('login')
+  .description('authenticate to dotenvx hub')
+  .option('-h, --hostname <url>', 'set hostname', store.getHostname())
+  .action(function (...args) {
+    logger.warn('DEPRECATION NOTICE: to be replaced by [dotenvx pro]')
+
+    loginAction.apply(this, args)
+  })
+
+const pushAction = require('./../../actions/ext/hub/push')
+hub
+  .command('push')
+  .description('push .env.keys to dotenvx hub')
+  .argument('[directory]', 'directory to push', '.')
+  .option('-h, --hostname <url>', 'set hostname', store.getHostname())
+  .action(function (...args) {
+    logger.warn('DEPRECATION NOTICE: to be replaced by [dotenvx pro]')
+
+    pushAction.apply(this, args)
+  })
+
+const pullAction = require('./../../actions/ext/hub/pull')
+hub
+  .command('pull')
+  .description('pull .env.keys from dotenvx hub')
+  .argument('[directory]', 'directory to pull', '.')
+  .option('-h, --hostname <url>', 'set hostname', store.getHostname())
+  .action(function (...args) {
+    logger.warn('DEPRECATION NOTICE: to be replaced by [dotenvx pro]')
+
+    pullAction.apply(this, args)
+  })
+
+const openAction = require('./../../actions/ext/hub/open')
+hub
+  .command('open')
+  .description('view repository on dotenvx hub')
+  .option('-h, --hostname <url>', 'set hostname', store.getHostname())
+  .action(function (...args) {
+    logger.warn('DEPRECATION NOTICE: to be replaced by [dotenvx pro]')
+
+    openAction.apply(this, args)
+  })
+
+const tokenAction = require('./../../actions/ext/hub/token')
+hub
+  .command('token')
+  .description('print the auth token dotenvx hub is configured to use')
+  .option('-h, --hostname <url>', 'set hostname', 'https://hub.dotenvx.com')
+  .action(function (...args) {
+    logger.warn('DEPRECATION NOTICE: to be replaced by [dotenvx pro]')
+
+    tokenAction.apply(this, args)
+  })
+
+const statusAction = require('./../../actions/ext/hub/status')
+hub
+  .command('status')
+  .description('display logged in user')
+  .action(function (...args) {
+    logger.warn('DEPRECATION NOTICE: to be replaced by [dotenvx pro]')
+
+    statusAction.apply(this, args)
+  })
+
+const logoutAction = require('./../../actions/ext/hub/logout')
+hub
+  .command('logout')
+  .description('log out this machine from dotenvx hub')
+  .option('-h, --hostname <url>', 'set hostname', store.getHostname())
+  .action(function (...args) {
+    logger.warn('DEPRECATION NOTICE: to be replaced by [dotenvx pro]')
+
+    logoutAction.apply(this, args)
+  })
+
+module.exports = hub

package/src/cli/commands/ext/vault.js

@@ -0,0 +1,36 @@
+const { Command } = require('commander')
+
+const examples = require('./../../examples')
+
+const vault = new Command('vault')
+
+vault
+  .description('🔐 manage .env.vault files')
+
+// dotenvx ext vault migrate
+vault.command('migrate')
+  .description('instructions for migrating .env.vault to encrypted env file(s)')
+  .action(require('./../../actions/ext/vault/migrate'))
+
+// dotenvx ext vault encrypt
+vault.command('encrypt')
+  .description('encrypt .env.* to .env.vault')
+  .addHelpText('after', examples.vaultEncrypt)
+  .argument('[directory]', 'directory to encrypt', '.')
+  .option('-f, --env-file <paths...>', 'path(s) to your env file(s)')
+  .action(require('./../../actions/ext/vault/encrypt'))
+
+// dotenvx ext vault decrypt
+vault.command('decrypt')
+  .description('decrypt .env.vault to .env*')
+  .argument('[directory]', 'directory to decrypt', '.')
+  .option('-e, --environment <environments...>', 'environment(s) to decrypt')
+  .action(require('./../../actions/ext/vault/decrypt'))
+
+// dotenvx ext vault status
+vault.command('status')
+  .description('compare your .env* content(s) to your .env.vault decrypted content(s)')
+  .argument('[directory]', 'directory to check status against', '.')
+  .action(require('./../../actions/ext/vault/status'))
+
+module.exports = vault

package/src/cli/commands/ext.js

@@ -0,0 +1,58 @@
+const { Command } = require('commander')
+
+const examples = require('./../examples')
+
+const ext = new Command('ext')
+
+ext
+  .description('🔌 extensions')
+
+// dotenvx ext ls
+ext.command('ls')
+  .description('print all .env files in a tree structure')
+  .argument('[directory]', 'directory to list .env files from', '.')
+  .option('-f, --env-file <filenames...>', 'path(s) to your env file(s)', '.env*')
+  .action(require('./../actions/ext/ls'))
+
+// dotenvx ext genexample
+ext.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/ext/genexample'))
+
+// dotenvx ext gitignore
+ext.command('gitignore')
+  .description('append to .gitignore file (and if existing, .dockerignore, .npmignore, and .vercelignore)')
+  .addHelpText('after', examples.gitignore)
+  .action(require('./../actions/ext/gitignore'))
+
+// dotenvx ext prebuild
+ext.command('prebuild')
+  .description('prevent including .env files in docker builds')
+  .addHelpText('after', examples.prebuild)
+  .action(require('./../actions/ext/prebuild'))
+
+// dotenvx ext precommit
+ext.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/ext/precommit'))
+
+// dotenvx scan
+ext.command('scan')
+  .description('scan for leaked secrets')
+  .action(require('./../actions/ext/scan'))
+
+// dotenvx settings
+ext.command('settings')
+  .description('print current dotenvx settings')
+  .argument('[key]', 'settings name')
+  .option('-pp, --pretty-print', 'pretty print output')
+  .action(require('./../actions/ext/settings'))
+
+ext.addCommand(require('./../commands/ext/vault'))
+ext.addCommand(require('./../commands/ext/hub'))
+
+module.exports = ext