@appium/docutils 0.1.6 → 0.2.1

package/build/lib/builder/reference.js

@@ -0,0 +1,129 @@
+"use strict";
+/**
+ * Builds reference documentation via TypeDoc.  The output is _markdown_, intended to be imported into MkDocs.
+ *
+ * @module
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildReferenceDocs = exports.runTypedoc = void 0;
+const support_1 = require("@appium/support");
+const glob_1 = __importDefault(require("glob"));
+const lodash_1 = __importDefault(require("lodash"));
+const node_path_1 = __importDefault(require("node:path"));
+const typedoc_1 = require("typedoc");
+const constants_1 = require("../constants");
+const error_1 = require("../error");
+const fs_1 = require("../fs");
+const logger_1 = __importDefault(require("../logger"));
+const util_1 = require("../util");
+const log = logger_1.default.withTag('builder:reference');
+/**
+ * Replaces TypeDoc's homebrew "glob" implementation with a real one
+ *
+ * This cannot be done via `require('typedoc')` or `import` due to the file being excluded
+ * from the export map in its `package.json`.
+ * @see https://github.com/TypeStrong/typedoc/issues/2151
+ */
+const monkeyPatchTypedoc = lodash_1.default.once(async () => {
+    const typedocDir = await (0, fs_1.findPkgDir)(require.resolve('typedoc'));
+    if (!typedocDir) {
+        throw new error_1.DocutilsError('Could not find TypeDoc package directory; is it installed?');
+    }
+    const tdFs = require(node_path_1.default.join(typedocDir, 'dist', 'lib', 'utils', 'fs.js'));
+    tdFs.glob = glob_1.default.sync;
+});
+/**
+ * Executes TypeDoc _in the current process_
+ *
+ * You will probably want to run `updateNav()` after this.
+ *
+ * @privateRemarks Monkeypatches TypeDoc's homebrew "glob" implementation because it is broken
+ * @parma typeDocJsonPath - Path to `typedoc.json`
+ * @param opts - TypeDoc options
+ */
+async function runTypedoc(typeDocJsonPath, opts) {
+    await monkeyPatchTypedoc();
+    log.debug('Monkeypatched TypeDoc');
+    const args = (0, util_1.argify)(opts);
+    log.debug('TypeDoc args:', args);
+    const app = new typedoc_1.Application();
+    app.options.setValue('plugin', [
+        'typedoc-plugin-markdown',
+        'typedoc-plugin-resolve-crossmodule-references',
+        '@appium/typedoc-plugin-appium',
+    ]);
+    app.options.addReader(new typedoc_1.TypeDocReader());
+    app.options.addReader(new typedoc_1.ArgumentsReader(100, args));
+    app.bootstrap({ options: node_path_1.default.dirname(typeDocJsonPath) });
+    const out = app.options.getValue('out');
+    const project = app.convert();
+    if (project) {
+        return await app.generateDocs(project, out);
+    }
+    throw new error_1.DocutilsError('TypeDoc found nothing to document. Is your package empty?');
+}
+exports.runTypedoc = runTypedoc;
+/**
+ * Mapping of whatever our log level is to whatever TypeDoc's should be.
+ *
+ * TypeDoc's "info" is too verbose for our needs, and it's our default, so
+ * we map it to "warn".
+ */
+const TypeDocLogLevelMap = {
+    debug: 'Verbose',
+    info: 'Warn',
+    warn: 'Warn',
+    error: 'Error',
+};
+/**
+ * Build reference documentation via TypeDoc
+ * @param opts - Options
+ */
+async function buildReferenceDocs({ typedocJson: typeDocJsonPath, cwd = process.cwd(), tsconfigJson: tsconfig, logLevel = constants_1.DEFAULT_LOG_LEVEL, title, } = {}) {
+    const stop = (0, util_1.stopwatch)('buildReferenceDocs');
+    typeDocJsonPath = typeDocJsonPath
+        ? node_path_1.default.resolve(cwd, typeDocJsonPath)
+        : await (0, fs_1.findTypeDocJsonPath)(cwd);
+    if (!typeDocJsonPath) {
+        throw new error_1.DocutilsError(`Could not find ${constants_1.NAME_TYPEDOC_JSON} from ${cwd}; run "${constants_1.NAME_BIN}" to create it`);
+    }
+    const pkgRoot = support_1.fs.findRoot(cwd);
+    const relativePath = (0, util_1.relative)(cwd);
+    const relativeTypeDocJsonPath = relativePath(typeDocJsonPath);
+    log.debug(`Using ${relativeTypeDocJsonPath} as typedoc.json`);
+    let typeDocJson;
+    // we only need typedoc.json to make sure we have a custom "out" path.
+    try {
+        typeDocJson = (0, fs_1.readTypedocJson)(typeDocJsonPath);
+        log.debug('Contents of %s: %O', relativeTypeDocJsonPath, typeDocJson);
+    }
+    catch (err) {
+        log.error(err);
+        throw new error_1.DocutilsError(`Could not read ${relativeTypeDocJsonPath}; run "${constants_1.NAME_BIN} init" to create it`);
+    }
+    // if for some reason "out" is not in typedoc.json, we want to use our default path.
+    // otherwise, typedoc's default behavior is to write to the "docs" dir, which is the same dir that
+    // we use (by default) as a source dir for the mkdocs site--which might contain files under vcs.
+    let out;
+    if (typeDocJson.out) {
+        log.debug(`Found "out" option in ${constants_1.NAME_TYPEDOC_JSON}: ${typeDocJson.out}`);
+    }
+    else {
+        out = node_path_1.default.relative(node_path_1.default.dirname(typeDocJsonPath), node_path_1.default.join(pkgRoot, constants_1.DEFAULT_REL_TYPEDOC_OUT_PATH));
+        log.debug('Setting "out" option to %s', out);
+    }
+    const extraTypedocOpts = lodash_1.default.pickBy({ tsconfig, name: title, out, logLevel: TypeDocLogLevelMap[logLevel] }, Boolean);
+    try {
+        await runTypedoc(typeDocJsonPath, extraTypedocOpts);
+        let finalOut = (typeDocJson.out ?? out);
+        log.success('Reference docs built at %s (%dms)', node_path_1.default.isAbsolute(finalOut) ? relativePath(finalOut) : finalOut, stop());
+    }
+    catch (err) {
+        log.error(err);
+    }
+}
+exports.buildReferenceDocs = buildReferenceDocs;
+//# sourceMappingURL=reference.js.map

