@dotenvx/dotenvx 0.45.0 → 1.0.0

package/src/cli/commands/hub.js

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

package/src/cli/commands/vault.js

@@ -1,36 +1,57 @@
 const { Command } = require('commander')
 
 const examples = require('./../examples')
+const { logger } = require('./../../shared/logger')
 
 const vault = new Command('vault')
 
 vault
-  .description('manage .env.vault files')
+  .description('DEPRECATED: moved to [dotenvx ext vault]')
 
 // dotenvx vault migrate
+const migrateAction = require('./../actions/ext/vault/migrate')
 vault.command('migrate')
-  .description('instructions for migrating .env.vault to encrypted env file(s)')
-  .action(require('./../actions/vault/migrate'))
+  .description('DEPRECATED: moved to [dotenvx ext vault migrate]')
+  .action(function (...args) {
+    logger.warn('DEPRECATION NOTICE: [dotenvx vault migrate] moved to [dotenvx ext vault migrate]')
+
+    migrateAction.apply(this, args)
+  })
 
 // dotenvx vault encrypt
+const encryptAction = require('./../actions/ext/vault/encrypt')
 vault.command('encrypt')
-  .description('encrypt .env.* to .env.vault')
-  .addHelpText('after', examples.encrypt)
+  .description('DEPRECATED: moved to [dotenvx ext vault encrypt]')
+  .addHelpText('after', examples.vaultEncrypt)
   .argument('[directory]', 'directory to encrypt', '.')
   .option('-f, --env-file <paths...>', 'path(s) to your env file(s)')
-  .action(require('./../actions/vault/encrypt'))
+  .action(function (...args) {
+    logger.warn('DEPRECATION NOTICE: [dotenvx vault encrypt] moved to [dotenvx ext vault encrypt]')
+
+    encryptAction.apply(this, args)
+  })
 
 // dotenvx vault decrypt
+const decryptAction = require('./../actions/ext/vault/decrypt')
 vault.command('decrypt')
-  .description('decrypt .env.vault to .env*')
+  .description('DEPRECATED: moved to [dotenvx ext vault decrypt]')
   .argument('[directory]', 'directory to decrypt', '.')
   .option('-e, --environment <environments...>', 'environment(s) to decrypt')
-  .action(require('./../actions/vault/decrypt'))
+  .action(function (...args) {
+    logger.warn('DEPRECATION NOTICE: [dotenvx vault decrypt] moved to [dotenvx ext vault decrypt]')
+
+    decryptAction.apply(this, args)
+  })
 
 // dotenvx vault status
+const statusAction = require('./../actions/ext/vault/status')
 vault.command('status')
-  .description('compare your .env* content(s) to your .env.vault decrypted content(s)')
+  .description('DEPRECATED: moved to [dotenvx ext vault status]')
   .argument('[directory]', 'directory to check status against', '.')
-  .action(require('./../actions/vault/status'))
+  .action(function (...args) {
+    logger.warn('DEPRECATION NOTICE: [dotenvx vault status] moved to [dotenvx ext vault status]')
+
+    statusAction.apply(this, args)
+  })
 
 module.exports = vault

package/src/cli/dotenvx.js

@@ -1,5 +1,7 @@
 #!/usr/bin/env node
 
+const fs = require('fs')
+const path = require('path')
 const UpdateNotice = require('./../lib/helpers/updateNotice')
 const { Command } = require('commander')
 const program = new Command()
@@ -82,101 +84,126 @@ program.command('set')
   .argument('KEY', 'KEY')
   .argument('value', 'value')
   .option('-f, --env-file <paths...>', 'path(s) to your env file(s)', '.env')
-  .option('-c, --encrypt', 'encrypt value')
+  .option('-c, --encrypt', 'encrypt value (default: true)', true)
+  .option('-p, --plain', 'store value as plain text', false)
   .action(require('./actions/set'))
 
-// dotenvx convert
+// dotenvx encrypt
+const encryptAction = require('./actions/encrypt')
+program.command('encrypt')
+  .description('convert .env file(s) to encrypted .env file(s)')
+  .option('-f, --env-file <paths...>', 'path(s) to your env file(s)')
+  .action(encryptAction)
+
+// dotenvx pro
+program.command('pro')
+  .description('🏆 pro')
+  .action(function (...args) {
+    const pro = fs.readFileSync(path.join(__dirname, './pro.txt'), 'utf8')
+
+    console.log(pro)
+  })
+
+// // dotenvx ent
+// program.command('ent')
+//   .description('🏢 enterprise')
+//   .action(function (...args) {
+//     console.log('coming soon (med-large companies)')
+//   })
+
+// dotenvx ext
+program.addCommand(require('./commands/ext'))
+
+//
+// DEPRECATED AND hidden
+//
+program.addCommand(require('./commands/hub'))
+program.addCommand(require('./commands/vault'))
+
 program.command('convert')
