@dotenvx/dotenvx 1.12.1 → 1.13.1

package/CHANGELOG.md

@@ -2,22 +2,42 @@
 
 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.12.1...main)
+## [Unreleased](https://github.com/dotenvx/dotenvx/compare/v1.13.1...main)
+
+## 1.13.1
+
+### Added
+
+* expose `logger` and `setLogLevel` to `lib/main.js` - `const = { logger, setLogLevel } = require('@dotenvx/dotenvx')` ([#368](https://github.com/dotenvx/dotenvx/pull/368))
+
+## 1.13.0
+
+### Changed
+
+* move `ls` to core commands ([#367](https://github.com/dotenvx/dotenvx/pull/367))
 
 ## 1.12.1
 
+### Changed
+
 * return without quotations for `dotenvx get --format shell` ([#366](https://github.com/dotenvx/dotenvx/pull/366))
 
 ## 1.12.0
 
+### Added
+
 * add `dotenvx get --format shell` option ([#363](https://github.com/dotenvx/dotenvx/pull/363))
 
 ## 1.11.5
 
+### Changed
+
 * revert `tinyexec` for `execa` - to support usage in bun
 
 ## 1.11.4
 
+### Changed
+
 * bump `tinyexec` and add postrelease-bunx check ([#362](https://github.com/dotenvx/dotenvx/pull/362))
 
 ## 1.11.3

package/README.md

@@ -1047,11 +1047,11 @@ More examples
   Return a shell formatted response of all key/value pairs in a `.env` file.
 
   ```sh
-  $ echo "HELLO=World\n" > .env
-  $ echo "KEY=value\n" >> .env
+  $ echo "HELLO=World" > .env
+  $ echo "KEY=value" >> .env
 
   $ dotenvx get --format shell
-  HELLO="World" KEY="value"
+  HELLO=World KEY=value
   ```
 
   This can be useful when combined with `env` on the command line.

package/package.json

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

package/src/cli/actions/{ext/ls.js → 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/commands/ext.js

@@ -2,6 +2,7 @@ const { Command } = require('commander')
 
 const examples = require('./../examples')
 const executeExtension = require('../../lib/helpers/executeExtension')
+const removeDynamicHelpSection = require('../../lib/helpers/removeDynamicHelpSection')
 
 const ext = new Command('ext')
 
@@ -26,7 +27,7 @@ ext.command('ls')
   .argument('[directory]', 'directory to list .env files from', '.')
   .option('-f, --env-file <filenames...>', 'path(s) to your env file(s)', '.env*')
   .option('-ef, --exclude-env-file <excludeFilenames...>', 'path(s) to exclude from your env file(s) (default: none)')
-  .action(require('./../actions/ext/ls'))
+  .action(require('./../actions/ls'))
 
 // dotenvx ext genexample
 ext.command('genexample')
@@ -59,4 +60,14 @@ ext.command('scan')
   .description('scan for leaked secrets')
   .action(require('./../actions/ext/scan'))
 
+// overide helpInformation to hide dynamic commands
+ext.helpInformation = function () {
+  const originalHelp = Command.prototype.helpInformation.call(this)
+  const lines = originalHelp.split('\n')
+
+  removeDynamicHelpSection(lines)
+
+  return lines.join('\n')
+}
+
 module.exports = ext

package/src/cli/dotenvx.js

@@ -8,6 +8,7 @@ const { setLogLevel, logger } = require('../shared/logger')
 const examples = require('./examples')
 const packageJson = require('./../lib/helpers/packageJson')
 const executeDynamic = require('./../lib/helpers/executeDynamic')
+const removeDynamicHelpSection = require('./../lib/helpers/removeDynamicHelpSection')
 
 // for use with run
 const envs = []
@@ -30,8 +31,7 @@ program
     setLogLevel(options)
   })
 
-program.addHelpText('after', '  pro                          🏆 pro\n')
-
+// for dynamic loading of dotenvx-pro, etc
 program
   .argument('[command]', 'dynamic command')
   .argument('[args...]', 'dynamic command arguments')
@@ -42,7 +42,7 @@ program
 
 // cli
 program
-  .name(packageJson.name)
+  .name('dotenvx')
   .description(packageJson.description)
   .version(packageJson.version)
   .allowUnknownOption()
@@ -115,6 +115,15 @@ program.command('decrypt')
   .option('--stdout', 'send to stdout')
   .action(decryptAction)
 
+// dotenvx ls
+const lsAction = require('./actions/ls')
+program.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*')
+  .option('-ef, --exclude-env-file <excludeFilenames...>', 'path(s) to exclude from your env file(s) (default: none)')
+  .action(lsAction)
+
 // dotenvx help
 program.command('help [command]')
   .description('display help for command')
@@ -131,6 +140,12 @@ program.command('help [command]')
     }
   })
 
+// dotenvx pro
+program.addHelpText('after', ' ')
+program.addHelpText('after', 'Advanced: ')
+program.addHelpText('after', '  pro                          🏆 pro')
+program.addHelpText('after', '  ext                          🔌 extensions')
+
 // dotenvx ext
 program.addCommand(require('./commands/ext'))
 
@@ -158,13 +173,19 @@ program.command('precommit')
     precommitAction.apply(this, args)
   })
 
-// overide helpInformation to hide DEPRECATED commands
+// overide helpInformation to hide DEPRECATED and 'ext' commands
 program.helpInformation = function () {
   const originalHelp = Command.prototype.helpInformation.call(this)
   const lines = originalHelp.split('\n')
 
+  removeDynamicHelpSection(lines)
+
   // Filter out the hidden command from the help output
-  const filteredLines = lines.filter(line => !line.includes('DEPRECATED') && !line.includes('help [command]'))
+  const filteredLines = lines.filter(line =>
+    !line.includes('DEPRECATED') &&
+    !line.includes('help [command]') &&
+    !line.includes('🔌 extensions')
+  )
 
   return filteredLines.join('\n')
 }

package/src/lib/helpers/executeExtension.js

@@ -5,7 +5,7 @@ const { logger } = require('../../shared/logger')
 function executeExtension (ext, command, rawArgs) {
   if (!command) {
     ext.outputHelp()
-    process.exit(1)
+    process.exit(0)
     return
   }
 

package/src/lib/helpers/removeDynamicHelpSection.js

@@ -0,0 +1,21 @@
+// Remove Arguments section from help text. example:
+// Arguments:
+// command     dynamic command
+// args        dynamic command arguments
+
+function removeDynamicHelpSection (lines) {
+  let argumentsHelpIndex
+  for (let i = 0; i < lines.length; i++) {
+    if (lines[i] === 'Arguments:') {
+      argumentsHelpIndex = i
+      break
+    }
+  }
+  if (argumentsHelpIndex) {
+    lines.splice(argumentsHelpIndex, 4) // remove Arguments and the following 3 lines
+  }
+
+  return lines
+}
+
+module.exports = removeDynamicHelpSection

package/src/lib/main.js

@@ -1,6 +1,6 @@
 // @ts-check
 const path = require('path')
-const { logger } = require('./../shared/logger')
+const { setLogLevel, logger } = require('./../shared/logger')
 const dotenv = require('dotenv')
 
 // services
@@ -15,7 +15,6 @@ const Genexample = require('./services/genexample')
 // helpers
 const conventions = require('./helpers/conventions')
 const dotenvOptionPaths = require('./helpers/dotenvOptionPaths')
-const { setLogLevel } = require('../shared/logger')
 
 // proxies to dotenv
 
@@ -219,5 +218,8 @@ module.exports = {
   ls,
   get,
   set,
-  genexample
+  genexample,
+  // expose for libs depending on @dotenvx/dotenvx
+  setLogLevel,
+  logger
 }