package/build/lib/builder/reference.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reference.js","sourceRoot":"","sources":["../../../lib/builder/reference.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;;;;AAEH,6CAAmC;AACnC,gDAAwB;AACxB,oDAAuB;AACvB,0DAA6B;AAC7B,qCAAoF;AACpF,4CAKsB;AACtB,oCAAuC;AACvC,8BAAuE;AACvE,uDAA+B;AAC/B,kCAAoD;AAEpD,MAAM,GAAG,GAAG,gBAAM,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;AAEhD;;;;;;GAMG;AACH,MAAM,kBAAkB,GAAG,gBAAC,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE;IAC3C,MAAM,UAAU,GAAG,MAAM,IAAA,eAAU,EAAC,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC;IAChE,IAAI,CAAC,UAAU,EAAE;QACf,MAAM,IAAI,qBAAa,CAAC,4DAA4D,CAAC,CAAC;KACvF;IACD,MAAM,IAAI,GAAG,OAAO,CAAC,mBAAI,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;IAC7E,IAAI,CAAC,IAAI,GAAG,cAAI,CAAC,IAAI,CAAC;AACxB,CAAC,CAAC,CAAC;AAEH;;;;;;;;GAQG;AACI,KAAK,UAAU,UAAU,CAAC,eAAuB,EAAE,IAA4B;IACpF,MAAM,kBAAkB,EAAE,CAAC;IAC3B,GAAG,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAC;IAEnC,MAAM,IAAI,GAAG,IAAA,aAAM,EAAC,IAAI,CAAC,CAAC;IAC1B,GAAG,CAAC,KAAK,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;IACjC,MAAM,GAAG,GAAG,IAAI,qBAAW,EAAE,CAAC;IAC9B,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,EAAE;QAC7B,yBAAyB;QACzB,+CAA+C;QAC/C,+BAA+B;KAChC,CAAC,CAAC;IACH,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,uBAAa,EAAE,CAAC,CAAC;IAC3C,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,yBAAe,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC;IACtD,GAAG,CAAC,SAAS,CAAC,EAAC,OAAO,EAAE,mBAAI,CAAC,OAAO,CAAC,eAAe,CAAC,EAAC,CAAC,CAAC;IACxD,MAAM,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACxC,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,EAAE,CAAC;IAC9B,IAAI,OAAO,EAAE;QACX,OAAO,MAAM,GAAG,CAAC,YAAY,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;KAC7C;IAED,MAAM,IAAI,qBAAa,CAAC,2DAA2D,CAAC,CAAC;AACvF,CAAC;AAtBD,gCAsBC;AAuCD;;;;;GAKG;AACH,MAAM,kBAAkB,GAAiC;IACvD,KAAK,EAAE,SAAS;IAChB,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,MAAM;IACZ,KAAK,EAAE,OAAO;CACf,CAAC;AAEF;;;GAGG;AACI,KAAK,UAAU,kBAAkB,CAAC,EACvC,WAAW,EAAE,eAAe,EAC5B,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,EACnB,YAAY,EAAE,QAAQ,EACtB,QAAQ,GAAG,6BAAiB,EAC5B,KAAK,MACoB,EAAE;IAC3B,MAAM,IAAI,GAAG,IAAA,gBAAS,EAAC,oBAAoB,CAAC,CAAC;IAC7C,eAAe,GAAG,eAAe;QAC/B,CAAC,CAAC,mBAAI,CAAC,OAAO,CAAC,GAAG,EAAE,eAAe,CAAC;QACpC,CAAC,CAAC,MAAM,IAAA,wBAAmB,EAAC,GAAG,CAAC,CAAC;IACnC,IAAI,CAAC,eAAe,EAAE;QACpB,MAAM,IAAI,qBAAa,CACrB,kBAAkB,6BAAiB,SAAS,GAAG,UAAU,oBAAQ,gBAAgB,CAClF,CAAC;KACH;IACD,MAAM,OAAO,GAAG,YAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IACjC,MAAM,YAAY,GAAG,IAAA,eAAQ,EAAC,GAAG,CAAC,CAAC;IACnC,MAAM,uBAAuB,GAAG,YAAY,CAAC,eAAe,CAAC,CAAC;IAC9D,GAAG,CAAC,KAAK,CAAC,SAAS,uBAAuB,kBAAkB,CAAC,CAAC;IAE9D,IAAI,WAA8C,CAAC;IACnD,sEAAsE;IACtE,IAAI;QACF,WAAW,GAAG,IAAA,oBAAe,EAAC,eAAe,CAAC,CAAC;QAC/C,GAAG,CAAC,KAAK,CAAC,oBAAoB,EAAE,uBAAuB,EAAE,WAAW,CAAC,CAAC;KACvE;IAAC,OAAO,GAAG,EAAE;QACZ,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACf,MAAM,IAAI,qBAAa,CACrB,kBAAkB,uBAAuB,UAAU,oBAAQ,qBAAqB,CACjF,CAAC;KACH;IAED,oFAAoF;IACpF,kGAAkG;IAClG,gGAAgG;IAChG,IAAI,GAAuB,CAAC;IAC5B,IAAI,WAAW,CAAC,GAAG,EAAE;QACnB,GAAG,CAAC,KAAK,CAAC,yBAAyB,6BAAiB,KAAK,WAAW,CAAC,GAAG,EAAE,CAAC,CAAC;KAC7E;SAAM;QACL,GAAG,GAAG,mBAAI,CAAC,QAAQ,CACjB,mBAAI,CAAC,OAAO,CAAC,eAAe,CAAC,EAC7B,mBAAI,CAAC,IAAI,CAAC,OAAO,EAAE,wCAA4B,CAAC,CACjD,CAAC;QACF,GAAG,CAAC,KAAK,CAAC,4BAA4B,EAAE,GAAG,CAAC,CAAC;KAC9C;IAED,MAAM,gBAAgB,GAAG,gBAAC,CAAC,MAAM,CAC/B,EAAC,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,QAAQ,EAAE,kBAAkB,CAAC,QAAQ,CAAC,EAAC,EACpE,OAAO,CACkB,CAAC;IAE5B,IAAI;QACF,MAAM,UAAU,CAAC,eAAe,EAAE,gBAAgB,CAAC,CAAC;QACpD,IAAI,QAAQ,GAAG,CAAC,WAAW,CAAC,GAAG,IAAI,GAAG,CAAW,CAAC;QAClD,GAAG,CAAC,OAAO,CACT,mCAAmC,EACnC,mBAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,EAC7D,IAAI,EAAE,CACP,CAAC;KACH;IAAC,OAAO,GAAG,EAAE;QACZ,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;KAChB;AACH,CAAC;AA/DD,gDA+DC"}