-  .description('convert env file(s) to encrypted env file(s)')
+  .description('DEPRECATED: moved to [dotenvx encrypt]')
   .option('-f, --env-file <paths...>', 'path(s) to your env file(s)')
-  .action(require('./actions/convert'))
+  .action(function (...args) {
+    logger.warn('DEPRECATION NOTICE: [dotenvx convert] has moved to [dotenvx encrypt]')
+
+    encryptAction.apply(this, args)
+  })
 
-// dotenvx ls
+const lsAction = require('./actions/ext/ls')
 program.command('ls')
-  .description('print all .env files in a tree structure')
+  .description('DEPRECATED: moved to [dotenvx ext ls]')
   .argument('[directory]', 'directory to list .env files from', '.')
   .option('-f, --env-file <filenames...>', 'path(s) to your env file(s)', '.env*')
-  .action(require('./actions/ls'))
+  .action(function (...args) {
+    logger.warn('DEPRECATION NOTICE: [ls] has moved to [dotenvx ext ls]')
 
-// dotenvx genexample
+    lsAction.apply(this, args)
+  })
+
+const genexampleAction = require('./actions/ext/genexample')
 program.command('genexample')
-  .description('generate .env.example')
+  .description('DEPRECATED: moved to [dotenvx ext genexample]')
   .argument('[directory]', 'directory to generate from', '.')
   .option('-f, --env-file <paths...>', 'path(s) to your env file(s)', '.env')
-  .action(require('./actions/genexample'))
+  .action(function (...args) {
+    logger.warn('DEPRECATION NOTICE: [genexample] has moved to [dotenvx ext genexample]')
+
+    genexampleAction.apply(this, args)
+  })
 
 // dotenvx gitignore
+const gitignoreAction = require('./actions/ext/gitignore')
 program.command('gitignore')
-  .description('append to .gitignore file (and if existing, .dockerignore, .npmignore, and .vercelignore)')
+  .description('DEPRECATED: moved to [dotenvx ext gitignore]')
   .addHelpText('after', examples.gitignore)
-  .action(require('./actions/gitignore'))
+  .action(function (...args) {
+    logger.warn('DEPRECATION NOTICE: [gitignore] has moved to [dotenvx ext gitignore]')
+
+    gitignoreAction.apply(this, args)
+  })
 
 // dotenvx prebuild
+const prebuildAction = require('./actions/ext/prebuild')
 program.command('prebuild')
-  .description('prevent including .env files in docker builds')
+  .description('DEPRECATED: moved to [dotenvx ext prebuild]')
   .addHelpText('after', examples.prebuild)
-  .action(require('./actions/prebuild'))
+  .action(function (...args) {
+    logger.warn('DEPRECATION NOTICE: [prebuild] has moved to [dotenvx ext prebuild]')
+
+    prebuildAction.apply(this, args)
+  })
 
 // dotenvx precommit
+const precommitAction = require('./actions/ext/precommit')
 program.command('precommit')
-  .description('prevent committing .env files to code')
+  .description('DEPRECATED: moved to [dotenvx ext precommit]')
   .addHelpText('after', examples.precommit)
   .option('-i, --install', 'install to .git/hooks/pre-commit')
-  .action(require('./actions/precommit'))
-
-// dotenvx scan
-program.command('scan')
-  .description('scan for leaked secrets')
-  .action(require('./actions/scan'))
-
-// dotenvx settings
-program.command('settings')
-  .description('print current dotenvx settings')
-  .argument('[key]', 'settings name')
-  .option('-pp, --pretty-print', 'pretty print output')
-  .action(require('./actions/settings'))
-
-// dotenvx vault
-program.addCommand(require('./commands/vault'))
-
-// dotenvx encrypt
-const encryptAction = require('./actions/vault/encrypt')
-program.command('encrypt')
-  .description('DEPRECATED: moved to [dotenvx vault encrypt]')
-  .addHelpText('after', examples.encrypt)
-  .argument('[directory]', 'directory to encrypt', '.')
-  .option('-f, --env-file <paths...>', 'path(s) to your env file(s)')
   .action(function (...args) {
-    logger.warn('DEPRECATION NOTICE: [dotenvx encrypt] has moved. change your command to [dotenvx vault encrypt]')
-    logger.warn('DEPRECATION NOTICE: [dotenvx encryptme] will become [dotenvx encrypt] in a 1.0.0 release scheduled for middle of June 2024.')
+    logger.warn('DEPRECATION NOTICE: [precommit] has moved to [dotenvx ext precommit]')
 
-    encryptAction.apply(this, args)
+    precommitAction.apply(this, args)
   })
 
