@karmaniverous/get-dotenv 4.4.0 → 4.4.2

package/README.md

@@ -113,7 +113,7 @@ You can also use `getdotenv` from the command line:
 # Options:
 #   -e, --env <string>                  target environment (dotenv-expanded)
 #   -v, --vars <string>                 extra variables expressed as delimited key-value pairs (dotenv-expanded): KEY1=VAL1 KEY2=VAL2
-#   -c, --command <string>              shell command string, conflicts with cmd subcommand (dotenv-expanded)
+#   -c, --command <string>              command executed according to the --shell option, conflicts with cmd subcommand (dotenv-expanded)
 #   -o, --output-path <string>          consolidated output file  (dotenv-expanded)
 #   -s, --shell [string]                command execution shell, no argument for default OS shell or provide shell string (default OS shell)
 #   -S, --shell-off                     command execution shell OFF
@@ -150,11 +150,11 @@ You can also use `getdotenv` from the command line:
 #
 # Commands:
 #   batch [options]                     Batch shell commands across multiple working directories.
-#   cmd                                 execute shell command, conflicts with --command option (default command)
+#   cmd                                 batch execute command according to the --shell option, conflicts with --command option (default command)
 #   help [command]                      display help for command
 ```
 
-By default, commands (`-c` or `--command` or the `cmd` subcommand) execute in the default OS shell with the `dotenv` context applied. The `-S` or `--shell-off` options will turn this off, and Execa will [execute your command as Javascript](https://github.com/sindresorhus/execa/blob/main/docs/bash.md).
+By default, commands (`-c` or `--command` or the `cmd` subcommand either in the base CLI or in the `batch` subcommand) execute in the default OS shell with the `dotenv` context applied. The `-S` or `--shell-off` options will turn this off, and Execa will [execute your command as Javascript](https://github.com/sindresorhus/execa/blob/main/docs/bash.md).
 
 Alternatively, you can use the `-s` or `--shell` option to specify a different shell [following the Execa spec](https://github.com/sindresorhus/execa/blob/main/docs/shell.md). This is useful if you're running a command that requires a specific shell, like `bash` or `zsh`.
 
@@ -181,19 +181,19 @@ Lest you doubt what that kind of leverage can do for you, consider this:
 
 # Usage: getdotenv batch [options] [command]
 #
-# Batch shell commands across multiple working directories.
+# Batch command execution across multiple working directories.
 #
 # Options:
 #   -p, --pkg-cwd             use nearest package directory as current working directory
 #   -r, --root-path <string>  path to batch root directory from current working directory (default: "./")
-#   -g, --globs <strings...>  space-delimited globs from root path (default: "*")
-#   -c, --command <string>    shell command string, conflicts with cmd subcommand (dotenv-expanded)
+#   -g, --globs <string>      space-delimited globs from root path (default: "*")
+#   -c, --command <string>    command executed according to the base --shell option, conflicts with cmd subcommand (dotenv-expanded)
 #   -l, --list                list working directories without executing command
 #   -e, --ignore-errors       ignore errors and continue with next path
 #   -h, --help                display help for command
 #
 # Commands:
-#   cmd                       batch execute shell command, conflicts with --command option (default command)
+#   cmd                       execute command, conflicts with --command option (default subcommand)
 #   help [command]            display help for command
 ```
 

package/dist/getdotenv.cli.mjs