package/build/lib/builder/site.d.ts

@@ -0,0 +1,55 @@
+/**
+ * Runs `mkdocs`, pulling in reference markdown from TypeDoc and any other documentation from the
+ * `docs_dir` directory (as configured in `mkdocs.yml`).
+ *
+ * @module
+ */
+import { TeenProcessExecOptions } from 'teen_process';
+import { TeenProcessSubprocessStartOpts } from '../util';
+/**
+ * Runs `mkdocs build` or `mkdocs serve`
+ * @param opts
+ */
+export declare function buildSite({ mkdocsYml: mkDocsYmlPath, siteDir, theme, cwd, serve, serveOpts, execOpts, }?: BuildMkDocsOpts): Promise<void>;
+/**
+ * Options for {@linkcode buildSite}.
+ */
+export interface BuildMkDocsOpts {
+    /**
+     * Path to `mkdocs.yml`
+     */
+    mkdocsYml?: string;
+    /**
+     * Path to output directory
+     */
+    siteDir?: string;
+    /**
+     * MkDocs theme to use
+     * @defaultValue 'mkdocs'
+     */
+    theme?: string;
+    /**
+     * Current working directory
+     * @defaultValue `process.cwd()`
+     */
+    cwd?: string;
+    /**
+     * Path to `package.json`
+     *
+     * Used to find `mkdocs.yml` if unspecified.
+     */
+    packageJson?: string;
+    /**
+     * If `true`, run `mkdocs serve` instead of `mkdocs build`
+     */
+    serve?: boolean;
+    /**
+     * Extra options for {@linkcode teen_process.exec}
+     */
+    execOpts?: TeenProcessExecOptions;
+    /**
+     * Extra options for {@linkcode teen_process.Subprocess.start}
+     */
+    serveOpts?: TeenProcessSubprocessStartOpts;
+}
+//# sourceMappingURL=site.d.ts.map

