appium 3.2.2 → 3.3.1

package/build/lib/cli/parser.js

@@ -11,7 +11,7 @@ const lodash_1 = __importDefault(require("lodash"));
 const node_path_1 = __importDefault(require("node:path"));
 const constants_1 = require("../constants");
 const schema_1 = require("../schema");
-const config_1 = require("../config");
+const build_1 = require("../helpers/build");
 const args_1 = require("./args");
 const setup_command_1 = require("./setup-command");
 exports.EXTRA_ARGS = 'extraArgs';
@@ -20,7 +20,7 @@ exports.EXTRA_ARGS = 'extraArgs';
  * will automatically inject the `server` subcommand.
  */
 const NON_SERVER_ARGS = Object.freeze(new Set([constants_1.SETUP_SUBCOMMAND, constants_1.DRIVER_TYPE, constants_1.PLUGIN_TYPE, constants_1.SERVER_SUBCOMMAND, '-h', '--help', '-v', '--version']));
-const version = support_1.fs.readPackageJsonFrom(config_1.rootDir).version;
+const version = support_1.fs.readPackageJsonFrom(build_1.rootDir).version;
 /**
  * A wrapper around `argparse`
  *
@@ -29,8 +29,13 @@ const version = support_1.fs.readPackageJsonFrom(config_1.rootDir).version;
  * - Handles error conditions, messages, and exit behavior
  */
 class ArgParser {
+    prog;
+    debug;
+    parser;
+    rawArgs;
+    parse_args;
     /**
-     * @param {boolean} [debug] - If true, throw instead of exit on error.
+     * @param debug - if true, throw instead of exiting on parse errors
      */
     constructor(debug = false) {
         const prog = process.argv[1] ? node_path_1.default.basename(process.argv[1]) : 'appium';
@@ -41,20 +46,8 @@ class ArgParser {
             prog,
         });
         ArgParser._patchExit(parser);
-        /**
-         * Program name (typically `appium`)
-         * @type {string}
-         */
         this.prog = prog;
-        /**
-         * If `true`, throw an error on parse failure instead of printing help
-         * @type {boolean}
-         */
         this.debug = debug;
-        /**
-         * Wrapped `ArgumentParser` instance
-         * @type {ArgumentParser}
-         */
         this.parser = parser;
         parser.add_argument('-v', '--version', {
             action: 'version',
@@ -71,74 +64,19 @@ class ArgParser {
         // add the 'setup' command
         ArgParser._addSetupToParser(subParsers);
         // backwards compatibility / drop-in wrapper
-        /**
-         * @type {ArgParser['parseArgs']}
-         */
         this.parse_args = this.parseArgs;
     }
     /**
-     * Parse arguments from the command line.
+     * Normalizes server arg keys from schema names to parser destination names.
      *
-     * If no subcommand is passed in, this method will inject the `server` subcommand.
-     *
-     * `ArgParser.prototype.parse_args` is an alias of this method.
-     * @template {import('appium/types').CliCommand} [Cmd=import('appium/types').CliCommandServer]
-     * @param {string[]} [args] - Array of arguments, ostensibly from `process.argv`. Gathers args from `process.argv` if not provided.
-     * @returns {import('appium/types').Args<Cmd>} - The parsed arguments
-     */
-    parseArgs(args = process.argv.slice(2)) {
-        if (!NON_SERVER_ARGS.has(args[0])) {
-            args.unshift(constants_1.SERVER_SUBCOMMAND);
-        }
-        try {
-            const parsed = this.parser.parse_known_args(args);
-            const [knownArgs, unknownArgs] = parsed;
-            // XXX: you'd think that argparse, when given an alias for a subcommand,
-            // would set this value to the original subcommand name, but it doesn't.
-            if (knownArgs?.driverCommand === 'ls') {
-                knownArgs.driverCommand = 'list';
-            }
-            else if (knownArgs?.pluginCommand === 'ls') {
-                knownArgs.pluginCommand = 'list';
-            }
-            if (unknownArgs?.length &&
-                (knownArgs.driverCommand === 'run' || knownArgs.pluginCommand === 'run')) {
-                return ArgParser._transformParsedArgs(knownArgs, unknownArgs);
-            }
-            else if (unknownArgs?.length) {
-                throw new Error(`[ERROR] Unrecognized arguments: ${unknownArgs.join(' ')}`);
-            }
-            return ArgParser._transformParsedArgs(knownArgs);
-        }
-        catch (err) {
-            if (this.debug) {
-                throw err;
-            }
-            // this isn't tested via unit tests (we use `debug: true`) so may escape coverage.
-            /* istanbul ignore next */
-            {
-                // eslint-disable-next-line no-console
-                console.error(); // need an extra space since argparse prints usage.
-                // eslint-disable-next-line no-console
-                console.error(err.message);
-                process.exit(1);
-            }
-        }
-    }
-    /**
-     * Normalize hyphenated server arg keys (e.g. "log-level") to dest form (e.g. "loglevel").
-     * Use when server args come from programmatic init rather than the CLI, so they match
-     * the shape produced by parseArgs() / _transformParsedArgs().
-     * Mutates the given object.
-     *
-     * @param {object} obj - Object that may contain server args with schema property names
-     * @returns {object} The same object with keys normalized
+     * This mutates and returns the same object.
      */
     static normalizeServerArgs(obj) {
+        const mutableObj = obj;
         for (const spec of (0, schema_1.getAllArgSpecs)().values()) {
-            if (!spec.extType && obj[spec.name] !== undefined && spec.rawDest !== spec.name) {
-                obj[spec.rawDest] = obj[spec.name] ?? obj[spec.rawDest];
-                delete obj[spec.name];
+            if (!spec.extType && mutableObj[spec.name] !== undefined && spec.rawDest !== spec.name) {
+                mutableObj[spec.rawDest] = mutableObj[spec.name] ?? mutableObj[spec.rawDest];
+                delete mutableObj[spec.name];
             }
         }
         return obj;
@@ -149,14 +87,12 @@ class ArgParser {
      * keys to match the intended destination.
      *
      * E.g., `{'driver-foo-bar': baz}` becomes `{driver: {foo: {bar: 'baz'}}}`
-     * @param {object} args
-     * @param {string[]} [unknownArgs]
-     * @returns {object}
      */
     static _transformParsedArgs(args, unknownArgs = []) {
         const result = lodash_1.default.reduce(args, (unpacked, value, key) => {
-            if (!lodash_1.default.isUndefined(value) && (0, schema_1.hasArgSpec)(key)) {
-                const { dest } = /** @type {import('../schema/arg-spec').ArgSpec} */ ((0, schema_1.getArgSpec)(key));
+            const spec = (0, schema_1.hasArgSpec)(key) ? (0, schema_1.getArgSpec)(key) : undefined;
+            if (!lodash_1.default.isUndefined(value) && spec) {
+                const { dest } = spec;
                 lodash_1.default.set(unpacked, dest, value);
             }
             else {
@@ -170,7 +106,6 @@ class ArgParser {
     }
     /**
      * Patches the `exit()` method of the parser to throw an error, so we can handle it manually.
-     * @param {ArgumentParser} parser
      */
     static _patchExit(parser) {
         parser.exit = (code, msg) => {
@@ -181,9 +116,7 @@ class ArgParser {
         };
     }
     /**
-     *
-     * @param {import('argparse').SubParser} subParser
-     * @returns {import('./args').ArgumentDefinitions}
+     * Adds the `server` subcommand parser and returns its argument definitions.
      */
     static _addServerToParser(subParser) {
         const serverParser = subParser.add_parser('server', {
@@ -201,11 +134,10 @@ class ArgParser {
     }
     /**
      * Adds extension sub-sub-commands to `driver`/`plugin` subcommands
-     * @param {import('argparse').SubParser} subParsers
      */
-    static _addExtensionCommandsToParser(subParsers) {
-        for (const type of /** @type {[DriverType, PluginType]} */ ([constants_1.DRIVER_TYPE, constants_1.PLUGIN_TYPE])) {
-            const extParser = subParsers.add_parser(type, {
+    static _addExtensionCommandsToParser(subParser) {
+        for (const type of [constants_1.DRIVER_TYPE, constants_1.PLUGIN_TYPE]) {
+            const extParser = subParser.add_parser(type, {
                 add_help: true,
                 help: `Manage Appium ${type}s`,
                 description: `Manage Appium ${type}s using various subcommands`,
@@ -215,9 +147,6 @@ class ArgParser {
                 dest: `${type}Command`,
             });
             const extensionArgs = (0, args_1.getExtensionArgs)();
-            /**
-             * @type { {command: import('appium/types').CliExtensionSubcommand, args: import('./args').ArgumentDefinitions, help: string, aliases?: import('argparse').SubArgumentParserOptions['aliases']}[] }
-             */
             const parserSpecs = [
                 {
                     command: constants_1.EXT_SUBCOMMAND_LIST,
@@ -268,7 +197,6 @@ class ArgParser {
     }
     /**
      * Add subcommand and sub-sub commands for 'setup' subcommand.
-     * @param {import('argparse').SubParser} subParser
      */
     static _addSetupToParser(subParser) {
         const setupParser = subParser.add_parser('setup', {
@@ -309,21 +237,58 @@ class ArgParser {
             ArgParser._patchExit(parser);
         }
     }
+    /**
+     * Parses CLI args and returns Appium's normalized argument object.
+     *
+     * If no explicit subcommand is provided, this injects `server`.
+     * `parse_args` is a backwards-compatible alias of this method.
+     */
+    parseArgs(args = process.argv.slice(2)) {
+        if (!NON_SERVER_ARGS.has(args[0])) {
+            args.unshift(constants_1.SERVER_SUBCOMMAND);
+        }
+        try {
+            const parsed = this.parser.parse_known_args(args);
+            const [knownArgs, unknownArgs] = parsed;
+            // XXX: you'd think that argparse, when given an alias for a subcommand,
+            // would set this value to the original subcommand name, but it doesn't.
+            if (knownArgs?.driverCommand === 'ls') {
+                knownArgs.driverCommand = 'list';
+            }
+            else if (knownArgs?.pluginCommand === 'ls') {
+                knownArgs.pluginCommand = 'list';
+            }
+            if (unknownArgs?.length &&
+                (knownArgs.driverCommand === 'run' || knownArgs.pluginCommand === 'run')) {
+                return ArgParser._transformParsedArgs(knownArgs, unknownArgs);
+            }
+            else if (unknownArgs?.length) {
+                throw new Error(`[ERROR] Unrecognized arguments: ${unknownArgs.join(' ')}`);
+            }
+            return ArgParser._transformParsedArgs(knownArgs);
+        }
+        catch (err) {
+            if (this.debug) {
+                throw err;
+            }
+            // this isn't tested via unit tests (we use `debug: true`) so may escape coverage.
+            /* istanbul ignore next */
+            {
+                // eslint-disable-next-line no-console
+                console.error(); // need an extra space since argparse prints usage.
+                // eslint-disable-next-line no-console
+                console.error(err.message);
+                process.exit(1);
+            }
+        }
+    }
 }
 exports.ArgParser = ArgParser;
 /**
- * Creates a {@link ArgParser} instance; finalizes the config schema.
- *
- * @constructs ArgParser
- * @param {boolean} [debug] - If `true`, throw instead of exit upon parsing error
- * @returns {ArgParser}
+ * Creates and returns an `ArgParser` after finalizing schema state.
  */
-function getParser(debug) {
-    (0, schema_1.finalizeSchema)();
+async function getParser(debug = false) {
+    await (0, schema_1.finalizeSchema)();
     return new ArgParser(debug);
 }
-/**
- * @typedef {import('@appium/types').DriverType} DriverType
- * @typedef {import('@appium/types').PluginType} PluginType
- */
 //# sourceMappingURL=parser.js.map

package/build/lib/cli/parser.js.map

@@ -1 +1 @@
-{"version":3,"file":"parser.js","sourceRoot":"","sources":["../../../lib/cli/parser.js"],"names":[],"mappings":";;;;;;AA8XQ,8BAAS;AA9XjB,6CAAmC;AACnC,uCAAwC;AACxC,oDAAuB;AACvB,0DAA6B;AAC7B,4CAWsB;AACtB,sCAAiF;AACjF,sCAAkC;AAClC,iCAAuD;AACvD,mDAQyB;AAEZ,QAAA,UAAU,GAAG,WAAW,CAAC;AAEtC;;;GAGG;AACH,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,CACnC,IAAI,GAAG,CAAC,CAAC,4BAAgB,EAAE,uBAAW,EAAE,uBAAW,EAAE,6BAAiB,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC,CAC5G,CAAC;AAEF,MAAM,OAAO,GAAG,YAAE,CAAC,mBAAmB,CAAC,gBAAO,CAAC,CAAC,OAAO,CAAC;AAExD;;;;;;GAMG;AACH,MAAM,SAAS;IACb;;OAEG;IACH,YAAY,KAAK,GAAG,KAAK;QACvB,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,mBAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;QACzE,MAAM,MAAM,GAAG,IAAI,yBAAc,CAAC;YAChC,QAAQ,EAAE,IAAI;YACd,WAAW,EACT,sFAAsF;gBACtF,yCAAyC;YAC3C,IAAI;SACL,CAAC,CAAC;QAEH,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QAE7B;;;WAGG;QACH,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QAEjB;;;WAGG;QACH,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QAEnB;;;WAGG;QACH,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QAErB,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,WAAW,EAAE;YACrC,MAAM,EAAE,SAAS;YACjB,OAAO;SACR,CAAC,CAAC;QAEH,MAAM,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,EAAC,IAAI,EAAE,YAAY,EAAC,CAAC,CAAC;QAE/D,yEAAyE;QACzE,yEAAyE;QACzE,iDAAiD;QACjD,MAAM,UAAU,GAAG,SAAS,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAE5D,IAAI,CAAC,OAAO,GAAG,UAAU,CAAC;QAE1B,4CAA4C;QAC5C,SAAS,CAAC,6BAA6B,CAAC,UAAU,CAAC,CAAC;QAEpD,0BAA0B;QAC1B,SAAS,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;QAExC,4CAA4C;QAC5C;;WAEG;QACH,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC;IACnC,CAAC;IAED;;;;;;;;;OASG;IACH,SAAS,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;QACpC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAClC,IAAI,CAAC,OAAO,CAAC,6BAAiB,CAAC,CAAC;QAClC,CAAC;QAED,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;YAClD,MAAM,CAAC,SAAS,EAAE,WAAW,CAAC,GAAG,MAAM,CAAC;YACxC,wEAAwE;YACxE,wEAAwE;YACxE,IAAI,SAAS,EAAE,aAAa,KAAK,IAAI,EAAE,CAAC;gBACtC,SAAS,CAAC,aAAa,GAAG,MAAM,CAAC;YACnC,CAAC;iBAAM,IAAI,SAAS,EAAE,aAAa,KAAK,IAAI,EAAE,CAAC;gBAC7C,SAAS,CAAC,aAAa,GAAG,MAAM,CAAC;YACnC,CAAC;YACD,IACE,WAAW,EAAE,MAAM;gBACnB,CAAC,SAAS,CAAC,aAAa,KAAK,KAAK,IAAI,SAAS,CAAC,aAAa,KAAK,KAAK,CAAC,EACxE,CAAC;gBACD,OAAO,SAAS,CAAC,oBAAoB,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;YAChE,CAAC;iBAAM,IAAI,WAAW,EAAE,MAAM,EAAE,CAAC;gBAC/B,MAAM,IAAI,KAAK,CAAC,mCAAmC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAC9E,CAAC;YACD,OAAO,SAAS,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAC;QACnD,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBACf,MAAM,GAAG,CAAC;YACZ,CAAC;YACD,kFAAkF;YAElF,0BAA0B;YAC1B,CAAC;gBACC,sCAAsC;gBACtC,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,mDAAmD;gBACpE,sCAAsC;gBACtC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;gBAC3B,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAClB,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,mBAAmB,CAAC,GAAG;QAC5B,KAAK,MAAM,IAAI,IAAI,IAAA,uBAAc,GAAE,CAAC,MAAM,EAAE,EAAE,CAAC;YAC7C,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,SAAS,IAAI,IAAI,CAAC,OAAO,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC;gBAChF,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBACxD,OAAO,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACxB,CAAC;QACH,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,oBAAoB,CAAC,IAAI,EAAE,WAAW,GAAG,EAAE;QAChD,MAAM,MAAM,GAAG,gBAAC,CAAC,MAAM,CACrB,IAAI,EACJ,CAAC,QAAQ,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE;YACvB,IAAI,CAAC,gBAAC,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,IAAA,mBAAU,EAAC,GAAG,CAAC,EAAE,CAAC;gBAC7C,MAAM,EAAC,IAAI,EAAC,GAAG,mDAAmD,CAAC,CAAC,IAAA,mBAAU,EAAC,GAAG,CAAC,CAAC,CAAC;gBACrF,gBAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;YAC/B,CAAC;iBAAM,CAAC;gBACN,mDAAmD;gBACnD,QAAQ,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;YACxB,CAAC;YACD,OAAO,QAAQ,CAAC;QAClB,CAAC,EACD,EAAE,CACH,CAAC;QACF,MAAM,CAAC,kBAAU,CAAC,GAAG,WAAW,CAAC;QACjC,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,UAAU,CAAC,MAAM;QACtB,MAAM,CAAC,IAAI,GAAG,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE;YAC1B,IAAI,IAAI,EAAE,CAAC;gBACT,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;YACvB,CAAC;YACD,OAAO,CAAC,IAAI,EAAE,CAAC;QACjB,CAAC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,kBAAkB,CAAC,SAAS;QACjC,MAAM,YAAY,GAAG,SAAS,CAAC,UAAU,CAAC,QAAQ,EAAE;YAClD,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,wBAAwB;YAC9B,WAAW,EAAE,8DAA8D;SAC5E,CAAC,CAAC;QAEH,SAAS,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;QAEnC,MAAM,UAAU,GAAG,IAAA,oBAAa,GAAE,CAAC;QACnC,KAAK,MAAM,CAAC,YAAY,EAAE,IAAI,CAAC,IAAI,UAAU,EAAE,CAAC;YAC9C,uDAAuD;YACvD,YAAY,CAAC,YAAY,CAAC,GAAG,YAAY,EAAE,EAAC,GAAG,IAAI,EAAC,CAAC,CAAC;QACxD,CAAC;QAED,OAAO,UAAU,CAAC;IACpB,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,6BAA6B,CAAC,UAAU;QAC7C,KAAK,MAAM,IAAI,IAAI,uCAAuC,CAAC,CAAC,CAAC,uBAAW,EAAE,uBAAW,CAAC,CAAC,EAAE,CAAC;YACxF,MAAM,SAAS,GAAG,UAAU,CAAC,UAAU,CAAC,IAAI,EAAE;gBAC5C,QAAQ,EAAE,IAAI;gBACd,IAAI,EAAE,iBAAiB,IAAI,GAAG;gBAC9B,WAAW,EAAE,iBAAiB,IAAI,6BAA6B;aAChE,CAAC,CAAC;YAEH,SAAS,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;YAEhC,MAAM,aAAa,GAAG,SAAS,CAAC,cAAc,CAAC;gBAC7C,IAAI,EAAE,GAAG,IAAI,SAAS;aACvB,CAAC,CAAC;YACH,MAAM,aAAa,GAAG,IAAA,uBAAgB,GAAE,CAAC;YACzC;;eAEG;YACH,MAAM,WAAW,GAAG;gBAClB;oBACE,OAAO,EAAE,+BAAmB;oBAC5B,IAAI,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC,IAAI;oBAC9B,IAAI,EAAE,gCAAgC,IAAI,GAAG;oBAC7C,OAAO,EAAE,CAAC,IAAI,CAAC;iBAChB;gBACD;oBACE,OAAO,EAAE,kCAAsB;oBAC/B,IAAI,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC,OAAO;oBACjC,IAAI,EAAE,aAAa,IAAI,EAAE;iBAC1B;gBACD;oBACE,OAAO,EAAE,oCAAwB;oBACjC,IAAI,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC,SAAS;oBACnC,IAAI,EAAE,eAAe,IAAI,EAAE;iBAC5B;gBACD;oBACE,OAAO,EAAE,iCAAqB;oBAC9B,IAAI,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC,MAAM;oBAChC,IAAI,EAAE,gCAAgC,IAAI,yBAAyB;iBACpE;gBACD;oBACE,OAAO,EAAE,8BAAkB;oBAC3B,IAAI,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC,GAAG;oBAC7B,IAAI,EAAE,8CAA8C,IAAI,EAAE;iBAC3D;gBACD;oBACE,OAAO,EAAE,iCAAqB;oBAC9B,IAAI,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC,MAAM;oBAChC,IAAI,EAAE,kDAAkD,IAAI,EAAE;iBAC/D;aACF,CAAC;YAEF,KAAK,MAAM,EAAC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAC,IAAI,WAAW,EAAE,CAAC;gBACzD,MAAM,MAAM,GAAG,aAAa,CAAC,UAAU,CAAC,OAAO,EAAE,EAAC,IAAI,EAAE,OAAO,EAAE,OAAO,IAAI,EAAE,EAAC,CAAC,CAAC;gBAEjF,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;gBAE7B,KAAK,MAAM,CAAC,YAAY,EAAE,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC;oBACxC,qEAAqE;oBACrE,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;wBAC9B,MAAM,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE,EAAC,GAAG,IAAI,EAAC,CAAC,CAAC;oBACnE,CAAC;yBAAM,CAAC;wBACN,MAAM,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,EAAC,GAAG,IAAI,EAAC,CAAC,CAAC;oBAClD,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,iBAAiB,CAAC,SAAS;QAChC,MAAM,WAAW,GAAG,SAAS,CAAC,UAAU,CAAC,OAAO,EAAE;YAChD,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,uDAAuD;YAC7D,WAAW,EACT,yFAAyF;gBACzF,IAAI,IAAA,qCAAqB,GAAE,8DAA8D;gBACzF,mFAAmF;gBACnF,+DAA+D;SAClE,CAAC,CAAC;QAGH,SAAS,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAClC,MAAM,aAAa,GAAG,WAAW,CAAC,cAAc,CAAC;YAC/C,IAAI,EAAE,cAAc;SACrB,CAAC,CAAC;QAEH,MAAM,WAAW,GAAG;YAClB;gBACE,OAAO,EAAE,iCAAiB;gBAC1B,IAAI,EACF,gCAAgC;oBAChC,aAAa,gBAAC,CAAC,IAAI,CAAC,IAAA,gCAAgB,EAAC,iCAAiB,CAAC,EAAE,GAAG,CAAC,cAAc,+BAAe,GAAG;aAChG;YACD;gBACE,OAAO,EAAE,kCAAkB;gBAC3B,IAAI,EACF,kCAAkC;oBAClC,aAAa,gBAAC,CAAC,IAAI,CAAC,IAAA,gCAAgB,EAAC,kCAAkB,CAAC,EAAE,GAAG,CAAC,cAAc,+BAAe,GAAG;aACjG;YACD;gBACE,OAAO,EAAE,kCAAkB;gBAC3B,IAAI,EACF,sCAAsC;oBACtC,aAAa,gBAAC,CAAC,IAAI,CAAC,IAAA,gCAAgB,EAAC,kCAAkB,CAAC,EAAE,GAAG,CAAC,cAAc,+BAAe,GAAG;aACjG;YACD;gBACE,OAAO,EAAE,gCAAgB;gBACzB,IAAI,EAAE,0CAA0C;aACjD;SACF,CAAC;QAEF,KAAK,MAAM,EAAC,OAAO,EAAE,IAAI,EAAC,IAAI,WAAW,EAAE,CAAC;YAC1C,MAAM,MAAM,GAAG,aAAa,CAAC,UAAU,CAAC,OAAO,EAAE,EAAC,IAAI,EAAC,CAAC,CAAC;YACzD,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QAC/B,CAAC;IACH,CAAC;CACF;AAekB,8BAAS;AAb5B;;;;;;GAMG;AACH,SAAS,SAAS,CAAC,KAAK;IACtB,IAAA,uBAAc,GAAE,CAAC;IAEjB,OAAO,IAAI,SAAS,CAAC,KAAK,CAAC,CAAC;AAC9B,CAAC;AAID;;;GAGG"}
+{"version":3,"file":"parser.js","sourceRoot":"","sources":["../../../lib/cli/parser.ts"],"names":[],"mappings":";;;;;;AAwWA,8BAIC;AA5WD,6CAAmC;AACnC,uCAAwC;AAExC,oDAAuB;AACvB,0DAA6B;AAG7B,4CAWsB;AACtB,sCAAiF;AACjF,4CAAyC;AACzC,iCAAuD;AAEvD,mDAQyB;AAEZ,QAAA,UAAU,GAAG,WAAW,CAAC;AAEtC;;;GAGG;AACH,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,CACnC,IAAI,GAAG,CAAC,CAAC,4BAAgB,EAAE,uBAAW,EAAE,uBAAW,EAAE,6BAAiB,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC,CAC5G,CAAC;AAEF,MAAM,OAAO,GAAG,YAAE,CAAC,mBAAmB,CAAC,eAAO,CAAC,CAAC,OAAO,CAAC;AAIxD;;;;;;GAMG;AACH,MAAa,SAAS;IACX,IAAI,CAAS;IACb,KAAK,CAAU;IACf,MAAM,CAAiB;IACvB,OAAO,CAAsB;IAC7B,UAAU,CAAyB;IAE5C;;OAEG;IACH,YAAY,KAAK,GAAG,KAAK;QACvB,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,mBAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;QACzE,MAAM,MAAM,GAAG,IAAI,yBAAc,CAAC;YAChC,QAAQ,EAAE,IAAI;YACd,WAAW,EACT,sFAAsF;gBACtF,yCAAyC;YAC3C,IAAI;SACL,CAAC,CAAC;QAEH,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QAE7B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QAEjB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QAEnB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QAErB,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,WAAW,EAAE;YACrC,MAAM,EAAE,SAAS;YACjB,OAAO;SACR,CAAC,CAAC;QAEH,MAAM,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,EAAC,IAAI,EAAE,YAAY,EAAC,CAAC,CAAC;QAE/D,yEAAyE;QACzE,yEAAyE;QACzE,iDAAiD;QACjD,MAAM,UAAU,GAAG,SAAS,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAE5D,IAAI,CAAC,OAAO,GAAG,UAAU,CAAC;QAE1B,4CAA4C;QAC5C,SAAS,CAAC,6BAA6B,CAAC,UAAU,CAAC,CAAC;QAEpD,0BAA0B;QAC1B,SAAS,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;QAExC,4CAA4C;QAC5C,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,mBAAmB,CAAyB,GAAM;QACvD,MAAM,UAAU,GAAG,GAAmB,CAAC;QACvC,KAAK,MAAM,IAAI,IAAI,IAAA,uBAAc,GAAE,CAAC,MAAM,EAAE,EAAE,CAAC;YAC7C,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,SAAS,IAAI,IAAI,CAAC,OAAO,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC;gBACvF,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBAC7E,OAAO,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC/B,CAAC;QACH,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;;;;OAMG;IACK,MAAM,CAAC,oBAAoB,CACjC,IAAkB,EAClB,cAAwB,EAAE;QAE1B,MAAM,MAAM,GAAG,gBAAC,CAAC,MAAM,CACrB,IAAI,EACJ,CAAC,QAAQ,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE;YACvB,MAAM,IAAI,GAAG,IAAA,mBAAU,EAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAA,mBAAU,EAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAC3D,IAAI,CAAC,gBAAC,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC;gBAClC,MAAM,EAAC,IAAI,EAAC,GAAG,IAAI,CAAC;gBACpB,gBAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;YAC/B,CAAC;iBAAM,CAAC;gBACN,mDAAmD;gBACnD,QAAQ,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;YACxB,CAAC;YACD,OAAO,QAAQ,CAAC;QAClB,CAAC,EACD,EAAE,CACH,CAAC;QACF,MAAM,CAAC,kBAAU,CAAC,GAAG,WAAW,CAAC;QACjC,OAAO,MAA4B,CAAC;IACtC,CAAC;IAED;;OAEG;IACK,MAAM,CAAC,UAAU,CAAC,MAAsB;QAC9C,MAAM,CAAC,IAAI,GAAG,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE;YAC1B,IAAI,IAAI,EAAE,CAAC;gBACT,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;YACvB,CAAC;YACD,OAAO,CAAC,IAAI,EAAE,CAAC;QACjB,CAAC,CAAC;IACJ,CAAC;IAED;;OAEG;IACK,MAAM,CAAC,kBAAkB,CAAC,SAAoB;QACpD,MAAM,YAAY,GAAG,SAAS,CAAC,UAAU,CAAC,QAAQ,EAAE;YAClD,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,wBAAwB;YAC9B,WAAW,EAAE,8DAA8D;SAC5E,CAAC,CAAC;QAEH,SAAS,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;QAEnC,MAAM,UAAU,GAAG,IAAA,oBAAa,GAAE,CAAC;QACnC,KAAK,MAAM,CAAC,YAAY,EAAE,IAAI,CAAC,IAAI,UAAU,EAAE,CAAC;YAC9C,uDAAuD;YACvD,YAAY,CAAC,YAAY,CAAC,GAAG,YAAY,EAAE,EAAC,GAAG,IAAI,EAAC,CAAC,CAAC;QACxD,CAAC;QAED,OAAO,UAAU,CAAC;IACpB,CAAC;IAED;;OAEG;IACK,MAAM,CAAC,6BAA6B,CAAC,SAAoB;QAC/D,KAAK,MAAM,IAAI,IAAI,CAAC,uBAAW,EAAE,uBAAW,CAA6B,EAAE,CAAC;YAC1E,MAAM,SAAS,GAAG,SAAS,CAAC,UAAU,CAAC,IAAI,EAAE;gBAC3C,QAAQ,EAAE,IAAI;gBACd,IAAI,EAAE,iBAAiB,IAAI,GAAG;gBAC9B,WAAW,EAAE,iBAAiB,IAAI,6BAA6B;aAChE,CAAC,CAAC;YAEH,SAAS,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;YAEhC,MAAM,aAAa,GAAG,SAAS,CAAC,cAAc,CAAC;gBAC7C,IAAI,EAAE,GAAG,IAAI,SAAS;aACvB,CAAC,CAAC;YACH,MAAM,aAAa,GAAG,IAAA,uBAAgB,GAAE,CAAC;YACzC,MAAM,WAAW,GAKX;gBACJ;oBACE,OAAO,EAAE,+BAAmB;oBAC5B,IAAI,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC,IAAI;oBAC9B,IAAI,EAAE,gCAAgC,IAAI,GAAG;oBAC7C,OAAO,EAAE,CAAC,IAAI,CAAC;iBAChB;gBACD;oBACE,OAAO,EAAE,kCAAsB;oBAC/B,IAAI,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC,OAAO;oBACjC,IAAI,EAAE,aAAa,IAAI,EAAE;iBAC1B;gBACD;oBACE,OAAO,EAAE,oCAAwB;oBACjC,IAAI,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC,SAAS;oBACnC,IAAI,EAAE,eAAe,IAAI,EAAE;iBAC5B;gBACD;oBACE,OAAO,EAAE,iCAAqB;oBAC9B,IAAI,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC,MAAM;oBAChC,IAAI,EAAE,gCAAgC,IAAI,yBAAyB;iBACpE;gBACD;oBACE,OAAO,EAAE,8BAAkB;oBAC3B,IAAI,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC,GAAG;oBAC7B,IAAI,EAAE,8CAA8C,IAAI,EAAE;iBAC3D;gBACD;oBACE,OAAO,EAAE,iCAAqB;oBAC9B,IAAI,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC,MAAM;oBAChC,IAAI,EAAE,kDAAkD,IAAI,EAAE;iBAC/D;aACF,CAAC;YAEF,KAAK,MAAM,EAAC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAC,IAAI,WAAW,EAAE,CAAC;gBACzD,MAAM,MAAM,GAAG,aAAa,CAAC,UAAU,CAAC,OAAO,EAAE,EAAC,IAAI,EAAE,OAAO,EAAE,OAAO,IAAI,EAAE,EAAC,CAAC,CAAC;gBAEjF,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;gBAE7B,KAAK,MAAM,CAAC,YAAY,EAAE,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC;oBACxC,qEAAqE;oBACrE,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;wBAC9B,MAAM,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE,EAAC,GAAG,IAAI,EAAC,CAAC,CAAC;oBACnE,CAAC;yBAAM,CAAC;wBACN,MAAM,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,EAAC,GAAG,IAAI,EAAC,CAAC,CAAC;oBAClD,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED;;OAEG;IACK,MAAM,CAAC,iBAAiB,CAAC,SAAoB;QACnD,MAAM,WAAW,GAAG,SAAS,CAAC,UAAU,CAAC,OAAO,EAAE;YAChD,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,uDAAuD;YAC7D,WAAW,EACT,yFAAyF;gBACzF,IAAI,IAAA,qCAAqB,GAAE,8DAA8D;gBACzF,mFAAmF;gBACnF,+DAA+D;SAClE,CAAC,CAAC;QAGH,SAAS,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAClC,MAAM,aAAa,GAAG,WAAW,CAAC,cAAc,CAAC;YAC/C,IAAI,EAAE,cAAc;SACrB,CAAC,CAAC;QAEH,MAAM,WAAW,GAAG;YAClB;gBACE,OAAO,EAAE,iCAAiB;gBAC1B,IAAI,EACF,gCAAgC;oBAChC,aAAa,gBAAC,CAAC,IAAI,CAAC,IAAA,gCAAgB,EAAC,iCAAiB,CAAC,EAAE,GAAG,CAAC,cAAc,+BAAe,GAAG;aAChG;YACD;gBACE,OAAO,EAAE,kCAAkB;gBAC3B,IAAI,EACF,kCAAkC;oBAClC,aAAa,gBAAC,CAAC,IAAI,CAAC,IAAA,gCAAgB,EAAC,kCAAkB,CAAC,EAAE,GAAG,CAAC,cAAc,+BAAe,GAAG;aACjG;YACD;gBACE,OAAO,EAAE,kCAAkB;gBAC3B,IAAI,EACF,sCAAsC;oBACtC,aAAa,gBAAC,CAAC,IAAI,CAAC,IAAA,gCAAgB,EAAC,kCAAkB,CAAC,EAAE,GAAG,CAAC,cAAc,+BAAe,GAAG;aACjG;YACD;gBACE,OAAO,EAAE,gCAAgB;gBACzB,IAAI,EAAE,0CAA0C;aACjD;SACF,CAAC;QAEF,KAAK,MAAM,EAAC,OAAO,EAAE,IAAI,EAAC,IAAI,WAAW,EAAE,CAAC;YAC1C,MAAM,MAAM,GAAG,aAAa,CAAC,UAAU,CAAC,OAAO,EAAE,EAAC,IAAI,EAAC,CAAC,CAAC;YACzD,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QAC/B,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,SAAS,CAAC,OAAiB,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;QAC9C,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAClC,IAAI,CAAC,OAAO,CAAC,6BAAiB,CAAC,CAAC;QAClC,CAAC;QAED,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;YAClD,MAAM,CAAC,SAAS,EAAE,WAAW,CAAC,GAAG,MAAM,CAAC;YACxC,wEAAwE;YACxE,wEAAwE;YACxE,IAAI,SAAS,EAAE,aAAa,KAAK,IAAI,EAAE,CAAC;gBACtC,SAAS,CAAC,aAAa,GAAG,MAAM,CAAC;YACnC,CAAC;iBAAM,IAAI,SAAS,EAAE,aAAa,KAAK,IAAI,EAAE,CAAC;gBAC7C,SAAS,CAAC,aAAa,GAAG,MAAM,CAAC;YACnC,CAAC;YACD,IACE,WAAW,EAAE,MAAM;gBACnB,CAAC,SAAS,CAAC,aAAa,KAAK,KAAK,IAAI,SAAS,CAAC,aAAa,KAAK,KAAK,CAAC,EACxE,CAAC;gBACD,OAAO,SAAS,CAAC,oBAAoB,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;YAChE,CAAC;iBAAM,IAAI,WAAW,EAAE,MAAM,EAAE,CAAC;gBAC/B,MAAM,IAAI,KAAK,CAAC,mCAAmC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAC9E,CAAC;YACD,OAAO,SAAS,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAC;QACnD,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBACf,MAAM,GAAG,CAAC;YACZ,CAAC;YACD,kFAAkF;YAElF,0BAA0B;YAC1B,CAAC;gBACC,sCAAsC;gBACtC,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,mDAAmD;gBACpE,sCAAsC;gBACtC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;gBAC3B,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAClB,CAAC;QACH,CAAC;IACH,CAAC;CACF;AA7SD,8BA6SC;AAED;;GAEG;AACI,KAAK,UAAU,SAAS,CAAC,KAAK,GAAG,KAAK;IAC3C,MAAM,IAAA,uBAAc,GAAE,CAAC;IAEvB,OAAO,IAAI,SAAS,CAAC,KAAK,CAAC,CAAC;AAC9B,CAAC"}

package/build/lib/cli/plugin-command.d.ts

@@ -1,118 +1,78 @@
-/**
- * @extends {ExtensionCliCommand<PluginType>}
- */
-export default class PluginCliCommand extends ExtensionCliCommand<"plugin"> {
-    /**
-     *
-     * @param {import('./extension-command').ExtensionCommandOptions<PluginType>} opts
-     */
-    constructor({ config, json }: import("./extension-command").ExtensionCommandOptions<PluginType>);
+import type { ExtMetadata, ExtRecord, InstallType } from 'appium/types';
+import ExtensionCliCommand from './extension-command';
+import type { ExtensionArgs, ExtensionCommandOptions, ExtensionUpdateResult, PostInstallText, RunOutput } from './extension-command';
+type PluginInstallOpts = {
+    plugin: string;
+    installType: InstallType;
+    packageName?: string;
+};
+type PluginUninstallOpts = {
+    plugin: string;
+};
+type PluginUpdateOpts = {
+    plugin: string;
+    unsafe: boolean;
+};
+type PluginRunOptions = {
+    plugin: string;
+    scriptName: string;
+    extraArgs?: string[];
+};
+type PluginDoctorOptions = {
+    plugin: string;
+};
+export default class PluginCliCommand extends ExtensionCliCommand<'plugin'> {
+    constructor({ config, json }: ExtensionCommandOptions<'plugin'>);
     /**
      * Install a plugin
      *
-     * @param {PluginInstallOpts} opts
-     * @returns {Promise<ExtRecord<PluginType>>}
+     * @param opts - install options
      */
-    install({ plugin, installType, packageName }: PluginInstallOpts): Promise<ExtRecord<PluginType>>;
+    install({ plugin, installType, packageName }: PluginInstallOpts): Promise<ExtRecord<'plugin'>>;
     /**
      * Uninstall a plugin
      *
-     * @param {PluginUninstallOpts} opts
-     * @returns {Promise<ExtRecord<PluginType>>}
+     * @param opts - uninstall options
      */
-    uninstall({ plugin }: PluginUninstallOpts): Promise<ExtRecord<PluginType>>;
+    uninstall({ plugin }: PluginUninstallOpts): Promise<ExtRecord<'plugin'>>;
     /**
      * Update a plugin
      *
-     * @param {PluginUpdateOpts} opts
-     * @returns {Promise<import('./extension-command').ExtensionUpdateResult>}
+     * @param opts - update options
      */
-    update({ plugin, unsafe }: PluginUpdateOpts): Promise<import("./extension-command").ExtensionUpdateResult>;
+    update({ plugin, unsafe }: PluginUpdateOpts): Promise<ExtensionUpdateResult>;
     /**
      * Run a script from a plugin
      *
-     * @param {PluginRunOptions} opts
-     * @returns {Promise<import('./extension-command').RunOutput>}
+     * @param opts - script execution options
      * @throws {Error} if the script fails to run
      */
-    run({ plugin, scriptName, extraArgs }: PluginRunOptions): Promise<import("./extension-command").RunOutput>;
+    run({ plugin, scriptName, extraArgs }: PluginRunOptions): Promise<RunOutput>;
     /**
      * Runs doctor checks for the given plugin
      *
-     * @param {PluginDoctorOptions} opts
-     * @returns {Promise<number>} The amount of executed doctor checks.
+     * @param opts - doctor command options
+     * @returns The amount of executed doctor checks.
      * @throws {Error} If any of the mandatory Doctor checks fails.
      */
     doctor({ plugin }: PluginDoctorOptions): Promise<number>;
-}
-export type ExtensionType = import("@appium/types").ExtensionType;
-export type PluginType = import("@appium/types").PluginType;
-export type ExtRecord<ExtType extends ExtensionType> = import("appium/types").ExtRecord<ExtType>;
-/**
- * Options for {@linkcode PluginCliCommand.install}
- */
-export type PluginInstallOpts = {
     /**
-     * - the name or spec of a plugin to install
-     */
-    plugin: string;
-    /**
-     * - how to install this plugin. One of the INSTALL_TYPES
-     */
-    installType: InstallType;
-    /**
-     * - for git/github installs, the plugin node package name
-     */
-    packageName?: string | undefined;
-};
-export type InstallType = import("appium/types").InstallType;
-/**
- * Options for {@linkcode PluginCliCommand.uninstall}
- */
-export type PluginUninstallOpts = {
-    /**
-     * - the name or spec of a plugin to uninstall
-     */
-    plugin: string;
-};
-/**
- * Options for {@linkcode PluginCliCommand.update}
- */
-export type PluginUpdateOpts = {
-    /**
-     * - the name of the plugin to update
-     */
-    plugin: string;
-    /**
-     * - if true, will perform unsafe updates past major revision boundaries
-     */
-    unsafe: boolean;
-};
-/**
- * Options for {@linkcode PluginCliCommand.run}.
- */
-export type PluginRunOptions = {
-    /**
-     * - name of the plugin to run a script from
-     */
-    plugin: string;
-    /**
-     * - name of the script to run
-     */
-    scriptName: string;
-    /**
-     * - arguments to pass to the script
+     * Builds the success message displayed after a plugin installation.
+     *
+     * @param args - installed extension name and metadata
+     * @returns formatted success text
      */
-    extraArgs?: string[] | undefined;
-};
-/**
- * Options for {@linkcode PluginCliCommand.doctor}.
- */
-export type PluginDoctorOptions = {
+    getPostInstallText({ extName, extData }: ExtensionArgs<'plugin'>): PostInstallText;
     /**
-     * - name of the plugin to run doctor checks for
+     * Validates fields in `appium` field of `pluginMetadata`
+     *
+     * For any `package.json` fields which a plugin requires, validate the type of
+     * those fields on the `package.json` data, throwing an error if anything is
+     * amiss.
+     * @param pluginMetadata - `appium` metadata from extension package
+     * @param installSpec - install spec from CLI
      */
-    plugin: string;
-};
-import ExtensionCliCommand from './extension-command';
+    validateExtensionFields(pluginMetadata: ExtMetadata<'plugin'>, installSpec: string): void;
+}
+export {};
 //# sourceMappingURL=plugin-command.d.ts.map

package/build/lib/cli/plugin-command.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"plugin-command.d.ts","sourceRoot":"","sources":["../../../lib/cli/plugin-command.js"],"names":[],"mappings":"AAMA;;GAEG;AACH;IACE;;;OAGG;IACH,8BAFW,OAAO,qBAAqB,EAAE,uBAAuB,CAAC,UAAU,CAAC,EAK3E;IAED;;;;;OAKG;IACH,8CAHW,iBAAiB,GACf,OAAO,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAQ1C;IAED;;;;;OAKG;IACH,sBAHW,mBAAmB,GACjB,OAAO,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAI1C;IAED;;;;;OAKG;IACH,2BAHW,gBAAgB,GACd,OAAO,CAAC,OAAO,qBAAqB,EAAE,qBAAqB,CAAC,CAIxE;IAED;;;;;;OAMG;IACH,uCAJW,gBAAgB,GACd,OAAO,CAAC,OAAO,qBAAqB,EAAE,SAAS,CAAC,CAU5D;IAED;;;;;;OAMG;IACH,mBAJW,mBAAmB,GACjB,OAAO,CAAC,MAAM,CAAC,CAO3B;CAkCF;4BAGY,OAAO,eAAe,EAAE,aAAa;yBACrC,OAAO,eAAe,EAAE,UAAU;sBAIlB,OAAO,SAAtB,aAAc,IACf,OAAO,cAAc,EAAE,SAAS,CAAC,OAAO,CAAC;;;;;;;;YAMxC,MAAM;;;;iBACN,WAAW;;;;;;0BAKZ,OAAO,cAAc,EAAE,WAAW;;;;;;;;YAMjC,MAAM;;;;;;;;;YAMN,MAAM;;;;YACN,OAAO;;;;;;;;;YAMP,MAAM;;;;gBACN,MAAM;;;;;;;;;;;;;YAON,MAAM;;gCAjKY,qBAAqB"}
+{"version":3,"file":"plugin-command.d.ts","sourceRoot":"","sources":["../../../lib/cli/plugin-command.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAC,WAAW,EAAE,SAAS,EAAE,WAAW,EAAC,MAAM,cAAc,CAAC;AACtE,OAAO,mBAAmB,MAAM,qBAAqB,CAAC;AACtD,OAAO,KAAK,EACV,aAAa,EACb,uBAAuB,EACvB,qBAAqB,EACrB,eAAe,EACf,SAAS,EACV,MAAM,qBAAqB,CAAC;AAI7B,KAAK,iBAAiB,GAAG;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,WAAW,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAC,CAAC;AAC1F,KAAK,mBAAmB,GAAG;IAAC,MAAM,EAAE,MAAM,CAAA;CAAC,CAAC;AAC5C,KAAK,gBAAgB,GAAG;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,OAAO,CAAA;CAAC,CAAC;AAC1D,KAAK,gBAAgB,GAAG;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,UAAU,EAAE,MAAM,CAAC;IAAC,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;CAAC,CAAC;AACnF,KAAK,mBAAmB,GAAG;IAAC,MAAM,EAAE,MAAM,CAAA;CAAC,CAAC;AAE5C,MAAM,CAAC,OAAO,OAAO,gBAAiB,SAAQ,mBAAmB,CAAC,QAAQ,CAAC;gBAC7D,EAAC,MAAM,EAAE,IAAI,EAAC,EAAE,uBAAuB,CAAC,QAAQ,CAAC;IAK7D;;;;OAIG;IACG,OAAO,CAAC,EAAC,MAAM,EAAE,WAAW,EAAE,WAAW,EAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;IAQlG;;;;OAIG;IACG,SAAS,CAAC,EAAC,MAAM,EAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;IAI5E;;;;OAIG;IACG,MAAM,CAAC,EAAC,MAAM,EAAE,MAAM,EAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAIhF;;;;;OAKG;IACG,GAAG,CAAC,EAAC,MAAM,EAAE,UAAU,EAAE,SAAS,EAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,SAAS,CAAC;IAShF;;;;;;OAMG;IACG,MAAM,CAAC,EAAC,MAAM,EAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,MAAM,CAAC;IAM5D;;;;;OAKG;IACM,kBAAkB,CAAC,EAAC,OAAO,EAAE,OAAO,EAAC,EAAE,aAAa,CAAC,QAAQ,CAAC,GAAG,eAAe;IAIzF;;;;;;;;OAQG;IACM,uBAAuB,CAAC,cAAc,EAAE,WAAW,CAAC,QAAQ,CAAC,EAAE,WAAW,EAAE,MAAM,GAAG,IAAI;CAanG"}

package/build/lib/cli/plugin-command.js

@@ -7,14 +7,7 @@ const lodash_1 = __importDefault(require("lodash"));
 const extension_command_1 = __importDefault(require("./extension-command"));
 const constants_1 = require("../constants");
 const REQ_PLUGIN_FIELDS = ['pluginName', 'mainClass'];
-/**
- * @extends {ExtensionCliCommand<PluginType>}
- */
 class PluginCliCommand extends extension_command_1.default {
-    /**
-     *
-     * @param {import('./extension-command').ExtensionCommandOptions<PluginType>} opts
-     */
     constructor({ config, json }) {
         super({ config, json });
         this.knownExtensions = constants_1.KNOWN_PLUGINS;
@@ -22,8 +15,7 @@ class PluginCliCommand extends extension_command_1.default {
     /**
      * Install a plugin
      *
-     * @param {PluginInstallOpts} opts
-     * @returns {Promise<ExtRecord<PluginType>>}
+     * @param opts - install options
      */
     async install({ plugin, installType, packageName }) {
         return await super._install({
@@ -35,8 +27,7 @@ class PluginCliCommand extends extension_command_1.default {
     /**
      * Uninstall a plugin
      *
-     * @param {PluginUninstallOpts} opts
-     * @returns {Promise<ExtRecord<PluginType>>}
+     * @param opts - uninstall options
      */
     async uninstall({ plugin }) {
         return await super._uninstall({ installSpec: plugin });
@@ -44,8 +35,7 @@ class PluginCliCommand extends extension_command_1.default {
     /**
      * Update a plugin
      *
-     * @param {PluginUpdateOpts} opts
-     * @returns {Promise<import('./extension-command').ExtensionUpdateResult>}
+     * @param opts - update options
      */
     async update({ plugin, unsafe }) {
         return await super._update({ installSpec: plugin, unsafe });
@@ -53,8 +43,7 @@ class PluginCliCommand extends extension_command_1.default {
     /**
      * Run a script from a plugin
      *
-     * @param {PluginRunOptions} opts
-     * @returns {Promise<import('./extension-command').RunOutput>}
+     * @param opts - script execution options
      * @throws {Error} if the script fails to run
      */
     async run({ plugin, scriptName, extraArgs }) {
@@ -68,8 +57,8 @@ class PluginCliCommand extends extension_command_1.default {
     /**
      * Runs doctor checks for the given plugin
      *
-     * @param {PluginDoctorOptions} opts
-     * @returns {Promise<number>} The amount of executed doctor checks.
+     * @param opts - doctor command options
+     * @returns The amount of executed doctor checks.
      * @throws {Error} If any of the mandatory Doctor checks fails.
      */
     async doctor({ plugin }) {
@@ -78,9 +67,10 @@ class PluginCliCommand extends extension_command_1.default {
         });
     }
     /**
+     * Builds the success message displayed after a plugin installation.
      *
-     * @param {import('./extension-command').ExtensionArgs} opts
-     * @returns {string}
+     * @param args - installed extension name and metadata
+     * @returns formatted success text
      */
     getPostInstallText({ extName, extData }) {
         return `Plugin ${extName}@${extData.version} successfully installed`.green;
@@ -91,9 +81,8 @@ class PluginCliCommand extends extension_command_1.default {
      * For any `package.json` fields which a plugin requires, validate the type of
      * those fields on the `package.json` data, throwing an error if anything is
      * amiss.
-     * @param {import('appium/types').ExtMetadata<PluginType>} pluginMetadata
-     * @param {string} installSpec
-     * @returns {void}
+     * @param pluginMetadata - `appium` metadata from extension package
+     * @param installSpec - install spec from CLI
      */
     validateExtensionFields(pluginMetadata, installSpec) {
         const missingFields = REQ_PLUGIN_FIELDS.reduce((acc, field) => (pluginMetadata[field] ? acc : [...acc, field]), []);
@@ -104,45 +93,4 @@ class PluginCliCommand extends extension_command_1.default {
     }
 }
 exports.default = PluginCliCommand;
-/**
- * @typedef {import('@appium/types').ExtensionType} ExtensionType
- * @typedef {import('@appium/types').PluginType} PluginType
- */
-/**
- * @template {ExtensionType} ExtType
- * @typedef {import('appium/types').ExtRecord<ExtType>} ExtRecord
- */
-/**
- * Options for {@linkcode PluginCliCommand.install}
- * @typedef PluginInstallOpts
- * @property {string} plugin - the name or spec of a plugin to install
- * @property {InstallType} installType - how to install this plugin. One of the INSTALL_TYPES
- * @property {string} [packageName] - for git/github installs, the plugin node package name
- */
-/**
- * @typedef {import('appium/types').InstallType} InstallType
- */
-/**
- * Options for {@linkcode PluginCliCommand.uninstall}
- * @typedef PluginUninstallOpts
- * @property {string} plugin - the name or spec of a plugin to uninstall
- */
-/**
- * Options for {@linkcode PluginCliCommand.update}
- * @typedef PluginUpdateOpts
- * @property {string} plugin - the name of the plugin to update
- * @property {boolean} unsafe - if true, will perform unsafe updates past major revision boundaries
- */
-/**
- * Options for {@linkcode PluginCliCommand.run}.
- * @typedef PluginRunOptions
- * @property {string} plugin - name of the plugin to run a script from
- * @property {string} scriptName - name of the script to run
- * @property {string[]} [extraArgs] - arguments to pass to the script
- */
-/**
- * Options for {@linkcode PluginCliCommand.doctor}.
- * @typedef PluginDoctorOptions
- * @property {string} plugin - name of the plugin to run doctor checks for
- */
 //# sourceMappingURL=plugin-command.js.map

package/build/lib/cli/plugin-command.js.map

@@ -1 +1 @@
-{"version":3,"file":"plugin-command.js","sourceRoot":"","sources":["../../../lib/cli/plugin-command.js"],"names":[],"mappings":";;;;;AAAA,oDAAuB;AACvB,4EAAsD;AACtD,4CAA2C;AAE3C,MAAM,iBAAiB,GAAG,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;AAEtD;;GAEG;AACH,MAAqB,gBAAiB,SAAQ,2BAAmB;IAC/D;;;OAGG;IACH,YAAY,EAAC,MAAM,EAAE,IAAI,EAAC;QACxB,KAAK,CAAC,EAAC,MAAM,EAAE,IAAI,EAAC,CAAC,CAAC;QACtB,IAAI,CAAC,eAAe,GAAG,yBAAa,CAAC;IACvC,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,OAAO,CAAC,EAAC,MAAM,EAAE,WAAW,EAAE,WAAW,EAAC;QAC9C,OAAO,MAAM,KAAK,CAAC,QAAQ,CAAC;YAC1B,WAAW,EAAE,MAAM;YACnB,WAAW;YACX,WAAW;SACZ,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,SAAS,CAAC,EAAC,MAAM,EAAC;QACtB,OAAO,MAAM,KAAK,CAAC,UAAU,CAAC,EAAC,WAAW,EAAE,MAAM,EAAC,CAAC,CAAC;IACvD,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CAAC,EAAC,MAAM,EAAE,MAAM,EAAC;QAC3B,OAAO,MAAM,KAAK,CAAC,OAAO,CAAC,EAAC,WAAW,EAAE,MAAM,EAAE,MAAM,EAAC,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,GAAG,CAAC,EAAC,MAAM,EAAE,UAAU,EAAE,SAAS,EAAC;QACvC,OAAO,MAAM,KAAK,CAAC,IAAI,CAAC;YACtB,WAAW,EAAE,MAAM;YACnB,UAAU;YACV,SAAS;YACT,YAAY,EAAE,IAAI,CAAC,YAAY;SAChC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CAAC,EAAC,MAAM,EAAC;QACnB,OAAO,MAAM,KAAK,CAAC,OAAO,CAAC;YACzB,WAAW,EAAE,MAAM;SACpB,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,kBAAkB,CAAC,EAAC,OAAO,EAAE,OAAO,EAAC;QACnC,OAAO,UAAU,OAAO,IAAI,OAAO,CAAC,OAAO,yBAAyB,CAAC,KAAK,CAAC;IAC7E,CAAC;IAED;;;;;;;;;OASG;IACH,uBAAuB,CAAC,cAAc,EAAE,WAAW;QACjD,MAAM,aAAa,GAAG,iBAAiB,CAAC,MAAM,CAC5C,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,EAAE,KAAK,CAAC,CAAC,EAC/D,EAAE,CACH,CAAC;QAEF,IAAI,CAAC,gBAAC,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CACb,qBAAqB,WAAW,oDAAoD;gBAClF,gCAAgC,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,CAClE,CAAC;QACJ,CAAC;IACH,CAAC;CACF;AAzGD,mCAyGC;AAED;;;GAGG;AAEH;;;GAGG;AAEH;;;;;;GAMG;AAEH;;GAEG;AAEH;;;;GAIG;AAEH;;;;;GAKG;AAEH;;;;;;GAMG;AAEH;;;;GAIG"}
+{"version":3,"file":"plugin-command.js","sourceRoot":"","sources":["../../../lib/cli/plugin-command.ts"],"names":[],"mappings":";;;;;AAAA,oDAAuB;AAEvB,4EAAsD;AAQtD,4CAA2C;AAE3C,MAAM,iBAAiB,GAAG,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;AAOtD,MAAqB,gBAAiB,SAAQ,2BAA6B;IACzE,YAAY,EAAC,MAAM,EAAE,IAAI,EAAoC;QAC3D,KAAK,CAAC,EAAC,MAAM,EAAE,IAAI,EAAC,CAAC,CAAC;QACtB,IAAI,CAAC,eAAe,GAAG,yBAAa,CAAC;IACvC,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,OAAO,CAAC,EAAC,MAAM,EAAE,WAAW,EAAE,WAAW,EAAoB;QACjE,OAAO,MAAM,KAAK,CAAC,QAAQ,CAAC;YAC1B,WAAW,EAAE,MAAM;YACnB,WAAW;YACX,WAAW;SACZ,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,SAAS,CAAC,EAAC,MAAM,EAAsB;QAC3C,OAAO,MAAM,KAAK,CAAC,UAAU,CAAC,EAAC,WAAW,EAAE,MAAM,EAAC,CAAC,CAAC;IACvD,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM,CAAC,EAAC,MAAM,EAAE,MAAM,EAAmB;QAC7C,OAAO,MAAM,KAAK,CAAC,OAAO,CAAC,EAAC,WAAW,EAAE,MAAM,EAAE,MAAM,EAAC,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,GAAG,CAAC,EAAC,MAAM,EAAE,UAAU,EAAE,SAAS,EAAmB;QACzD,OAAO,MAAM,KAAK,CAAC,IAAI,CAAC;YACtB,WAAW,EAAE,MAAM;YACnB,UAAU;YACV,SAAS;YACT,YAAY,EAAE,IAAI,CAAC,YAAY;SAChC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CAAC,EAAC,MAAM,EAAsB;QACxC,OAAO,MAAM,KAAK,CAAC,OAAO,CAAC;YACzB,WAAW,EAAE,MAAM;SACpB,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACM,kBAAkB,CAAC,EAAC,OAAO,EAAE,OAAO,EAA0B;QACrE,OAAO,UAAU,OAAO,IAAI,OAAO,CAAC,OAAO,yBAAyB,CAAC,KAAK,CAAC;IAC7E,CAAC;IAED;;;;;;;;OAQG;IACM,uBAAuB,CAAC,cAAqC,EAAE,WAAmB;QACzF,MAAM,aAAa,GAAG,iBAAiB,CAAC,MAAM,CAC5C,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,EAAE,KAAK,CAAC,CAAC,EAC/D,EAAE,CACH,CAAC;QAEF,IAAI,CAAC,gBAAC,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CACb,qBAAqB,WAAW,oDAAoD;gBAClF,gCAAgC,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,CAClE,CAAC;QACJ,CAAC;IACH,CAAC;CACF;AAjGD,mCAiGC"}