web-ext 7.2.0 → 7.3.1

package/lib/program.js

@@ -1,3 +1,4 @@
+
 import os from 'os';
 import path from 'path';
 import { readFileSync } from 'fs';
@@ -12,11 +13,10 @@ import { coerceCLICustomPreference } from './firefox/preferences.js';
 import { checkForUpdates as defaultUpdateChecker } from './util/updates.js';
 import { discoverConfigFiles as defaultConfigDiscovery, loadJSConfigFile as defaultLoadJSConfigFile, applyConfigToArgv as defaultApplyConfigToArgv } from './config.js';
 const log = createLogger(import.meta.url);
-const envPrefix = 'WEB_EXT'; // Default to "development" (the value actually assigned will be interpolated
+const envPrefix = 'WEB_EXT';
+// Default to "development" (the value actually assigned will be interpolated
 // by babel-plugin-transform-inline-environment-variables).
-
 const defaultGlobalEnv = "production" || 'development';
-
 /*
  * The command line program.
  */
@@ -29,14 +29,15 @@ export class Program {
     // NOTE: process.argv.slice(2) removes the path to node and web-ext
     // executables from the process.argv array.
     argv = argv || process.argv.slice(2);
-    this.programArgv = argv; // NOTE: always initialize yargs explicitly with the package dir
+    this.programArgv = argv;
+
+    // NOTE: always initialize yargs explicitly with the package dir
     // to avoid side-effects due to yargs looking for its configuration
     // section from a package.json file stored in an arbitrary directory
     // (e.g. in tests yargs would end up loading yargs config from the
     // mocha package.json). web-ext package.json doesn't contain any yargs
     // section as it is deprecated and we configure yargs using
     // yargs.parserConfiguration. See web-ext#469 for rationale.
-
     const yargsInstance = yargs(argv, absolutePackageDir);
     this.absolutePackageDir = absolutePackageDir;
     this.verboseEnabled = false;
@@ -50,35 +51,34 @@ export class Program {
     this.commands = {};
     this.options = {};
   }
-
   command(name, description, executor, commandOptions = {}) {
     this.options[camelCase(name)] = commandOptions;
     this.yargs.command(name, description, yargsForCmd => {
       if (!commandOptions) {
         return;
       }
-
-      return yargsForCmd // Make sure the user does not add any extra commands. For example,
+      return yargsForCmd
+      // Make sure the user does not add any extra commands. For example,
       // this would be a mistake because lint does not accept arguments:
       // web-ext lint ./src/path/to/file.js
-      .demandCommand(0, 0, undefined, 'This command does not take any arguments').strict().exitProcess(this.shouldExitProgram) // Calling env() will be unnecessary after
+      .demandCommand(0, 0, undefined, 'This command does not take any arguments').strict().exitProcess(this.shouldExitProgram)
+      // Calling env() will be unnecessary after
       // https://github.com/yargs/yargs/issues/486 is fixed
       .env(envPrefix).options(commandOptions);
     });
     this.commands[name] = executor;
     return this;
   }
-
   setGlobalOptions(options) {
     // This is a convenience for setting global options.
     // An option is only global (i.e. available to all sub commands)
     // with the `global` flag so this makes sure every option has it.
-    this.options = { ...this.options,
+    this.options = {
+      ...this.options,
       ...options
     };
     Object.keys(options).forEach(key => {
       options[key].global = true;
-
       if (options[key].demandOption === undefined) {
         // By default, all options should be "demanded" otherwise
         // yargs.strict() will think they are missing when declared.
@@ -88,19 +88,17 @@ export class Program {
     this.yargs.options(options);
     return this;
   }
-
   enableVerboseMode(logStream, version) {
     if (this.verboseEnabled) {
       return;
     }
-
     logStream.makeVerbose();
     log.info('Version:', version);
     this.verboseEnabled = true;
-  } // Retrieve the yargs argv object and apply any further fix needed
-  // on the output of the yargs options parsing.
-
+  }
 
+  // Retrieve the yargs argv object and apply any further fix needed
+  // on the output of the yargs options parsing.
   getArguments() {
     // To support looking up required parameters via config files, we need to
     // temporarily disable the requiredArguments validation. Otherwise yargs
@@ -114,93 +112,81 @@ export class Program {
     const validationInstance = this.yargs.getInternalMethods().getValidationInstance();
     const {
       requiredArguments
-    } = validationInstance; // Initialize demandedOptions (which is going to be set to an object with one
+    } = validationInstance;
+    // Initialize demandedOptions (which is going to be set to an object with one
     // property for each mandatory global options, then the arrow function below
     // will receive as its demandedOptions parameter a new one that also includes
     // all mandatory options for the sub command selected).
-
     this.demandedOptions = this.yargs.getDemandedOptions();
-
     validationInstance.requiredArguments = (args, demandedOptions) => {
       this.demandedOptions = demandedOptions;
     };
-
     let argv;
-
     try {
       argv = this.yargs.argv;
     } catch (err) {
       if (err.name === 'YError' && err.message.startsWith('Unknown argument: ')) {
         throw new UsageError(err.message);
       }
-
       throw err;
     }
+    validationInstance.requiredArguments = requiredArguments;
 
-    validationInstance.requiredArguments = requiredArguments; // Yargs boolean options doesn't define the no* counterpart
+    // Yargs boolean options doesn't define the no* counterpart
     // with negate-boolean on Yargs 15. Define as expected by the
     // web-ext execute method.
-
     if (argv.configDiscovery != null) {
       argv.noConfigDiscovery = !argv.configDiscovery;
     }
-
     if (argv.reload != null) {
       argv.noReload = !argv.reload;
-    } // Yargs doesn't accept --no-input as a valid option if there isn't a
+    }
+
+    // Yargs doesn't accept --no-input as a valid option if there isn't a
     // --input option defined to be negated, to fix that the --input is
     // defined and hidden from the yargs help output and we define here
     // the negated argument name that we expect to be set in the parsed
     // arguments (and fix https://github.com/mozilla/web-ext/issues/1860).
-
-
     if (argv.input != null) {
       argv.noInput = !argv.input;
-    } // Replacement for the "requiresArg: true" parameter until the following bug
-    // is fixed: https://github.com/yargs/yargs/issues/1098
-
+    }
 
+    // Replacement for the "requiresArg: true" parameter until the following bug
+    // is fixed: https://github.com/yargs/yargs/issues/1098
     if (argv.ignoreFiles && !argv.ignoreFiles.length) {
       throw new UsageError('Not enough arguments following: ignore-files');
     }
-
     if (argv.startUrl && !argv.startUrl.length) {
       throw new UsageError('Not enough arguments following: start-url');
     }
-
     if (Array.isArray(argv.firefoxPreview) && !argv.firefoxPreview.length) {
       argv.firefoxPreview = ['mv3'];
     }
-
     return argv;
-  } // getArguments() disables validation of required parameters, to allow us to
+  }
+
+  // getArguments() disables validation of required parameters, to allow us to
   // read parameters from config files first. Before the program continues, it
   // must call checkRequiredArguments() to ensure that required parameters are
   // defined (in the CLI or in a config file).
-
-
   checkRequiredArguments(adjustedArgv) {
     const validationInstance = this.yargs.getInternalMethods().getValidationInstance();
     validationInstance.requiredArguments(adjustedArgv, this.demandedOptions);
-  } // Remove WEB_EXT_* environment vars that are not a global cli options
-  // or an option supported by the current command (See #793).
-
+  }
 
+  // Remove WEB_EXT_* environment vars that are not a global cli options
+  // or an option supported by the current command (See #793).
   cleanupProcessEnvConfigs(systemProcess) {
     const cmd = yargsParser(this.programArgv)._[0];
-
     const env = systemProcess.env || {};
-
     const toOptionKey = k => decamelize(camelCase(k.replace(envPrefix, '')), {
       separator: '-'
     });
-
     if (cmd) {
       Object.keys(env).filter(k => k.startsWith(envPrefix)).forEach(k => {
         const optKey = toOptionKey(k);
         const globalOpt = this.options[optKey];
         const cmdOpt = this.options[cmd] && this.options[cmd][optKey];
-
         if (!globalOpt && !cmdOpt) {
           log.debug(`Environment ${k} not supported by web-ext ${cmd}`);
           delete env[k];
@@ -208,7 +194,6 @@ export class Program {
       });
     }
   }
-
   async execute({
     checkForUpdates = defaultUpdateChecker,
     systemProcess = process,
@@ -227,31 +212,25 @@ export class Program {
     const cmd = argv._[0];
     const version = await getVersion(this.absolutePackageDir);
     const runCommand = this.commands[cmd];
-
     if (argv.verbose) {
       this.enableVerboseMode(logStream, version);
     }
-
-    let adjustedArgv = { ...argv
+    let adjustedArgv = {
+      ...argv
     };
-
     try {
       if (cmd === undefined) {
         throw new UsageError('No sub-command was specified in the args');
       }
-
       if (!runCommand) {
         throw new UsageError(`Unknown command: ${cmd}`);
       }
-
       if (globalEnv === 'production') {
         checkForUpdates({
           version
         });
       }
-
       const configFiles = [];
-
       if (argv.configDiscovery) {
         log.debug('Discovering config files. ' + 'Set --no-config-discovery to disable');
         const discoveredConfigs = await discoverConfigFiles();
@@ -259,16 +238,13 @@ export class Program {
       } else {
         log.debug('Not discovering config files');
       }
-
       if (argv.config) {
         configFiles.push(path.resolve(argv.config));
       }
-
       if (configFiles.length) {
         const niceFileList = configFiles.map(f => f.replace(process.cwd(), '.')).map(f => f.replace(os.homedir(), '~')).join(', ');
         log.info('Applying config file' + `${configFiles.length !== 1 ? 's' : ''}: ` + `${niceFileList}`);
       }
-
       configFiles.forEach(configFileName => {
         const configObject = loadJSConfigFile(configFileName);
         adjustedArgv = applyConfigToArgv({
@@ -279,12 +255,10 @@ export class Program {
           options: this.options
         });
       });
-
       if (adjustedArgv.verbose) {
         // Ensure that the verbose is enabled when specified in a config file.
         this.enableVerboseMode(logStream, version);
       }
-
       this.checkRequiredArguments(adjustedArgv);
       await runCommand(adjustedArgv, {
         shouldExitProgram
@@ -295,13 +269,10 @@ export class Program {
       } else {
         log.error(`\n${String(error)}\n`);
       }
-
       if (error.code) {
         log.error(`Error code: ${error.code}\n`);
       }
-
       log.debug(`Command executed: ${cmd}`);
-
       if (this.shouldExitProgram) {
         systemProcess.exit(1);
       } else {
@@ -309,8 +280,9 @@ export class Program {
       }
     }
   }
+}
 
-} //A defintion of type of argument for defaultVersionGetter
+//A defintion of type of argument for defaultVersionGetter
 
 export async function defaultVersionGetter(absolutePackageDir, {
   globalEnv = defaultGlobalEnv
@@ -320,22 +292,23 @@ export async function defaultVersionGetter(absolutePackageDir, {
     const packageData = readFileSync(path.join(absolutePackageDir, 'package.json'));
     return JSON.parse(packageData).version;
   } else {
-    log.debug('Getting version from the git revision'); // This branch is only reached during development.
+    log.debug('Getting version from the git revision');
+    // This branch is only reached during development.
     // git-rev-sync is in devDependencies, and lazily imported using require.
     // This also avoids logspam from https://github.com/mozilla/web-ext/issues/1916
     // eslint-disable-next-line import/no-extraneous-dependencies
-
     const git = await import('git-rev-sync');
     return `${git.branch(absolutePackageDir)}-${git.long(absolutePackageDir)}`;
   }
-} // TODO: add pipes to Flow type after https://github.com/facebook/flow/issues/2405 is fixed
+}
+
+// TODO: add pipes to Flow type after https://github.com/facebook/flow/issues/2405 is fixed
 
 export function throwUsageErrorIfArray(errorMessage) {
   return value => {
     if (Array.isArray(value)) {
       throw new UsageError(errorMessage);
     }
-
     return value;
   };
 }
@@ -348,10 +321,19 @@ export async function main(absolutePackageDir, {
   const program = new Program(argv, {
     absolutePackageDir
   });
-  const version = await getVersion(absolutePackageDir); // yargs uses magic camel case expansion to expose options on the
+  const version = await getVersion(absolutePackageDir);
+
+  // This is an option shared by some commands but not all of them, hence why
+  // it isn't a global option.
+  const firefoxPreviewOption = {
+    describe: 'Turn on developer preview features in Firefox' + ' (defaults to "mv3")',
+    demandOption: false,
+    type: 'array'
+  };
+
+  // yargs uses magic camel case expansion to expose options on the
   // final argv object. For example, the 'artifacts-dir' option is alternatively
   // available as argv.artifactsDir.
-
   program.yargs.usage(`Usage: $0 [options] command
 
 Option values can also be set by declaring an environment variable prefixed
@@ -442,6 +424,12 @@ Example: $0 --help run.
       type: 'boolean'
     }
   }).command('sign', 'Sign the extension so it can be installed in Firefox', commands.sign, {
+    'amo-base-url': {
+      describe: 'Signing API URL prefix - only used with `use-submission-api`',
+      default: 'https://addons.mozilla.org/api/v5',
+      demandOption: true,
+      type: 'string'
+    },
     'api-key': {
       describe: 'API key (JWT issuer) from addons.mozilla.org',
       demandOption: true,
@@ -463,6 +451,11 @@ Example: $0 --help run.
       demandOption: false,
       type: 'string'
     },
+    'use-submission-api': {
+      describe: 'Sign using the addon submission API',
+      demandOption: false,
+      type: 'boolean'
+    },
     'id': {
       describe: 'A custom ID for the extension. This has no effect if the ' + 'extension already declares an explicit ID in its manifest.',
       demandOption: false,
@@ -473,7 +466,10 @@ Example: $0 --help run.
       type: 'number'
     },
     'channel': {
-      describe: 'The channel for which to sign the addon. Either ' + '\'listed\' or \'unlisted\'',
+      describe: 'The channel for which to sign the addon. Either ' + '\'listed\' or \'unlisted\''
+    },
+    'amo-metadata': {
+      describe: 'Path to a JSON file containing an object with metadata ' + 'to be passed to the API. ' + 'See https://addons-server.readthedocs.io' + '/en/latest/topics/api/addons.html for details. ' + 'Only used with `use-submission-api`',
       type: 'string'
     }
   }).command('run', 'Run the extension', commands.run, {
@@ -552,6 +548,11 @@ Example: $0 --help run.
       demandOption: false,
       type: 'array'
     },
+    'devtools': {
+      describe: 'Open the DevTools for the installed add-on ' + '(Firefox 106 and later)',
+      demandOption: false,
+      type: 'boolean'
+    },
     'browser-console': {
       alias: ['bc'],
       describe: 'Open the DevTools Browser Console.',
@@ -564,11 +565,7 @@ Example: $0 --help run.
       demandOption: false,
       type: 'array'
     },
-    'firefox-preview': {
-      describe: 'Turn on developer preview features in Firefox' + ' (defaults to "mv3")',
-      demandOption: false,
-      type: 'array'
-    },
+    'firefox-preview': firefoxPreviewOption,
     // Firefox for Android CLI options.
     'adb-bin': {
       describe: 'Specify a custom path to the adb binary',
@@ -656,7 +653,8 @@ Example: $0 --help run.
       describe: 'Disables colorful shell output',
       type: 'boolean',
       default: false
-    }
+    },
+    'firefox-preview': firefoxPreviewOption
   }).command('docs', 'Open the web-ext documentation in a browser', commands.docs, {});
   return program.execute({
     getVersion,