package/build/lib/builder/site.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"site.d.ts","sourceRoot":"","sources":["../../../lib/builder/site.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EAAmB,sBAAsB,EAAC,MAAM,cAAc,CAAC;AAKtE,OAAO,EAAsB,8BAA8B,EAAC,MAAM,SAAS,CAAC;AAuC5E;;;GAGG;AACH,wBAAsB,SAAS,CAAC,EAC9B,SAAS,EAAE,aAAa,EACxB,OAAO,EACP,KAAmB,EACnB,GAAmB,EACnB,KAAa,EACb,SAAS,EACT,QAAQ,GACT,GAAE,eAAoB,iBA6BtB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,QAAQ,CAAC,EAAE,sBAAsB,CAAC;IAElC;;OAEG;IACH,SAAS,CAAC,EAAE,8BAA8B,CAAC;CAC5C"}

package/build/lib/builder/site.js

@@ -0,0 +1,81 @@
+"use strict";
+/**
+ * Runs `mkdocs`, pulling in reference markdown from TypeDoc and any other documentation from the
+ * `docs_dir` directory (as configured in `mkdocs.yml`).
+ *
+ * @module
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildSite = void 0;
+const node_path_1 = __importDefault(require("node:path"));
+const teen_process_1 = require("teen_process");
+const constants_1 = require("../constants");
+const error_1 = require("../error");
+const fs_1 = require("../fs");
+const logger_1 = __importDefault(require("../logger"));
+const util_1 = require("../util");
+const log = logger_1.default.withTag('mkdocs');
+/**
+ * Runs `mkdocs serve`
+ * @param args Extra args to `mkdocs build`
+ * @param opts Extra options for `teen_process.Subprocess.start`
+ * @param mkDocsPath Path to `mkdocs` executable
+ */
+async function doServe(args = [], { startDetector, detach, timeoutMs } = {}, mkDocsPath) {
+    mkDocsPath = mkDocsPath ?? (await (0, fs_1.whichMkDocs)());
+    const finalArgs = ['serve', ...args];
+    log.debug('Launching %s with args: %O', mkDocsPath, finalArgs);
+    const proc = new teen_process_1.SubProcess(mkDocsPath, finalArgs);
+    return await proc.start(startDetector, detach, timeoutMs);
+}
+/**
+ * Runs `mkdocs build`
+ * @param args Extra args to `mkdocs build`
+ * @param opts Extra options to `teen_process.exec`
+ * @param mkDocsPath Path to `mkdocs` executable
+ */
+async function doBuild(args = [], opts = {}, mkDocsPath) {
+    mkDocsPath = mkDocsPath ?? (await (0, fs_1.whichMkDocs)());
+    const finalArgs = ['build', ...args];
+    log.debug('Launching %s with args: %O', mkDocsPath, finalArgs);
+    return await (0, teen_process_1.exec)(mkDocsPath, finalArgs, opts);
+}
+/**
+ * Runs `mkdocs build` or `mkdocs serve`
+ * @param opts
+ */
+async function buildSite({ mkdocsYml: mkDocsYmlPath, siteDir, theme = constants_1.NAME_MKDOCS, cwd = process.cwd(), serve = false, serveOpts, execOpts, } = {}) {
+    const stop = (0, util_1.stopwatch)('build-mkdocs');
+    mkDocsYmlPath = mkDocsYmlPath
+        ? node_path_1.default.resolve(process.cwd(), mkDocsYmlPath)
+        : await (0, fs_1.findMkDocsYml)(cwd);
+    if (!mkDocsYmlPath) {
+        throw new error_1.DocutilsError(`Could not find ${constants_1.NAME_MKDOCS_YML} from ${cwd}; run "${constants_1.NAME_BIN} init" to create it`);
+    }
+    const mkdocsArgs = ['-f', mkDocsYmlPath, '-t', theme];
+    if (siteDir) {
+        mkdocsArgs.push('-d', siteDir);
+    }
+    if (serve) {
+        // unsure about how SIGHUP is handled here
+        await doServe(mkdocsArgs, serveOpts);
+    }
+    else {
+        await doBuild(mkdocsArgs, execOpts);
+        let relSiteDir;
+        if (siteDir) {
+            relSiteDir = (0, util_1.relative)(cwd, siteDir);
+        }
+        else {
+            ({ site_dir: siteDir } = await (0, fs_1.readMkDocsYml)(mkDocsYmlPath));
+            log.debug('Found site_dir %s', siteDir);
+            relSiteDir = (0, util_1.relative)(node_path_1.default.dirname(mkDocsYmlPath), siteDir);
+        }
+        log.success('MkDocs finished building into %s (%dms)', relSiteDir, stop());
+    }
+}
+exports.buildSite = buildSite;
+//# sourceMappingURL=site.js.map

