@dotenvx/dotenvx 1.6.4 → 1.7.0

package/CHANGELOG.md

@@ -2,7 +2,19 @@
 
 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.6.4...main)
+## [Unreleased](https://github.com/dotenvx/dotenvx/compare/v1.7.0...main)
+
+## 1.7.0
+
+### Removed
+
+* remove `ext settings` command (and [`conf`](https://www.npmjs.com/package/conf) along with it) ([#323](https://github.com/dotenvx/dotenvx/pull/323))
+
+## 1.6.5
+
+### Changed
+
+* 🐞 patch `chomp` for interpolation. strip ending newline (was stripping first found newline) ([#322](https://github.com/dotenvx/dotenvx/pull/322))
 
 ## 1.6.4
 

package/README.md

@@ -267,6 +267,16 @@ More examples
   Hello World
   ```
 
+  </details>
+* <details><summary>Fish 🐠</summary><br>
+
+  ```sh
+  $ echo "HELLO=World" > .env
+
+  $ dotenvx run --quiet -- sh -c 'echo Hello $HELLO'
+  Hello World
+  ```
+
   </details>
 * <details><summary>Cron ⏰</summary><br>
 

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.6.4",
+  "version": "1.7.0",
   "name": "@dotenvx/dotenvx",
   "description": "a better dotenv–from the creator of `dotenv`",
   "author": "@motdotla",
@@ -38,7 +38,6 @@
   "dependencies": {
     "chalk": "^4.1.2",
     "commander": "^11.1.0",
-    "conf": "^10.2.0",
     "diff": "^5.2.0",
     "dotenv": "^16.4.5",
     "eciesjs": "^0.4.6",

package/src/cli/commands/ext.js

@@ -57,13 +57,6 @@ 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'))
 
 module.exports = ext

package/src/cli/dotenvx.js

@@ -108,13 +108,32 @@ const decryptAction = require('./actions/decrypt')
 program.command('decrypt')
   .description('convert encrypted .env file(s) to plain .env file(s)')
   .option('-f, --env-file <paths...>', 'path(s) to your env file(s)')
-  .option('-k, --key <keys...>', 'keys(s) to encrypt (default: all keys in file)')
+  .option('-k, --key <keys...>', 'keys(s) to decrypt (default: all keys in file)')
   .option('--stdout', 'send to stdout')
   .action(decryptAction)
 
+// dotenvx help
+program.command('help [command]')
+  .description('display help for command')
+  .action((command) => {
+    if (command) {
+      const subCommand = program.commands.find(c => c.name() === command)
+      if (subCommand) {
+        subCommand.outputHelp()
+      } else {
+        program.outputHelp()
+      }
+    } else {
+      program.outputHelp()
+    }
+  })
+
 // dotenvx ext
 program.addCommand(require('./commands/ext'))
 
+//
+// DEPRECATED or MOVED
+//
 const lsAction = require('./actions/ext/ls')
 program.command('ls')
   .description('DEPRECATED: moved to [dotenvx ext ls]')
@@ -137,7 +156,6 @@ program.command('genexample')
     genexampleAction.apply(this, args)
   })
 
-// dotenvx gitignore
 const gitignoreAction = require('./actions/ext/gitignore')
 program.command('gitignore')
   .description('DEPRECATED: moved to [dotenvx ext gitignore]')
@@ -148,7 +166,6 @@ program.command('gitignore')
     gitignoreAction.apply(this, args)
   })
 
-// dotenvx prebuild
 const prebuildAction = require('./actions/ext/prebuild')
 program.command('prebuild')
   .description('DEPRECATED: moved to [dotenvx ext prebuild]')
@@ -159,7 +176,6 @@ program.command('prebuild')
     prebuildAction.apply(this, args)
   })
 
-// dotenvx precommit
 const precommitAction = require('./actions/ext/precommit')
 program.command('precommit')
   .description('DEPRECATED: moved to [dotenvx ext precommit]')
@@ -171,7 +187,6 @@ program.command('precommit')
     precommitAction.apply(this, args)
   })
 
-// dotenvx scan
 const scanAction = require('./actions/ext/scan')
 program.command('scan')
   .description('DEPRECATED: moved to [dotenvx ext scan]')
@@ -181,28 +196,13 @@ program.command('scan')
     scanAction.apply(this, args)
   })
 
-program.command('help [command]')
-  .description('display help for command')
-  .action((command) => {
-    if (command) {
-      const subCommand = program.commands.find(c => c.name() === command)
-      if (subCommand) {
-        subCommand.outputHelp()
-      } else {
-        program.outputHelp()
-      }
-    } else {
-      program.outputHelp()
-    }
-  })
-
 // overide helpInformation to hide DEPRECATED commands
 program.helpInformation = function () {
   const originalHelp = Command.prototype.helpInformation.call(this)
   const lines = originalHelp.split('\n')
 
   // Filter out the hidden command from the help output
-  const filteredLines = lines.filter(line => !line.includes('DEPRECATED'))
+  const filteredLines = lines.filter(line => !line.includes('DEPRECATED') && !line.includes('help [command]'))
 
   return filteredLines.join('\n')
 }

package/src/lib/helpers/dotenvEval.js

@@ -1,7 +1,7 @@
 const { execSync } = require('child_process')
 
 function _chomp (value) {
-  return value.replace(/\r?\n|\r/, '')
+  return value.replace(/[\r\n]+$/, '')
 }
 
 function interpolate (value, processEnv, parsed) {

package/src/lib/main.d.ts

@@ -289,21 +289,6 @@ export function genexample(
   envFile: string
 ): GenExampleOutput;
 
-export type Settings = {
-  DOTENVX_SETTINGS_FILEPATH: string;
-};
-
-type KeyOfSettings = Extract<keyof Settings, string>;
-
-/**
- * Get the dotenvx settings
- *
- * @param [key] - the key to get the value of
- */
-export function settings(
-  key: KeyOfSettings | undefined | null = null
-): Settings;
-
 /**
  * Decrypt ciphertext
  * @param encrypted - the encrypted ciphertext string

package/src/lib/main.js

@@ -12,7 +12,6 @@ const Status = require('./services/status')
 const Encrypt = require('./services/encrypt')
 const Decrypt = require('./services/decrypt')
 const Genexample = require('./services/genexample')
-const Settings = require('./services/settings')
 const VaultEncrypt = require('./services/vaultEncrypt')
 
 // helpers
@@ -204,12 +203,6 @@ const status = function (directory) {
   return new Status(directory).run()
 }
 
-/** @type {import('./main').settings} */
-const settings = function (key = null) {
-  // @ts-ignore
-  return new Settings(key).run()
-}
-
 // misc/cleanup
 
 /** @type {import('./main').vaultDecrypt} */
@@ -255,8 +248,6 @@ module.exports = {
   set,
   status,
   genexample,
-  // settings
-  settings,
   // misc/cleanup
   vaultEncrypt,
   vaultDecrypt

package/src/cli/actions/ext/settings.js

@@ -1,25 +0,0 @@
-const { logger } = require('./../../../shared/logger')
-
-const main = require('./../../../lib/main')
-
-function settings (key = null) {
-  logger.debug(`key: ${key}`)
-
-  const options = this.opts()
-  logger.debug(`options: ${JSON.stringify(options)}`)
-
-  const value = main.settings(key)
-
-  if (typeof value === 'object' && value !== null) {
-    let space = 0
-    if (options.prettyPrint) {
-      space = 2
-    }
-
-    process.stdout.write(JSON.stringify(value, null, space))
-  } else {
-    process.stdout.write(value)
-  }
-}
-
-module.exports = settings

package/src/lib/services/settings.js

@@ -1,28 +0,0 @@
-const store = require('./../../shared/store')
-
-class Settings {
-  constructor (key = null) {
-    this.key = key
-  }
-
-  run () {
-    const store = this._store()
-
-    if (this.key) {
-      return store[this.key]
-    }
-
-    // json of dotenvx.settings
-    return store
-  }
-
-  _store () {
-    const h = {
-      DOTENVX_SETTINGS_FILEPATH: store.configPath()
-    }
-
-    return { ...h, ...store.confStore.store }
-  }
-}
-
-module.exports = Settings

package/src/shared/store.js

@@ -1,146 +0,0 @@
-const Conf = require('conf')
-const dotenv = require('dotenv')
-const packageJson = require('./../lib/helpers/packageJson')
-
-function jsonToEnv (json) {
-  return Object.entries(json).map(function ([key, value]) {
-    return key + '=' + `"${value}"`
-  }).join('\n')
-}
-
-function convertFullUsernameToEnvFormat (fullUsername) {
-  // gh/motdotla => GH_MOTDOTLA_DOTENVX_TOKEN
-  return fullUsername
-    .toUpperCase()
-    .replace(/\//g, '_') // Replace all slashes with underscores
-    .concat('_DOTENVX_TOKEN') // Append '_DOTENVX_TOKEN' at the end
-}
-
-function findFirstMatchingKey (data) {
-  const dotenvxTokenValue = data.DOTENVX_TOKEN
-
-  for (const [key, value] of Object.entries(data)) {
-    if (key !== 'DOTENVX_TOKEN' && value === dotenvxTokenValue) {
-      return key
-    }
-  }
-
-  return null // Return null if no matching key is found
-}
-
-function parseUsernameFromTokenKey (key) {
-  // Remove the leading GH_/GL_ and trailing '_DOTENVX_TOKEN'
-  const modifiedKey = key.replace(/^(GH_|GL_)/, '').replace(/_DOTENVX_TOKEN$/, '')
-
-  // Convert to lowercase
-  return modifiedKey.toLowerCase()
-}
-
-const confStore = new Conf({
-  projectName: 'dotenvx',
-  configName: '.env',
-  // looks better on user's machine
-  // https://github.com/sindresorhus/conf/tree/v10.2.0#projectsuffix.
-  projectSuffix: '',
-  fileExtension: '',
-  // in the spirit of dotenv and format inherently puts limits on config complexity
-  serialize: function (json) {
-    return jsonToEnv(json)
-  },
-  // Convert .env format to an object
-  deserialize: function (env) {
-    return dotenv.parse(env)
-  }
-})
-
-const getHostname = function () {
-  return confStore.get('DOTENVX_HOSTNAME') || 'https://hub.dotenvx.com'
-}
-
-const getUsername = function () {
-  const key = findFirstMatchingKey(confStore.store)
-
-  if (key) {
-    return parseUsernameFromTokenKey(key)
-  } else {
-    return null
-  }
-}
-
-const getToken = function () {
-  return confStore.get('DOTENVX_TOKEN')
-}
-
-const getLatestVersion = function () {
-  return confStore.get('DOTENVX_LATEST_VERSION') || packageJson.version
-}
-
-const getLatestVersionLastChecked = function () {
-  return parseInt(confStore.get('DOTENVX_LATEST_VERSION_LAST_CHECKED') || 0)
-}
-
-const setToken = function (fullUsername, accessToken) {
-  // current logged in user
-  confStore.set('DOTENVX_TOKEN', accessToken)
-
-  // for future use to switch between accounts locally
-  const memory = convertFullUsernameToEnvFormat(fullUsername)
-  confStore.set(memory, accessToken)
-
-  return accessToken
-}
-
-const setHostname = function (hostname) {
-  confStore.set('DOTENVX_HOSTNAME', hostname)
-
-  return hostname
-}
-
-const setLatestVersion = function (version) {
-  confStore.set('DOTENVX_LATEST_VERSION', version)
-
-  return version
-}
-
-const setLatestVersionLastChecked = function (dateNow) {
-  confStore.set('DOTENVX_LATEST_VERSION_LAST_CHECKED', dateNow)
-
-  return dateNow
-}
-
-const deleteToken = function () {
-  // memory user
-  const key = findFirstMatchingKey(confStore.store) // GH_MOTDOTLA_DOTENVX_TOKEN
-  confStore.delete(key)
-
-  // current logged in user
-  confStore.delete('DOTENVX_TOKEN')
-
-  return true
-}
-
-const deleteHostname = function () {
-  confStore.delete('DOTENVX_HOSTNAME')
-
-  return true
-}
-
-const configPath = function () {
-  return confStore.path
-}
-
-module.exports = {
-  confStore,
-  getHostname,
-  getToken,
-  getUsername,
-  getLatestVersion,
-  getLatestVersionLastChecked,
-  setHostname,
-  setToken,
-  setLatestVersion,
-  setLatestVersionLastChecked,
-  deleteToken,
-  deleteHostname,
-  configPath
-}