@automattic/vip 4.0.1 → 4.0.3

package/dist/bin/vip-dev-env-sync-sql.js

@@ -51,7 +51,7 @@ const appQuery = `
   requiredArgs: 0,
   module: 'dev-env-sync-sql',
   usage
-}).option('slug', 'A unique name for a local environment. Default is "vip-local".', undefined, _devEnvironmentCli.processSlug).option('table', 'The name of a table to include in the partial database sync. Accepts a string value and can be passed more than once with a different value, or add multiple values in a comma-separated list.').option('site-id', 'The ID of a network site to include in the partial database sync. Accepts an integer value (can be passed more than once with different values), or multiple integer values in a comma-separated list.').option('wpcli-command', 'Run a custom WP-CLI command that has logic to retrieve specific data for the partial database export.').option('config-file', 'A local configuration file that specifies the data to include in the partial database sync. Accepts a relative or absolute path to the file.', undefined).option('force', 'Skip validations.', undefined, _devEnvironmentCli.processBooleanOption).examples(examples).argv(process.argv, async (arg, opt) => {
+}).option('slug', 'A unique name for a local environment. Default is "vip-local".', undefined, _devEnvironmentCli.processSlug).option('table', 'The name of a table to include in the partial database sync. Accepts a string value and can be passed more than once with a different value, or add multiple values in a comma-separated list.').option('site-id', 'The ID of a network site to include in the partial database sync. Accepts an integer value (can be passed more than once with different values), or multiple integer values in a comma-separated list.', undefined, Number.parseInt).option('wpcli-command', 'Run a custom WP-CLI command that has logic to retrieve specific data for the partial database export.').option('config-file', 'A local configuration file that specifies the data to include in the partial database sync. Accepts a relative or absolute path to the file.', undefined).option('force', 'Skip validations.', undefined, _devEnvironmentCli.processBooleanOption).examples(examples).argv(process.argv, async (arg, opt) => {
   const {
     app,
     env,

package/dist/bin/vip-export-sql.js

@@ -55,7 +55,7 @@ const appQuery = `
   module: 'export-sql',
   requiredArgs: 0,
   usage: 'vip export sql'