package/build/lib/builder/site.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"site.js","sourceRoot":"","sources":["../../../lib/builder/site.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;;;AAEH,0DAA6B;AAC7B,+CAAsE;AACtE,4CAAoE;AACpE,oCAAuC;AACvC,8BAAgE;AAChE,uDAA+B;AAC/B,kCAA4E;AAE5E,MAAM,GAAG,GAAG,gBAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;AAErC;;;;;GAKG;AACH,KAAK,UAAU,OAAO,CACpB,OAAiB,EAAE,EACnB,EAAC,aAAa,EAAE,MAAM,EAAE,SAAS,KAAoC,EAAE,EACvE,UAAmB;IAEnB,UAAU,GAAG,UAAU,IAAI,CAAC,MAAM,IAAA,gBAAW,GAAE,CAAC,CAAC;IACjD,MAAM,SAAS,GAAG,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;IACrC,GAAG,CAAC,KAAK,CAAC,4BAA4B,EAAE,UAAU,EAAE,SAAS,CAAC,CAAC;IAC/D,MAAM,IAAI,GAAG,IAAI,yBAAU,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;IACnD,OAAO,MAAM,IAAI,CAAC,KAAK,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC;AAC5D,CAAC;AAED;;;;;GAKG;AACH,KAAK,UAAU,OAAO,CACpB,OAAiB,EAAE,EACnB,OAA+B,EAAE,EACjC,UAAmB;IAEnB,UAAU,GAAG,UAAU,IAAI,CAAC,MAAM,IAAA,gBAAW,GAAE,CAAC,CAAC;IACjD,MAAM,SAAS,GAAG,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;IACrC,GAAG,CAAC,KAAK,CAAC,4BAA4B,EAAE,UAAU,EAAE,SAAS,CAAC,CAAC;IAC/D,OAAO,MAAM,IAAA,mBAAI,EAAC,UAAU,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;AACjD,CAAC;AAED;;;GAGG;AACI,KAAK,UAAU,SAAS,CAAC,EAC9B,SAAS,EAAE,aAAa,EACxB,OAAO,EACP,KAAK,GAAG,uBAAW,EACnB,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,EACnB,KAAK,GAAG,KAAK,EACb,SAAS,EACT,QAAQ,MACW,EAAE;IACrB,MAAM,IAAI,GAAG,IAAA,gBAAS,EAAC,cAAc,CAAC,CAAC;IACvC,aAAa,GAAG,aAAa;QAC3B,CAAC,CAAC,mBAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,aAAa,CAAC;QAC5C,CAAC,CAAC,MAAM,IAAA,kBAAa,EAAC,GAAG,CAAC,CAAC;IAC7B,IAAI,CAAC,aAAa,EAAE;QAClB,MAAM,IAAI,qBAAa,CACrB,kBAAkB,2BAAe,SAAS,GAAG,UAAU,oBAAQ,qBAAqB,CACrF,CAAC;KACH;IACD,MAAM,UAAU,GAAG,CAAC,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;IACtD,IAAI,OAAO,EAAE;QACX,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;KAChC;IACD,IAAI,KAAK,EAAE;QACT,0CAA0C;QAC1C,MAAM,OAAO,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;KACtC;SAAM;QACL,MAAM,OAAO,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QACpC,IAAI,UAAU,CAAC;QACf,IAAI,OAAO,EAAE;YACX,UAAU,GAAG,IAAA,eAAQ,EAAC,GAAG,EAAE,OAAO,CAAC,CAAC;SACrC;aAAM;YACL,CAAC,EAAC,QAAQ,EAAE,OAAO,EAAC,GAAG,MAAM,IAAA,kBAAa,EAAC,aAAa,CAAC,CAAC,CAAC;YAC3D,GAAG,CAAC,KAAK,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;YACxC,UAAU,GAAG,IAAA,eAAQ,EAAC,mBAAI,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,OAAQ,CAAC,CAAC;SAC9D;QACD,GAAG,CAAC,OAAO,CAAC,yCAAyC,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC;KAC5E;AACH,CAAC;AArCD,8BAqCC"}

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

