@appium/docutils 0.2.1 → 0.3.0

package/lib/validate.ts

@@ -1,15 +1,14 @@
 /**
- * Validates an environment for building documentation
+ * Validates an environment for building documentation; used by `validate` command
  *
  * @module
  */
 
-import {fs} from '@appium/support';
+import {fs, util} from '@appium/support';
 import chalk from 'chalk';
 import _ from 'lodash';
 import {EventEmitter} from 'node:events';
 import path from 'node:path';
-import pluralize from 'pluralize';
 import {satisfies} from 'semver';
 import {exec} from 'teen_process';
 import {
@@ -36,7 +35,6 @@ import {
   findMkDocsYml,
   readJson5,
   readTypedocJson,
-  readYaml,
   whichMkDocs,
   whichNpm,
   whichPython,
@@ -287,7 +285,7 @@ export class DocutilsValidator extends EventEmitter {
       return this.requirementsTxt;
     }
 
-    let requiredPackages: PipPackage[] = [];
+    const requiredPackages: PipPackage[] = [];
 
     try {
       let requirementsTxt = await fs.readFile(REQUIREMENTS_TXT_PATH, 'utf8');
@@ -312,6 +310,9 @@ export class DocutilsValidator extends EventEmitter {
     this.emittedErrors.clear();
   }
 
+  /**
+   * Validates that the correct version of `mkdocs` is installed
+   */
   protected async validateMkDocs() {
     let mkDocsPath: string | undefined;
     try {
@@ -466,7 +467,7 @@ export class DocutilsValidator extends EventEmitter {
     const msgParts = [];
     if (missingPackages.length) {
       msgParts.push(
-        `The following required ${pluralize(
+        `The following required ${util.pluralize(
           'package',
           missingPackages.length
         )} could not be found:\n${missingPackages
@@ -476,7 +477,7 @@ export class DocutilsValidator extends EventEmitter {
     }
     if (invalidVersionPackages.length) {
       msgParts.push(
-        `The following required ${pluralize(
+        `The following required ${util.pluralize(
           'package',
           invalidVersionPackages.length
         )} are installed, but at the wrong version:\n${invalidVersionPackages
@@ -533,7 +534,7 @@ export class DocutilsValidator extends EventEmitter {
     }
 
     if (rawTypeDocVersion) {
-      let match = rawTypeDocVersion.match(TYPEDOC_VERSION_REGEX);
+      const match = rawTypeDocVersion.match(TYPEDOC_VERSION_REGEX);
       if (match) {
         typeDocVersion = match[1];
       } else {
@@ -621,7 +622,7 @@ export class DocutilsValidator extends EventEmitter {
       return this.fail(`Could not find TypeScript compiler ("tsc") from ${pkgDir}`);
     }
 
-    let match = rawTypeScriptVersion.match(TYPESCRIPT_VERSION_REGEX);
+    const match = rawTypeScriptVersion.match(TYPESCRIPT_VERSION_REGEX);
     if (match) {
       typeScriptVersion = match[1];
     } else {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/docutils",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "Documentation generation utilities for Appium and related projects",
   "keywords": [
     "automation",
@@ -46,36 +46,34 @@
     "test:e2e": "echo \"No e2e tests for this package\"",
     "test:smoke": "node ./index.js",
     "test:unit": "mocha \"./test/unit/**/*.spec.js\"",
-    "start": "node ./build/lib/cli.js"
+    "start": "node ./build/lib/cli/index.js"
   },
   "dependencies": {
-    "@appium/support": "^3.1.5",
+    "@appium/support": "^3.1.7",
     "@appium/tsconfig": "^0.2.4",
-    "@appium/typedoc-plugin-appium": "^0.4.0",
+    "@appium/typedoc-plugin-appium": "^0.5.1",
     "@sliphua/lilconfig-ts-loader": "3.2.2",
     "chalk": "4.1.2",
     "consola": "2.15.3",
     "diff": "5.1.0",
     "figures": "3.2.0",
     "find-up": "5.0.0",
-    "glob": "8.1.0",
     "json5": "2.2.3",
-    "lilconfig": "2.0.6",
+    "lilconfig": "2.1.0",
     "lodash": "4.17.21",
     "log-symbols": "4.1.0",
     "pkg-dir": "5.0.0",
-    "pluralize": "8.0.0",
     "read-pkg": "5.2.0",
     "semver": "7.3.8",
     "source-map-support": "0.5.21",
     "teen_process": "2.0.2",
-    "type-fest": "3.5.6",
-    "typedoc": "0.23.24",
+    "type-fest": "3.6.1",
+    "typedoc": "0.23.26",
     "typedoc-plugin-markdown": "3.14.0",
     "typedoc-plugin-resolve-crossmodule-references": "0.3.3",
-    "typescript": "4.7.4",
+    "typescript": "4.9.5",
     "yaml": "2.2.1",
-    "yargs": "17.6.2",
+    "yargs": "17.7.1",
     "yargs-parser": "21.1.1"
   },
   "engines": {
@@ -85,5 +83,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "29a5bdac9aead8eca0329d5672c5e2afc2bdf86c"
+  "gitHead": "872b924a97c13142bdb8bf4218a4db324f309ce4"
 }

package/requirements.txt

@@ -1,4 +1,4 @@
 mkdocs==1.4.2
-mkdocs-material==9.0.11
+mkdocs-material==9.1.1
 mkdocs-material-extensions==1.1.1
 mike==1.1.2

package/build/lib/build/mkdocs.d.ts

@@ -1,58 +0,0 @@
-/**
- * Functions for running `mkdocs`
- *
- * @module
- */
-import { SubProcess, TeenProcessExecOptions } from 'teen_process';
-import { TupleToObject } from '../util';
-/**
- * Runs `mkdocs build` or `mkdocs serve`
- * @param opts
- */
-export declare function buildMkDocs({ mkdocsYml: mkDocsYmlPath, siteDir, theme, cwd, serve, serveOpts, execOpts, }?: BuildMkDocsOpts): Promise<void>;
-/**
- * Options for {@linkcode buildMkDocs}.
- */
-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;
-}
-/**
- * Conversion of the parameters of {@linkcode Subprocess.start} to an object.
- */
-export declare type TeenProcessSubprocessStartOpts = Partial<TupleToObject<Parameters<SubProcess['start']>, ['startDetector', 'detach', 'timeoutMs']>>;
-//# sourceMappingURL=mkdocs.d.ts.map

package/build/lib/build/mkdocs.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"mkdocs.d.ts","sourceRoot":"","sources":["../../../lib/build/mkdocs.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAAO,UAAU,EAAE,sBAAsB,EAAC,MAAM,cAAc,CAAC;AAItE,OAAO,EAAsB,aAAa,EAAC,MAAM,SAAS,CAAC;AAyC3D;;;GAGG;AACH,wBAAsB,WAAW,CAAC,EAChC,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;AAED;;GAEG;AACH,oBAAY,8BAA8B,GAAG,OAAO,CAClD,aAAa,CAAC,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,eAAe,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC,CACzF,CAAC"}

package/build/lib/build/mkdocs.js

@@ -1,80 +0,0 @@
-"use strict";
-/**
- * Functions for running `mkdocs`
- *
- * @module
- */
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildMkDocs = void 0;
-const node_path_1 = __importDefault(require("node:path"));
-const teen_process_1 = require("teen_process");
-const constants_1 = require("../constants");
-const fs_1 = require("../fs");
-const logger_1 = __importDefault(require("../logger"));
-const util_1 = require("../util");
-const error_1 = require("../error");
-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 buildMkDocs({ 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.buildMkDocs = buildMkDocs;
-//# sourceMappingURL=mkdocs.js.map

package/build/lib/build/mkdocs.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"mkdocs.js","sourceRoot":"","sources":["../../../lib/build/mkdocs.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;;;;AAEH,0DAA6B;AAC7B,+CAAsE;AACtE,4CAAoE;AACpE,8BAAgE;AAChE,uDAA+B;AAC/B,kCAA2D;AAE3D,oCAAuC;AAEvC,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,WAAW,CAAC,EAChC,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,kCAqCC"}

package/build/lib/build/typedoc.d.ts

@@ -1,55 +0,0 @@
-/**
- * Runs TypeDoc
- *
- * @module
- */
-/**
- * Executes TypeDoc _in the current process_
- *
- * Monkeypatches TypeDoc's homebrew "glob" implementation because it is broken
- * @param pkgRoot - Package root path
- * @param opts - TypeDoc options
- */
-export declare function runTypedoc(pkgRoot: string, opts: Record<string, string>): Promise<void>;
-/**
- * Options for {@linkcode buildReferenceDocs}
- */
-export interface BuildReferenceOptions {
-    /**
-     * Path to `typedoc.json`
-     */
-    typedocJson?: string;
-    /**
-     * Current working directory
-     */
-    cwd?: string;
-    /**
-     * Path to `package.json`
-     */
-    packageJson?: string;
-    /**
-     * Path to `tsconfig.json`
-     */
-    tsconfigJson?: string;
-    /**
-     * "Title" for generated docs; this corresponds to {@linkcode typedoc.TypeDocOptionMap.name}
-     */
-    title?: string;
-    /**
-     * This is here because we pass it thru to TypeDoc
-     */
-    logLevel?: LogLevelName;
-}
-/**
- * Log level names as supported by this package
- *
- * Used to convert our log level to TypeDoc's
- */
-declare type LogLevelName = 'debug' | 'info' | 'error' | 'warn';
-/**
- * Build reference documentation via TypeDoc
- * @param opts - Options
- */
-export declare function buildReferenceDocs({ typedocJson: typeDocJsonPath, cwd, tsconfigJson: tsconfig, logLevel, title, }?: BuildReferenceOptions): Promise<void>;
-export {};
-//# sourceMappingURL=typedoc.d.ts.map

package/build/lib/build/typedoc.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"typedoc.d.ts","sourceRoot":"","sources":["../../../lib/build/typedoc.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAwCH;;;;;;GAMG;AACH,wBAAsB,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,iBAkB7E;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,QAAQ,CAAC,EAAE,YAAY,CAAC;CACzB;AAED;;;;GAIG;AACH,aAAK,YAAY,GAAG,OAAO,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC;AAexD;;;GAGG;AACH,wBAAsB,kBAAkB,CAAC,EACvC,WAAW,EAAE,eAAe,EAC5B,GAAmB,EACnB,YAAY,EAAE,QAAQ,EACtB,QAA4B,EAC5B,KAAK,GACN,GAAE,qBAA0B,iBA0D5B"}

package/build/lib/build/typedoc.js

@@ -1,120 +0,0 @@
-"use strict";
-/**
- * Runs TypeDoc
- *
- * @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('typedoc');
-/**
- * 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 monkeyPatchGlob = lodash_1.default.once((pkgRoot) => {
-    const tdFs = require(node_path_1.default.join(pkgRoot, 'node_modules', 'typedoc', 'dist', 'lib', 'utils', 'fs.js'));
-    tdFs.glob = glob_1.default.sync;
-});
-/**
- * Executes TypeDoc _in the current process_
- *
- * Monkeypatches TypeDoc's homebrew "glob" implementation because it is broken
- * @param pkgRoot - Package root path
- * @param opts - TypeDoc options
- */
-async function runTypedoc(pkgRoot, opts) {
-    monkeyPatchGlob(pkgRoot);
-    log.debug('Monkeypatched TypeDoc');
-    const args = (0, util_1.argify)(opts);
-    log.debug('TypeDoc args:', args);
-    const app = new typedoc_1.Application();
-    app.options.addReader(new typedoc_1.TypeDocReader());
-    app.options.addReader(new typedoc_1.ArgumentsReader(100, args));
-    app.bootstrap();
-    log.debug('Frozen options as computed by TypeDoc: %O', app.options.getRawValues());
-    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) {
-        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('Overriding "out" option with %s', out);
-    }
-    else {
-        out = typeDocJson.out;
-        log.debug(`Found "out" option in ${constants_1.NAME_TYPEDOC_JSON}: ${out}`);
-    }
-    const extraTypedocOpts = lodash_1.default.pickBy({ tsconfig, name: title, out, logLevel: TypeDocLogLevelMap[logLevel] }, Boolean);
-    log.debug('Extra typedoc opts: %O', extraTypedocOpts);
-    try {
-        await runTypedoc(pkgRoot, extraTypedocOpts);
-        log.success('Reference docs built at %s (%dms)', node_path_1.default.isAbsolute(out) ? relativePath(out) : out, stop());
-    }
-    catch (err) {
-        log.error(err);
-    }
-}
-exports.buildReferenceDocs = buildReferenceDocs;
-//# sourceMappingURL=typedoc.js.map

package/build/lib/build/typedoc.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"typedoc.js","sourceRoot":"","sources":["../../../lib/build/typedoc.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;;;;AAEH,6CAAmC;AACnC,gDAAwB;AACxB,oDAAuB;AACvB,0DAA6B;AAC7B,qCAAoF;AACpF,4CAKsB;AACtB,oCAAuC;AACvC,8BAA2D;AAC3D,uDAA+B;AAC/B,kCAAoD;AAEpD,MAAM,GAAG,GAAG,gBAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;AAEtC;;;;;;GAMG;AACH,MAAM,eAAe,GAAG,gBAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE;IACzC,MAAM,IAAI,GAAG,OAAO,CAAC,mBAAI,CAAC,IAAI,CAC5B,OAAO,EACP,cAAc,EACd,SAAS,EACT,MAAM,EACN,KAAK,EACL,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACH,IAAI,CAAC,IAAI,GAAG,cAAI,CAAC,IAAI,CAAC;AACxB,CAAC,CAAC,CAAC;AAEH;;;;;;GAMG;AACI,KAAK,UAAU,UAAU,CAAC,OAAe,EAAE,IAA4B;IAC5E,eAAe,CAAC,OAAO,CAAC,CAAC;IACzB,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,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,EAAE,CAAC;IAChB,GAAG,CAAC,KAAK,CAAC,2CAA2C,EAAE,GAAG,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC;IACnF,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;AAlBD,gCAkBC;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,GAAW,CAAC;IAChB,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE;QACpB,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,iCAAiC,EAAE,GAAG,CAAC,CAAC;KACnD;SAAM;QACL,GAAG,GAAG,WAAW,CAAC,GAAG,CAAC;QACtB,GAAG,CAAC,KAAK,CAAC,yBAAyB,6BAAiB,KAAK,GAAG,EAAE,CAAC,CAAC;KACjE;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,GAAG,CAAC,KAAK,CAAC,wBAAwB,EAAE,gBAAgB,CAAC,CAAC;IACtD,IAAI;QACF,MAAM,UAAU,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;QAC5C,GAAG,CAAC,OAAO,CACT,mCAAmC,EACnC,mBAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,EAC9C,IAAI,EAAE,CACP,CAAC;KACH;IAAC,OAAO,GAAG,EAAE;QACZ,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;KAChB;AACH,CAAC;AAhED,gDAgEC"}

package/build/lib/build-api.d.ts

@@ -1,18 +0,0 @@
-/**
- * Executes TypeDoc in the current process
- *
- * Monkeypatch's TypeDoc's homebrew "glob" implementation because it is broken
- * @param {string} pkgRoot
- * @param {import('typedoc').TypeDocOptions} opts
- */
-export function runTypedoc(pkgRoot: string, opts: import('typedoc').TypeDocOptions): import("typedoc").ProjectReflection | undefined;
-export function buildTypedoc({ typedocJson: typedocJsonPath, cwd, packageJson: packageJsonPath, tsconfigJson: tsconfig, title, }?: {
-    typedocJson: any;
-    cwd?: string | undefined;
-    packageJson: any;
-    tsconfigJson: any;
-    title: any;
-}): Promise<void>;
-export function buildReference(opts: any): Promise<void>;
-export type TypedocJson = import('./types').TypedocJson;
-//# sourceMappingURL=build-api.d.ts.map

package/build/lib/build-api.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"build-api.d.ts","sourceRoot":"","sources":["../../lib/build-api.js"],"names":[],"mappings":"AA+BA;;;;;;GAMG;AACH,oCAHW,MAAM,QACN,OAAO,SAAS,EAAE,cAAc,mDAQ1C;AAED;;;;;;kBAoCC;AAED,yDAEC;0BAGY,OAAO,SAAS,EAAE,WAAW"}

package/build/lib/build-api.js

@@ -1,75 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildReference = exports.buildTypedoc = exports.runTypedoc = void 0;
-const logger_1 = __importDefault(require("./logger"));
-const support_1 = require("@appium/support");
-const lodash_1 = __importDefault(require("lodash"));
-const node_path_1 = __importDefault(require("node:path"));
-const typedoc_1 = require("typedoc");
-const error_1 = require("./error");
-const util_1 = require("./util");
-const glob_1 = __importDefault(require("glob"));
-const LANGS = ['en', 'ja', 'zh'];
-/**
- * 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 monkeyPatchGlob = lodash_1.default.once((pkgRoot) => {
-    const tdFs = require(node_path_1.default.join(pkgRoot, 'node_modules', 'typedoc', 'dist', 'lib', 'utils', 'fs.js'));
-    tdFs.glob = glob_1.default.sync;
-});
-/**
- * Executes TypeDoc in the current process
- *
- * Monkeypatch's TypeDoc's homebrew "glob" implementation because it is broken
- * @param {string} pkgRoot
- * @param {import('typedoc').TypeDocOptions} opts
- */
-function runTypedoc(pkgRoot, opts) {
-    monkeyPatchGlob(pkgRoot);
-    const app = new typedoc_1.Application();
-    app.options.addReader(new typedoc_1.TSConfigReader());
-    app.bootstrap(opts);
-    return app.convert();
-}
-exports.runTypedoc = runTypedoc;
-async function buildTypedoc({ typedocJson: typedocJsonPath, cwd = process.cwd(), packageJson: packageJsonPath, tsconfigJson: tsconfig, title, } = {}) {
-    typedocJsonPath = typedocJsonPath ?? (await (0, util_1.getTypedocJsonPath)(cwd, packageJsonPath));
-    const pkgRoot = support_1.fs.findRoot(cwd);
-    const relativePath = (0, util_1.relative)(cwd);
-    const relativeTypedocJsonPath = relativePath(typedocJsonPath);
-    logger_1.default.debug(`Using ${relativeTypedocJsonPath} as typedoc.json`);
-    /** @type {TypedocJson} */
-    let typedocJson;
-    try {
-        typedocJson = /** @type {TypedocJson} */ (await (0, util_1.readJson)(typedocJsonPath));
-    }
-    catch (err) {
-        throw new error_1.DocutilsError(`Could not read ${relativeTypedocJsonPath}; please execute "appium docutils init" to create it`);
-    }
-    const out = typedocJson.out ??
-        node_path_1.default.relative(typedocJsonPath, node_path_1.default.join(pkgRoot, util_1.DEFAULT_REL_TYPEDOC_OUT_PATH));
-    const finalTypedocJson = lodash_1.default.defaultsDeep(lodash_1.default.compact({ tsconfig, name: title, out }), lodash_1.default.omit(typedocJson, '$schema'));
-    try {
-        runTypedoc(pkgRoot, finalTypedocJson);
-        logger_1.default.success(`API docs built at ${relativePath(out)}`);
-    }
-    catch (err) {
-        logger_1.default.error(err);
-    }
-}
-exports.buildTypedoc = buildTypedoc;
-async function buildReference(opts) {
-    await buildTypedoc(opts);
-}
-exports.buildReference = buildReference;
-/**
- * @typedef {import('./types').TypedocJson} TypedocJson
- */
-//# sourceMappingURL=build-api.js.map

package/build/lib/build-api.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"build-api.js","sourceRoot":"","sources":["../../lib/build-api.js"],"names":[],"mappings":";;;;;;AAAA,sDAA2B;AAC3B,6CAAmC;AACnC,oDAAuB;AACvB,0DAA6B;AAC7B,qCAAoD;AACpD,mCAAsC;AACtC,iCAA4F;AAC5F,gDAAwB;AAExB,MAAM,KAAK,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;AAEjC;;;;;;GAMG;AACH,MAAM,eAAe,GAAG,gBAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE;IACzC,MAAM,IAAI,GAAG,OAAO,CAAC,mBAAI,CAAC,IAAI,CAC5B,OAAO,EACP,cAAc,EACd,SAAS,EACT,MAAM,EACN,KAAK,EACL,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACH,IAAI,CAAC,IAAI,GAAG,cAAI,CAAC,IAAI,CAAC;AACxB,CAAC,CAAC,CAAC;AAEH;;;;;;GAMG;AACH,SAAgB,UAAU,CAAC,OAAO,EAAE,IAAI;IACtC,eAAe,CAAC,OAAO,CAAC,CAAC;IACzB,MAAM,GAAG,GAAG,IAAI,qBAAW,EAAE,CAAC;IAC9B,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,wBAAc,EAAE,CAAC,CAAC;IAC5C,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACpB,OAAO,GAAG,CAAC,OAAO,EAAE,CAAC;AACvB,CAAC;AAND,gCAMC;AAEM,KAAK,UAAU,YAAY,CAAC,EACjC,WAAW,EAAE,eAAe,EAC5B,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,EACnB,WAAW,EAAE,eAAe,EAC5B,YAAY,EAAE,QAAQ,EACtB,KAAK,GACN,GAAG,EAAE;IACJ,eAAe,GAAG,eAAe,IAAI,CAAC,MAAM,IAAA,yBAAkB,EAAC,GAAG,EAAE,eAAe,CAAC,CAAC,CAAC;IACtF,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,gBAAG,CAAC,KAAK,CAAC,SAAS,uBAAuB,kBAAkB,CAAC,CAAC;IAC9D,0BAA0B;IAC1B,IAAI,WAAW,CAAC;IAChB,IAAI;QACF,WAAW,GAAG,0BAA0B,CAAC,CAAC,MAAM,IAAA,eAAQ,EAAC,eAAe,CAAC,CAAC,CAAC;KAC5E;IAAC,OAAO,GAAG,EAAE;QACZ,MAAM,IAAI,qBAAa,CACrB,kBAAkB,uBAAuB,sDAAsD,CAChG,CAAC;KACH;IAED,MAAM,GAAG,GACP,WAAW,CAAC,GAAG;QACf,mBAAI,CAAC,QAAQ,CAAC,eAAe,EAAE,mBAAI,CAAC,IAAI,CAAC,OAAO,EAAE,mCAA4B,CAAC,CAAC,CAAC;IACnF,MAAM,gBAAgB,GAAG,gBAAC,CAAC,YAAY,CACrC,gBAAC,CAAC,OAAO,CAAC,EAAC,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAC,CAAC,EACvC,gBAAC,CAAC,IAAI,CAAC,WAAW,EAAE,SAAS,CAAC,CAC/B,CAAC;IAEF,IAAI;QACF,UAAU,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;QACtC,gBAAG,CAAC,OAAO,CAAC,qBAAqB,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;KACvD;IAAC,OAAO,GAAG,EAAE;QACZ,gBAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;KAChB;AACH,CAAC;AApCD,oCAoCC;AAEM,KAAK,UAAU,cAAc,CAAC,IAAI;IACvC,MAAM,YAAY,CAAC,IAAI,CAAC,CAAC;AAC3B,CAAC;AAFD,wCAEC;AAED;;GAEG"}

package/build/lib/build.d.ts

@@ -1,21 +0,0 @@
-import { TypeDocOptions } from 'typedoc';
-/**
- * Executes TypeDoc in the current process
- *
- * Monkeypatch's TypeDoc's homebrew "glob" implementation because it is broken
- * @param pkgRoot - Package root path
- * @param opts - TypeDoc options
- */
-export declare function runTypedoc(pkgRoot: string, opts: TypeDocOptions): import("typedoc").ProjectReflection | undefined;
-export interface BuildTypedocOptions {
-    typedocJson?: string;
-    cwd?: string;
-    packageJson?: string;
-    tsconfigJson?: string;
-    title?: string;
-}
-export declare function buildTypedoc({ typedocJson: typeDocJsonPath, cwd, packageJson: packageJsonPath, tsconfigJson: tsconfig, title, }?: BuildTypedocOptions): Promise<void>;
-export declare function buildReference(opts?: BuildReferenceOptions): Promise<void>;
-export interface BuildReferenceOptions extends BuildTypedocOptions {
-}
-//# sourceMappingURL=build.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"build.d.ts","sourceRoot":"","sources":["../../lib/build.ts"],"names":[],"mappings":"AAIA,OAAO,EAA8B,cAAc,EAAC,MAAM,SAAS,CAAC;AA2BpE;;;;;;GAMG;AACH,wBAAgB,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,mDAM/D;AAED,MAAM,WAAW,mBAAmB;IAClC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,wBAAsB,YAAY,CAAC,EACjC,WAAW,EAAE,eAAe,EAC5B,GAAmB,EACnB,WAAW,EAAE,eAAe,EAC5B,YAAY,EAAE,QAAQ,EACtB,KAAK,GACN,GAAE,mBAAwB,iBA4B1B;AAED,wBAAsB,cAAc,CAAC,IAAI,GAAE,qBAA0B,iBAEpE;AAED,MAAM,WAAW,qBAAsB,SAAQ,mBAAmB;CAAG"}