-}).option('output', 'Download the file to a specific local directory path with a custom file name.').option('table', 'The name of a table to include in the partial database export. Accepts a string value and can be passed more than once with a different value, or add multiple values in a comma-separated list.').option('site-id', 'The ID of a network site to include in the partial database export. Accepts an integer value and can be passed more than once with a different value, or add multiple values in a comma-separated list.').option('wpcli-command', 'Run a custom WP-CLI command that has logic to retrieve specific data for the partial database export.').option('config-file', 'A local configuration file that specifies the data to include in the partial database export. Accepts a relative or absolute path to the file.', undefined).option('generate-backup', 'Generate a fresh database backup and export an archived copy of that backup.').option('skip-download', 'Skip downloading the file.').examples(examples).argv(process.argv, async (arg, {
+}).option('output', 'Download the file to a specific local directory path with a custom file name.').option('table', 'The name of a table to include in the partial database export. Accepts a string value and can be passed more than once with a different value, or add multiple values in a comma-separated list.').option('site-id', 'The ID of a network site to include in the partial database export. Accepts an integer value and can be passed more than once with a different value, or add multiple values in a comma-separated list.', undefined, Number.parseInt).option('wpcli-command', 'Run a custom WP-CLI command that has logic to retrieve specific data for the partial database export.').option('config-file', 'A local configuration file that specifies the data to include in the partial database export. Accepts a relative or absolute path to the file.', undefined).option('generate-backup', 'Generate a fresh database backup and export an archived copy of that backup.').option('skip-download', 'Skip downloading the file.').examples(examples).argv(process.argv, async (arg, {
   app,
   env,
   output,

package/dist/bin/vip-logs.js

@@ -218,7 +218,7 @@ const appQuery = exports.appQuery = `
   module: 'logs'
 }).option('type', 'Specify the type of Runtime Logs to retrieve. Accepts "batch" (only valid for WordPress environments).', 'app')
 // The default limit is set manually in the validateInputs function to address validation issues, avoiding incorrect replacement of the default value.
-.option('limit', `The maximum number of entries to return. Accepts an integer value between 1 and 5000 (defaults to ${LIMIT_DEFAULT}).`).option('follow', 'Output new entries as they are generated.').option('format', 'Render output in a particular format. Accepts “table“ (default), “csv“, “json“, and “text”.').examples([{
+.option('limit', `The maximum number of entries to return. Accepts an integer value between 1 and 5000 (defaults to ${LIMIT_DEFAULT}).`, undefined, Number.parseInt).option('follow', 'Output new entries as they are generated.').option('format', 'Render output in a particular format. Accepts “table“ (default), “csv“, “json“, and “text”.').examples([{
   usage: 'vip @example-app.production logs',
   description: 'Retrieve up to 500 of the most recent entries of application Runtime Logs from web containers.'
 }, {

package/dist/bin/vip-slowlogs.js

@@ -163,6 +163,7 @@ const appQuery = exports.appQuery = `
 		name
 	}
 `;
+const parseLimit = value => Number.parseInt(String(value), 10);
 void (0, _command.default)({
   appContext: true,
   appQuery,
@@ -170,7 +171,7 @@ void (0, _command.default)({
   format: true,
   module: 'slowlogs',
   usage: baseUsage
-}).option('limit', 'Set the maximum number of log entries. Accepts an integer value between 1 and 500.', 500).examples([{
+}).option('limit', 'Set the maximum number of log entries. Accepts an integer value between 1 and 500.', 500, parseLimit).examples([{
   description: 'Retrieve up to 500 of the most recent entries from the MySQL slow query logs in the default format.',
   usage: exampleUsage
 }, {

package/dist/lib/cli/command.js

@@ -104,7 +104,8 @@ function createOptionDefinition(name, description, defaultValue, parseFn, usedSh
     flags,
     description,
     defaultValue,
-    parser
+    parser,
+    normalizedShortName
   };
 }
 function isOptionToken(arg) {
@@ -118,21 +119,43 @@ class CommanderArgsCompat {
     this.sub = [];
     this.examplesList = [];
     this.usedShortNames = new Set();
+    this.shortOptionsExpectingValue = new Set();
+    this.longOptionsExpectingValue = new Set();
+    this.knownShortOptions = new Set();
+    this.knownLongOptions = new Set();
     this._opts = opts;
     this.program = new _commander.Command();
     this.program.allowUnknownOption(true);
     this.program.allowExcessArguments(true);
     this.program.helpOption(false);
     normalizeUsage(this.program, this._opts.usage);
+    this.optionDefaults = new Map();
   }
   option(name, description, defaultValue, parseFn) {
     const definition = createOptionDefinition(name, description, defaultValue, parseFn, this.usedShortNames);
     const {
       flags,
-      parser
+      parser,
+      normalizedShortName
     } = definition;
+    const normalizedLongName = String(Array.isArray(name) ? name[1] : name).trim().replace(/^--?/, '');
+    const isValueOption = typeof defaultValue !== 'boolean';
+    this.knownLongOptions.add(normalizedLongName);
+    if (normalizedShortName) {
+      this.knownShortOptions.add(normalizedShortName);
+    }
+    if (isValueOption && normalizedShortName) {
+      this.shortOptionsExpectingValue.add(normalizedShortName);
+    }
+    if (isValueOption) {
+      this.longOptionsExpectingValue.add(normalizedLongName);
+    }
+
+    // When there's a parser, track the default separately and don't pass it to Commander.
+    // This prevents the parser from incorrectly accumulating the default value with the first explicit value.
     if (parser && defaultValue !== undefined) {
-      this.program.option(flags, description, parser, defaultValue);
+      this.optionDefaults.set(normalizedLongName, defaultValue);
+      this.program.option(flags, description, parser);
     } else if (parser) {
       this.program.option(flags, description, parser);
     } else if (defaultValue !== undefined) {
@@ -194,16 +217,43 @@ class CommanderArgsCompat {
     return this.details.commands.some(entry => entry.usage === value);
   }
   parse(argv) {
-    this.program.parse(argv, {
+    this.program.parse(this.normalizeShortOptionEqualsSyntax(argv), {
       from: 'node'
     });
     this.sub = this.program.args.slice();
-    return this.program.opts();
+    const opts = this.program.opts();
+
+    // Apply tracked defaults for options with parsers
+    for (const [optionName, defaultValue] of this.optionDefaults) {
+      if (opts[optionName] === undefined) {
+        opts[optionName] = defaultValue;
+      }
+    }
+    return opts;
+  }
+  normalizeShortOptionEqualsSyntax(argv) {
+    const normalizedArgv = argv.slice(0, 2);
+    for (const arg of argv.slice(2)) {
+      const shortOptionEqualsMatch = /^-([A-Za-z0-9])=(.*)$/.exec(arg);
+      if (!shortOptionEqualsMatch) {
+        normalizedArgv.push(arg);
+        continue;
+      }
+      const shortOptionName = shortOptionEqualsMatch[1];
+      const optionValue = shortOptionEqualsMatch[2];
+      if (!this.shortOptionsExpectingValue.has(shortOptionName)) {
+        normalizedArgv.push(arg);
+        continue;
+      }
+      normalizedArgv.push(`-${shortOptionName}`, optionValue);
+    }
+    return normalizedArgv;
   }
   findSubcommand(argv) {
-    const dashDashIndex = argv.indexOf('--', 2);
+    const searchStart = argv[2] === '--' ? 3 : 2;
+    const dashDashIndex = argv.indexOf('--', searchStart);
     const searchEnd = dashDashIndex === -1 ? argv.length : dashDashIndex;
-    for (let index = 2; index < searchEnd; index++) {
+    for (let index = searchStart; index < searchEnd; index++) {
       const arg = argv[index];
       if (this.isDefined(arg, 'commands')) {
         return {
@@ -221,6 +271,56 @@ class CommanderArgsCompat {
         index++;
       }
     }
+    if (dashDashIndex > -1 && this.isDefined(argv[dashDashIndex + 1], 'commands')) {
+      return {
+        index: dashDashIndex + 1,
+        name: argv[dashDashIndex + 1]
+      };
+    }
+    return null;
+  }
+  findUnknownOption(argv) {
+    const dashDashIndex = argv.indexOf('--', 2);
+    const searchEnd = dashDashIndex === -1 ? argv.length : dashDashIndex;
+    for (let index = 2; index < searchEnd; index++) {
+      const arg = argv[index];
+      if (!isOptionToken(arg)) {
+        continue;
+      }
+      if (arg.startsWith('--')) {
+        const [tokenName] = arg.slice(2).split('=');
+        if (!this.knownLongOptions.has(tokenName)) {
+          return tokenName;
+        }
+        const hasInlineValue = arg.includes('=');
+        const nextArg = argv[index + 1];
+        if (this.longOptionsExpectingValue.has(tokenName) && !hasInlineValue && nextArg && !isOptionToken(nextArg)) {
+          index++;
+        }
+        continue;
+      }
+      const shortEqualsMatch = /^-([A-Za-z0-9])=(.*)$/.exec(arg);
+      if (shortEqualsMatch) {
+        const shortName = shortEqualsMatch[1];
+        if (!this.knownShortOptions.has(shortName)) {
+          return shortName;
+        }
+        continue;
+      }
+      const shortMatch = /^-([A-Za-z0-9])$/.exec(arg);
+      if (shortMatch) {
+        const shortName = shortMatch[1];
+        if (!this.knownShortOptions.has(shortName)) {
+          return shortName;
+        }
+        const nextArg = argv[index + 1];
+        if (this.shortOptionsExpectingValue.has(shortName) && nextArg && !isOptionToken(nextArg)) {
+          index++;
+        }
+        continue;
+      }
+      return arg.replace(/^-+/, '');
+    }
     return null;
   }
   async executeSubcommand(argv, parsedAlias, subcommand) {
@@ -230,7 +330,15 @@ class CommanderArgsCompat {
     const baseScriptPath = extension ? currentScript.slice(0, -extension.length) : currentScript;
     const childScriptPath = extension ? `${baseScriptPath}-${subcommandName}${extension}` : `${baseScriptPath}-${subcommandName}`;
     const aliasFromRawArgv = argv.slice(2).find(arg => (0, _envAlias.isAlias)(arg));
-    let childArgs = [...parsedAlias.argv.slice(2, subcommand.index), ...parsedAlias.argv.slice(subcommand.index + 1)];
+    const rawArgsBeforeSubcommand = parsedAlias.argv.slice(2, subcommand.index);
+    const hasSeparatorBeforeSubcommand = rawArgsBeforeSubcommand.includes('--');
+    const argsBeforeSubcommand = rawArgsBeforeSubcommand.filter(arg => arg !== '--');
+    const subcommandArgs = parsedAlias.argv.slice(subcommand.index + 1);
+    const hasSeparator = argv.includes('--');
+    if (subcommandName === 'wp' && subcommandArgs.length && !hasSeparator) {
+      exit.withError('A double dash ("--") must separate the arguments of "vip" from those of "wp". Run "vip wp --help" for examples.');
+    }
+    let childArgs = [...argsBeforeSubcommand, ...(hasSeparatorBeforeSubcommand ? ['--'] : []), ...subcommandArgs];
     if (aliasFromRawArgv) {
       childArgs = [aliasFromRawArgv, ...childArgs];
     }
@@ -285,6 +393,15 @@ CommanderArgsCompat.prototype.argv = async function (argv, cb) {
     await this.executeSubcommand(argv, parsedAlias, dispatchSubcommand);
     return {};
   }
+  if (!_opts.wildcardCommand) {
+    const unknownOption = this.findUnknownOption(parsedAlias.argv);
+    if (unknownOption) {
+      await (0, _tracker.trackEvent)('command_validation_error', {
+        error: `Unknown option: ${unknownOption}`
+      });
+      exit.withError(`The option "${unknownOption}" is unknown. Did you mean the following one?\n-h, --help  Retrieve a description, examples, and available options for a (sub)command.`);
+    }
+  }
   if (_opts.format && !options.format) {
     options.format = 'table';
   }