-// dotenvx decrypt
-const decryptAction = require('./actions/vault/decrypt')
-program.command('decrypt')
-  .description('DEPRECATED: moved to [dotenvx vault decrypt]')
-  .argument('[directory]', 'directory to decrypt', '.')
-  .option('-e, --environment <environments...>', 'environment(s) to decrypt')
+// dotenvx scan
+const scanAction = require('./actions/ext/scan')
+program.command('scan')
+  .description('DEPRECATED: moved to [dotenvx ext scan]')
   .action(function (...args) {
-    logger.warn('DEPRECATION NOTICE: [dotenvx decrypt] has moved. change your command to [dotenvx vault decrypt]')
+    logger.warn('DEPRECATION NOTICE: [scan] has moved to [dotenvx ext scan]')
 
-    decryptAction.apply(this, args)
+    scanAction.apply(this, args)
   })
 
-// dotenvx status
-const statusAction = require('./actions/vault/status')
-program.command('status')
-  .description('DEPRECATED: moved to [dotenvx vault status]')
-  .argument('[directory]', 'directory to check status against', '.')
-  .action(function (...args) {
-    logger.warn('DEPRECATION NOTICE: [dotenvx status] has moved. change your command to [dotenvx vault status]')
+// overide helpInformation to hide DEPRECATED commands
+program.helpInformation = function () {
+  const originalHelp = Command.prototype.helpInformation.call(this)
+  const lines = originalHelp.split('\n')
 
-    statusAction.apply(this, args)
-  })
+  // Filter out the hidden command from the help output
+  const filteredLines = lines.filter(line => !line.includes('DEPRECATED'))
 
-// dotenvx hub
-program.addCommand(require('./commands/hub'))
+  return filteredLines.join('\n')
+}
 
 program.parse(process.argv)

package/src/cli/examples.js

@@ -22,12 +22,12 @@ Try it:
   `
 }
 
-const encrypt = function () {
+const vaultEncrypt = function () {
   return `
 Examples:
 
   \`\`\`
-  $ dotenvx encrypt
+  $ dotenvx ext vault encrypt
   \`\`\`
 
 Try it:
@@ -37,7 +37,7 @@ Try it:
   $ echo "HELLO=production" > .env.production
   $ echo "console.log('Hello ' + process.env.HELLO)" > index.js
 
-  $ dotenvx encrypt
+  $ dotenvx ext vault encrypt
   encrypted to .env.vault (.env,.env.production)
   keys added to .env.keys (DOTENV_KEY_PRODUCTION,DOTENV_KEY_PRODUCTION)
 
@@ -53,15 +53,15 @@ const precommit = function () {
 Examples:
 
   \`\`\`
-  $ dotenvx precommit
-  $ dotenvx precommit --install
+  $ dotenvx ext precommit
+  $ dotenvx ext precommit --install
   \`\`\`
 
 Try it:
 
   \`\`\`
-  $ dotenvx precommit
-  [dotenvx@0.10.0][precommit] success
+  $ dotenvx ext precommit
+  [dotenvx@0.45.0][precommit] success
   \`\`\`
   `
 }