@@ -0,0 +1,178 @@
+import { CommandModule, InferredOptionTypes } from 'yargs';
+declare const opts: {
+    readonly reference: {
+        readonly describe: "Run TypeDoc command API reference build (Markdown)";
+        readonly group: "Build Options:";
+        readonly type: "boolean";
+        readonly default: true;
+    };
+    readonly site: {
+        readonly describe: "Run MkDocs build (HTML)";
+        readonly group: "Build Options:";
+        readonly type: "boolean";
+        readonly default: true;
+    };
+    readonly 'site-dir': {
+        readonly alias: "d";
+        readonly describe: "HTML output directory";
+        readonly group: "Paths:";
+        readonly nargs: 1;
+        readonly requiresArg: true;
+        readonly type: "string";
+        readonly normalize: true;
+        readonly implies: "site";
+        readonly defaultDescription: "(from mkdocs.yml)";
+    };
+    readonly 'package-json': {
+        readonly defaultDescription: "./package.json";
+        readonly describe: "Path to package.json";
+        readonly group: "Paths:";
+        readonly nargs: 1;
+        readonly normalize: true;
+        readonly requiresArg: true;
+        readonly type: "string";
+    };
+    readonly title: {
+        readonly defaultDescription: "(extension package name)";
+        readonly describe: "Title of the API reference";
+        readonly group: "Build Options:";
+        readonly nargs: 1;
+        readonly requiresArg: true;
+        readonly type: "string";
+    };
+    readonly 'tsconfig-json': {
+        readonly defaultDescription: "./tsconfig.json";
+        readonly describe: "Path to tsconfig.json";
+        readonly group: "Paths:";
+        readonly nargs: 1;
+        readonly normalize: true;
+        readonly requiresArg: true;
+        readonly type: "string";
+    };
+    readonly 'mkdocs-yml': {
+        readonly defaultDescription: "./mkdocs.yml";
+        readonly description: "Path to mkdocs.yml";
+        readonly group: "Paths:";
+        readonly nargs: 1;
+        readonly normalize: true;
+        readonly requiresArg: true;
+        readonly type: "string";
+    };
+    readonly 'typedoc-json': {
+        readonly defaultDescription: "./typedoc.json";
+        readonly describe: "Path to typedoc.json";
+        readonly group: "Paths:";
+        readonly nargs: 1;
+        readonly normalize: true;
+        readonly requiresArg: true;
+        readonly type: "string";
+    };
+    readonly all: {
+        readonly describe: "Output all reference docs (not just Appium comands)";
+        readonly group: "Build Options:";
+        readonly implies: "site";
+        readonly type: "boolean";
+    };
+    readonly deploy: {
+        readonly describe: "Commit HTML output";
+        readonly group: "Deployment Options:";
+        readonly type: "boolean";
+        readonly implies: "site";
+    };
+    readonly push: {
+        readonly describe: "Push after deploy";
+        readonly group: "Deployment Options:";
+        readonly type: "boolean";
+        readonly implies: "deploy";
+    };
+    readonly branch: {
+        readonly alias: "b";
+        readonly describe: "Branch to commit to";
+        readonly implies: "deploy";
+        readonly group: "Deployment Options:";
+        readonly type: "string";
+        readonly requiresArg: true;
+        readonly nargs: 1;
+        readonly defaultDescription: "gh-pages";
+    };
+    readonly remote: {
+        readonly alias: "r";
+        readonly describe: "Remote to push to";
+        readonly implies: readonly ["deploy", "push"];
+        readonly group: "Deployment Options:";
+        readonly type: "string";
+        readonly requiresArg: true;
+        readonly nargs: 1;
+        readonly defaultDescription: "origin";
+    };
+    readonly prefix: {
+        readonly describe: "Subdirectory within <branch> to commit to";
+        readonly implies: readonly ["deploy", "branch"];
+        readonly group: "Deployment Options:";
+        readonly type: "string";
+        readonly nargs: 1;
+        readonly requiresArg: true;
+    };
+    readonly message: {
+        readonly alias: "m";
+        readonly describe: "Commit message";
+        readonly implies: "deploy";
+        readonly group: "Deployment Options:";
+        readonly type: "string";
+        readonly nargs: 1;
+        readonly requiresArg: true;
+    };
+    readonly 'deploy-version': {
+        readonly describe: "Version (directory) to deploy build to";
+        readonly implies: "deploy";
+        readonly group: "Deployment Options:";
+        readonly type: "string";
+        readonly nargs: 1;
+        readonly requiresArg: true;
+        readonly defaultDescription: "(derived from package.json)";
+    };
+    readonly alias: {
+        readonly describe: "Alias for the build (e.g., \"latest\"); triggers alias update";
+        readonly implies: "deploy";
+        readonly group: "Deployment Options:";
+        readonly type: "string";
+        readonly nargs: 1;
+        readonly requiresArg: true;
+        readonly defaultDescription: "latest";
+    };
+    readonly rebase: {
+        readonly describe: "Rebase <branch> with remote before deploy";
+        readonly implies: readonly ["deploy", "branch", "remote"];
+        readonly group: "Deployment Options:";
+        readonly type: "boolean";
+    };
+    readonly serve: {
+        readonly describe: "Start development server";
+        readonly group: "Serve Options:";
+        readonly type: "boolean";
+    };
+    readonly port: {
+        readonly alias: "p";
+        readonly describe: "Development server port";
+        readonly group: "Serve Options:";
+        readonly type: "number";
+        readonly defaultDescription: "8000";
+        readonly implies: "serve";
+        readonly nargs: 1;
+        readonly requiresArg: true;
+    };
+    readonly host: {
+        readonly alias: "h";
+        readonly describe: "Development server host";
+        readonly group: "Serve Options:";
+        readonly type: "string";
+        readonly nargs: 1;
+        readonly requiresArg: true;
+        readonly implies: "serve";
+        readonly defaultDescription: "localhost";
+    };
+};
+declare type BuildOptions = InferredOptionTypes<typeof opts>;
+declare const buildCommand: CommandModule<{}, BuildOptions>;
+export default buildCommand;
+//# sourceMappingURL=build.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"build.d.ts","sourceRoot":"","sources":["../../../../lib/cli/command/build.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAE,mBAAmB,EAAU,MAAM,OAAO,CAAC;AAalE,QAAA,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA4KA,CAAC;AAGX,aAAK,YAAY,GAAG,mBAAmB,CAAC,OAAO,IAAI,CAAC,CAAC;AAErD,QAAA,MAAM,YAAY,EAAE,aAAa,CAAC,EAAE,EAAE,YAAY,CAoCjD,CAAC;AAEF,eAAe,YAAY,CAAC"}