@@ -31745,7 +31745,9 @@ const getDotenv = async (options = {}) => {
 const resolveCommand = (scripts, command) => (scripts && _.isObject(scripts[command])
     ? scripts[command].cmd
     : scripts?.[command] ?? command);
-const resolveShell = (scripts, command, shell) => (scripts && _.isObject(scripts[command]) ? scripts[command].shell : shell);
+const resolveShell = (scripts, command, shell) => scripts && _.isObject(scripts[command])
+    ? scripts[command].shell
+    : shell;
 
 /*
  * merge2
@@ -39500,8 +39502,8 @@ const execShellCommandBatch = async ({ command, getDotenvCliOptions, globs, igno
         rootPath,
     });
     const headerTitle = list
-        ? 'Listing shell command working directories...'
-        : 'Executing shell command batch...';
+        ? 'Listing working directories...'
+        : 'Executing command batch...';
     logger.info('');
     const headerRootPath = `ROOT:  ${absRootPath}`;
     const headerGlobs = `GLOBS: ${globs}`;
@@ -39523,7 +39525,7 @@ const execShellCommandBatch = async ({ command, getDotenvCliOptions, globs, igno
         logger.info('*'.repeat(pathLabel.length));
         logger.info(pathLabel);
         logger.info(headerCommand);
-        // Execute shell command.
+        // Execute command.
         try {
             await execaCommand(command, {
                 cwd: path,
@@ -39547,7 +39549,7 @@ const execShellCommandBatch = async ({ command, getDotenvCliOptions, globs, igno
 
 const cmdCommand$1 = new Command()
     .name('cmd')
-    .description('execute shell command, conflicts with --command option (default command)')
+    .description('execute command, conflicts with --command option (default subcommand)')
     .enablePositionalOptions()
     .passThroughOptions()
     .action(async (options, thisCommand) => {
@@ -39557,7 +39559,7 @@ const cmdCommand$1 = new Command()
         throw new Error(`unable to resolve root command`);
     const { getDotenvCliOptions: { logger = console, ...getDotenvCliOptions }, } = thisCommand.parent.parent;
     const { ignoreErrors, globs, list, pkgCwd, rootPath } = thisCommand.parent.opts();
-    // Execute shell command.
+    // Execute command.
     {
         const command = thisCommand.args.join(' ');
         await execShellCommandBatch({
@@ -39576,13 +39578,13 @@ const cmdCommand$1 = new Command()
 
 const batchCommand = new Command()
     .name('batch')
-    .description('Batch shell commands across multiple working directories.')
+    .description('Batch command execution across multiple working directories.')
     .enablePositionalOptions()
     .passThroughOptions()
     .option('-p, --pkg-cwd', 'use nearest package directory as current working directory')
     .option('-r, --root-path <string>', 'path to batch root directory from current working directory', './')
     .option('-g, --globs <string>', 'space-delimited globs from root path', '*')
-    .option('-c, --command <string>', 'command string executed according to the base --shell option, conflicts with cmd subcommand (dotenv-expanded)', dotenvExpandFromProcessEnv)
+    .option('-c, --command <string>', 'command executed according to the base --shell option, conflicts with cmd subcommand (dotenv-expanded)', dotenvExpandFromProcessEnv)
     .option('-l, --list', 'list working directories without executing command')
     .option('-e, --ignore-errors', 'ignore errors and continue with next path')
     .hook('preSubcommand', async (thisCommand) => {
@@ -39594,7 +39596,7 @@ const batchCommand = new Command()
         logger.error(`--command option conflicts with cmd subcommand.`);
         process.exit(0);
     }
-    // Execute shell command.
+    // Execute command.
     if (command)
         await execShellCommandBatch({
             command: resolveCommand(getDotenvCliOptions.scripts, command),
@@ -39612,7 +39614,7 @@ const batchCommand = new Command()
 
 const cmdCommand = new Command()
     .name('cmd')
-    .description('batch execute command string according to the --shell option, conflicts with --command option (default command)')
+    .description('batch execute command according to the --shell option, conflicts with --command option (default subcommand)')
     .configureHelp({ showGlobalOptions: true })
     .enablePositionalOptions()
     .passThroughOptions()
@@ -39693,7 +39695,7 @@ const generateGetDotenvCli = async (customOptions) => {
     ]
         .map((v) => v.join(varsAssignor))
         .join(varsDelimiter)}`, dotenvExpandFromProcessEnv)
-        .option('-c, --command <string>', 'command string executed according to the --shell option, conflicts with cmd subcommand (dotenv-expanded)', dotenvExpandFromProcessEnv)
+        .option('-c, --command <string>', 'command executed according to the --shell option, conflicts with cmd subcommand (dotenv-expanded)', dotenvExpandFromProcessEnv)
         .option('-o, --output-path <string>', 'consolidated output file  (dotenv-expanded)', dotenvExpandFromProcessEnv, outputPath)
         .addOption(new Option('-s, --shell [string]', `command execution shell, no argument for default OS shell or provide shell string${shell ? ` (default ${_.isBoolean(shell) ? 'OS shell' : shell})` : ''}`).conflicts('shellOff'))
         .addOption(new Option('-S, --shell-off', `command execution shell OFF${!shell ? ' (default)' : ''}`).conflicts('shell'))
@@ -39784,7 +39786,7 @@ const generateGetDotenvCli = async (customOptions) => {
         // Execute post-hook.
         if (postHook)
             await postHook(dotenv);
-        // Execute shell command.
+        // Execute command.
         if (command && thisCommand.args.length) {
             logger.error(`--command option conflicts with cmd subcommand.`);
             process.exit(0);

package/dist/index.cjs

@@ -31746,7 +31746,9 @@ const getDotenv = async (options = {}) => {
 const resolveCommand = (scripts, command) => (scripts && _.isObject(scripts[command])
     ? scripts[command].cmd
     : scripts?.[command] ?? command);
-const resolveShell = (scripts, command, shell) => (scripts && _.isObject(scripts[command]) ? scripts[command].shell : shell);
+const resolveShell = (scripts, command, shell) => scripts && _.isObject(scripts[command])
+    ? scripts[command].shell
+    : shell;
 
 /*
  * merge2
@@ -39501,8 +39503,8 @@ const execShellCommandBatch = async ({ command, getDotenvCliOptions, globs, igno
         rootPath,
     });
     const headerTitle = list
-        ? 'Listing shell command working directories...'
-        : 'Executing shell command batch...';
+        ? 'Listing working directories...'
+        : 'Executing command batch...';
     logger.info('');
     const headerRootPath = `ROOT:  ${absRootPath}`;
     const headerGlobs = `GLOBS: ${globs}`;
@@ -39524,7 +39526,7 @@ const execShellCommandBatch = async ({ command, getDotenvCliOptions, globs, igno
         logger.info('*'.repeat(pathLabel.length));
         logger.info(pathLabel);
         logger.info(headerCommand);
-        // Execute shell command.
+        // Execute command.
         try {
             await execaCommand(command, {
                 cwd: path,
@@ -39548,7 +39550,7 @@ const execShellCommandBatch = async ({ command, getDotenvCliOptions, globs, igno
 
 const cmdCommand$1 = new Command()
     .name('cmd')
-    .description('execute shell command, conflicts with --command option (default command)')
+    .description('execute command, conflicts with --command option (default subcommand)')
     .enablePositionalOptions()
     .passThroughOptions()
     .action(async (options, thisCommand) => {
@@ -39558,7 +39560,7 @@ const cmdCommand$1 = new Command()
         throw new Error(`unable to resolve root command`);
     const { getDotenvCliOptions: { logger = console, ...getDotenvCliOptions }, } = thisCommand.parent.parent;
     const { ignoreErrors, globs, list, pkgCwd, rootPath } = thisCommand.parent.opts();
-    // Execute shell command.
+    // Execute command.
     {
         const command = thisCommand.args.join(' ');
         await execShellCommandBatch({
@@ -39577,13 +39579,13 @@ const cmdCommand$1 = new Command()
 
 const batchCommand = new Command()
     .name('batch')
-    .description('Batch shell commands across multiple working directories.')
+    .description('Batch command execution across multiple working directories.')
     .enablePositionalOptions()
     .passThroughOptions()
     .option('-p, --pkg-cwd', 'use nearest package directory as current working directory')
     .option('-r, --root-path <string>', 'path to batch root directory from current working directory', './')
     .option('-g, --globs <string>', 'space-delimited globs from root path', '*')
-    .option('-c, --command <string>', 'command string executed according to the base --shell option, conflicts with cmd subcommand (dotenv-expanded)', dotenvExpandFromProcessEnv)
+    .option('-c, --command <string>', 'command executed according to the base --shell option, conflicts with cmd subcommand (dotenv-expanded)', dotenvExpandFromProcessEnv)
     .option('-l, --list', 'list working directories without executing command')
     .option('-e, --ignore-errors', 'ignore errors and continue with next path')
     .hook('preSubcommand', async (thisCommand) => {
@@ -39595,7 +39597,7 @@ const batchCommand = new Command()
         logger.error(`--command option conflicts with cmd subcommand.`);
         process.exit(0);
     }
-    // Execute shell command.
+    // Execute command.
     if (command)
         await execShellCommandBatch({
             command: resolveCommand(getDotenvCliOptions.scripts, command),
@@ -39613,7 +39615,7 @@ const batchCommand = new Command()
 
 const cmdCommand = new Command()
     .name('cmd')
-    .description('batch execute command string according to the --shell option, conflicts with --command option (default command)')
+    .description('batch execute command according to the --shell option, conflicts with --command option (default subcommand)')
     .configureHelp({ showGlobalOptions: true })
     .enablePositionalOptions()
     .passThroughOptions()
@@ -39694,7 +39696,7 @@ const generateGetDotenvCli = async (customOptions) => {
     ]
         .map((v) => v.join(varsAssignor))
         .join(varsDelimiter)}`, dotenvExpandFromProcessEnv)
-        .option('-c, --command <string>', 'command string executed according to the --shell option, conflicts with cmd subcommand (dotenv-expanded)', dotenvExpandFromProcessEnv)
+        .option('-c, --command <string>', 'command executed according to the --shell option, conflicts with cmd subcommand (dotenv-expanded)', dotenvExpandFromProcessEnv)
         .option('-o, --output-path <string>', 'consolidated output file  (dotenv-expanded)', dotenvExpandFromProcessEnv, outputPath)
         .addOption(new Option('-s, --shell [string]', `command execution shell, no argument for default OS shell or provide shell string${shell ? ` (default ${_.isBoolean(shell) ? 'OS shell' : shell})` : ''}`).conflicts('shellOff'))
         .addOption(new Option('-S, --shell-off', `command execution shell OFF${!shell ? ' (default)' : ''}`).conflicts('shell'))
@@ -39785,7 +39787,7 @@ const generateGetDotenvCli = async (customOptions) => {
         // Execute post-hook.
         if (postHook)
             await postHook(dotenv);
-        // Execute shell command.
+        // Execute command.
         if (command && thisCommand.args.length) {
             logger.error(`--command option conflicts with cmd subcommand.`);
             process.exit(0);

package/dist/index.mjs

@@ -31744,7 +31744,9 @@ const getDotenv = async (options = {}) => {
 const resolveCommand = (scripts, command) => (scripts && _.isObject(scripts[command])
     ? scripts[command].cmd
     : scripts?.[command] ?? command);
-const resolveShell = (scripts, command, shell) => (scripts && _.isObject(scripts[command]) ? scripts[command].shell : shell);
+const resolveShell = (scripts, command, shell) => scripts && _.isObject(scripts[command])
+    ? scripts[command].shell
+    : shell;
 
 /*
  * merge2
@@ -39499,8 +39501,8 @@ const execShellCommandBatch = async ({ command, getDotenvCliOptions, globs, igno
         rootPath,
     });
     const headerTitle = list
-        ? 'Listing shell command working directories...'
-        : 'Executing shell command batch...';
+        ? 'Listing working directories...'
+        : 'Executing command batch...';
     logger.info('');
     const headerRootPath = `ROOT:  ${absRootPath}`;
     const headerGlobs = `GLOBS: ${globs}`;
@@ -39522,7 +39524,7 @@ const execShellCommandBatch = async ({ command, getDotenvCliOptions, globs, igno
         logger.info('*'.repeat(pathLabel.length));
         logger.info(pathLabel);
         logger.info(headerCommand);
-        // Execute shell command.
+        // Execute command.
         try {
             await execaCommand(command, {
                 cwd: path,
@@ -39546,7 +39548,7 @@ const execShellCommandBatch = async ({ command, getDotenvCliOptions, globs, igno
 
 const cmdCommand$1 = new Command()
     .name('cmd')
-    .description('execute shell command, conflicts with --command option (default command)')
+    .description('execute command, conflicts with --command option (default subcommand)')
     .enablePositionalOptions()
     .passThroughOptions()
     .action(async (options, thisCommand) => {
@@ -39556,7 +39558,7 @@ const cmdCommand$1 = new Command()
         throw new Error(`unable to resolve root command`);
     const { getDotenvCliOptions: { logger = console, ...getDotenvCliOptions }, } = thisCommand.parent.parent;
     const { ignoreErrors, globs, list, pkgCwd, rootPath } = thisCommand.parent.opts();
-    // Execute shell command.
+    // Execute command.
     {
         const command = thisCommand.args.join(' ');
         await execShellCommandBatch({
@@ -39575,13 +39577,13 @@ const cmdCommand$1 = new Command()
 
 const batchCommand = new Command()
     .name('batch')
-    .description('Batch shell commands across multiple working directories.')
+    .description('Batch command execution across multiple working directories.')
     .enablePositionalOptions()
     .passThroughOptions()
     .option('-p, --pkg-cwd', 'use nearest package directory as current working directory')
     .option('-r, --root-path <string>', 'path to batch root directory from current working directory', './')
     .option('-g, --globs <string>', 'space-delimited globs from root path', '*')
-    .option('-c, --command <string>', 'command string executed according to the base --shell option, conflicts with cmd subcommand (dotenv-expanded)', dotenvExpandFromProcessEnv)
+    .option('-c, --command <string>', 'command executed according to the base --shell option, conflicts with cmd subcommand (dotenv-expanded)', dotenvExpandFromProcessEnv)
     .option('-l, --list', 'list working directories without executing command')
     .option('-e, --ignore-errors', 'ignore errors and continue with next path')
     .hook('preSubcommand', async (thisCommand) => {
@@ -39593,7 +39595,7 @@ const batchCommand = new Command()
         logger.error(`--command option conflicts with cmd subcommand.`);
         process.exit(0);
     }
-    // Execute shell command.
+    // Execute command.
     if (command)
         await execShellCommandBatch({
             command: resolveCommand(getDotenvCliOptions.scripts, command),
@@ -39611,7 +39613,7 @@ const batchCommand = new Command()
 
 const cmdCommand = new Command()
     .name('cmd')
-    .description('batch execute command string according to the --shell option, conflicts with --command option (default command)')
+    .description('batch execute command according to the --shell option, conflicts with --command option (default subcommand)')
     .configureHelp({ showGlobalOptions: true })
     .enablePositionalOptions()
     .passThroughOptions()
@@ -39692,7 +39694,7 @@ const generateGetDotenvCli = async (customOptions) => {
     ]
         .map((v) => v.join(varsAssignor))
         .join(varsDelimiter)}`, dotenvExpandFromProcessEnv)
-        .option('-c, --command <string>', 'command string executed according to the --shell option, conflicts with cmd subcommand (dotenv-expanded)', dotenvExpandFromProcessEnv)
+        .option('-c, --command <string>', 'command executed according to the --shell option, conflicts with cmd subcommand (dotenv-expanded)', dotenvExpandFromProcessEnv)
         .option('-o, --output-path <string>', 'consolidated output file  (dotenv-expanded)', dotenvExpandFromProcessEnv, outputPath)
         .addOption(new Option('-s, --shell [string]', `command execution shell, no argument for default OS shell or provide shell string${shell ? ` (default ${_.isBoolean(shell) ? 'OS shell' : shell})` : ''}`).conflicts('shellOff'))
         .addOption(new Option('-S, --shell-off', `command execution shell OFF${!shell ? ' (default)' : ''}`).conflicts('shell'))
@@ -39783,7 +39785,7 @@ const generateGetDotenvCli = async (customOptions) => {
         // Execute post-hook.
         if (postHook)
             await postHook(dotenv);
-        // Execute shell command.
+        // Execute command.
         if (command && thisCommand.args.length) {
             logger.error(`--command option conflicts with cmd subcommand.`);
             process.exit(0);

package/package.json

@@ -132,5 +132,5 @@
   },
   "type": "module",
   "types": "dist/index.d.ts",
-  "version": "4.4.0"
+  "version": "4.4.2"
 }