@@ -71,13 +71,13 @@ const prebuild = function () {
 Examples:
 
   \`\`\`
-  $ dotenvx prebuild
+  $ dotenvx ext prebuild
   \`\`\`
 
 Try it:
 
   \`\`\`
-  $ dotenvx prebuild
+  $ dotenvx ext prebuild
   [dotenvx@0.10.0][prebuild] success
   \`\`\`
   `
@@ -88,13 +88,13 @@ const gitignore = function () {
 Examples:
 
   \`\`\`
-  $ dotenvx gitignore
+  $ dotenvx ext gitignore
   \`\`\`
 
 Try it:
 
   \`\`\`
-  $ dotenvx gitignore
+  $ dotenvx ext gitignore
   done
   \`\`\`
   `
@@ -102,7 +102,7 @@ Try it:
 
 module.exports = {
   run,
-  encrypt,
+  vaultEncrypt,
   precommit,
   prebuild,
   gitignore

package/src/cli/pro.txt

@@ -0,0 +1,22 @@
+_______________________________________________________________
+|                                                             |
+|  coming soon! (for small business)                          |
+|                                                             |
+|      | |     | |                                            |
+|    __| | ___ | |_ ___ _ ____   ____  __  _ __  _ __ ___     |
+|   / _` |/ _ \| __/ _ \ '_ \ \ / /\ \/ / | '_ \| '__/ _ \    |
+|  | (_| | (_) | ||  __/ | | \ V /  >  <  | |_) | | | (_) |   |
+|   \__,_|\___/ \__\___|_| |_|\_/  /_/\_\ | .__/|_|  \___/    |
+|                                         | |                 |
+|                                         |_|                 |
+| ## learn more on github 🐙                                  |
+|                                                             |
+| >> https://github.com/dotenvx/dotenvx/issues/259            |
+|                                                             |
+| ## subscribe on github to be notified 📣                    |
+|                                                             |
+| >> https://github.com/dotenvx/dotenvx/issues/259            |
+|                                                             |
+| ----------------------------------------------------------- |
+| - thank you for using dotenvx! - @motdotla                  |
+|_____________________________________________________________|

package/src/lib/helpers/installPrecommitHook.js

@@ -11,7 +11,7 @@ then
   exit 1
 fi
 
-dotenvx precommit`
+dotenvx ext precommit`
 
 class InstallPrecommitHook {
   constructor () {
@@ -25,16 +25,16 @@ class InstallPrecommitHook {
       // Check if the pre-commit file already exists
       if (this._exists()) {
         // Check if 'dotenvx precommit' already exists in the file
-        if (this._currentHook().includes('dotenvx precommit')) {
+        if (this._currentHook().includes('dotenvx ext precommit')) {
           // do nothing
-          successMessage = `dotenvx precommit exists [${this.hookPath}]`
+          successMessage = `dotenvx ext precommit exists [${this.hookPath}]`
         } else {
           this._appendHook()
-          successMessage = `dotenvx precommit appended [${this.hookPath}]`
+          successMessage = `dotenvx ext precommit appended [${this.hookPath}]`
         }
       } else {
         this._createHook()
-        successMessage = `dotenvx precommit installed [${this.hookPath}]`
+        successMessage = `dotenvx ext precommit installed [${this.hookPath}]`
       }
 
       return {

package/src/lib/main.js

@@ -134,11 +134,6 @@ const parse = function (src) {
   return dotenv.parse(src)
 }
 
-// DEPRECATED: will became the same function as convert
-const encrypt = function (directory, envFile) {
-  return new VaultEncrypt(directory, envFile).run()
-}
-
 const vaultEncrypt = function (directory, envFile) {
   return new VaultEncrypt(directory, envFile).run()
 }
@@ -159,7 +154,7 @@ const set = function (key, value, envFile, encrypt) {
   return new Sets(key, value, envFile, encrypt).run()
 }
 
-const convert = function (envFile) {
+const encrypt = function (envFile) {
   return new Encrypt(envFile).run()
 }
 
@@ -201,7 +196,6 @@ module.exports = {
   ls,
   get,
   set,
-  convert,
   status,
   genexample,
   // settings

package/src/lib/services/precommit.js

@@ -56,7 +56,7 @@ class Precommit {
             // if contents are encrypted don't raise an error
             if (!encrypted) {
               const error = new Error(`${file} not encrypted (or not gitignored)`)
-              error.help = `? encrypt it with [dotenvx protect -f ${file}] or add ${file} to .gitignore with [echo ".env*" >> .gitignore]`
+              error.help = `? encrypt it with [dotenvx encrypt -f ${file}] or add ${file} to .gitignore with [echo ".env*" >> .gitignore]`
               throw error
             }
           }

package/src/lib/services/sets.js

@@ -11,7 +11,7 @@ const replace = require('./../helpers/replace')
 const ENCODING = 'utf8'
 
 class Sets {
-  constructor (key, value, envFile = '.env', encrypt = false) {
+  constructor (key, value, envFile = '.env', encrypt = true) {
     this.key = key
     this.value = value
     this.envFile = envFile

package/src/lib/services/vaultEncrypt.js

@@ -22,7 +22,7 @@ class VaultEncrypt {
     if (this.envFile.length < 1) {
       const code = 'MISSING_ENV_FILES'
       const message = 'no .env* files found'
-      const help = '? add one with [echo "HELLO=World" > .env] and then run [dotenvx vault encrypt]'
+      const help = '? add one with [echo "HELLO=World" > .env] and then run [dotenvx ext vault encrypt]'
 
       const error = new Error(message)
       error.code = code
@@ -41,7 +41,7 @@ class VaultEncrypt {
       if (!fs.existsSync(filepath)) {
         const code = 'MISSING_ENV_FILE'
         const message = `file does not exist at [${filepath}]`
-        const help = `? add it with [echo "HELLO=World" > ${envFilepath}] and then run [dotenvx vault encrypt]`
+        const help = `? add it with [echo "HELLO=World" > ${envFilepath}] and then run [dotenvx ext vault encrypt]`
 
         const error = new Error(message)
         error.code = code