@appium/docutils 0.1.6 → 0.2.0

package/build/lib/cli.js

@@ -0,0 +1,328 @@
+#!/usr/bin/env node
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.main = void 0;
+const lodash_1 = __importDefault(require("lodash"));
+const yargs_1 = __importDefault(require("yargs/yargs"));
+const helpers_1 = require("yargs/helpers");
+const init_1 = require("./init");
+const logger_1 = __importDefault(require("./logger"));
+const error_1 = require("./error");
+const consola_1 = require("consola");
+const util_1 = require("./util");
+const build_1 = require("./build");
+const validate_1 = require("./validate");
+const NAME_GROUP_INIT_BEHAVIOR = 'Initialization Behavior:';
+const NAME_GROUP_INIT_MKDOCS = 'MkDocs Config:';
+const NAME_GROUP_BUILD_REFERENCE = 'Build API:';
+const NAME_GROUP_INIT_PATHS = 'Paths:';
+const NAME_GROUP_VALIDATE = 'Validation:';
+const LogLevelName = {
+    silent: consola_1.LogLevel.Silent,
+    error: consola_1.LogLevel.Error,
+    warn: consola_1.LogLevel.Warn,
+    info: consola_1.LogLevel.Info,
+    debug: consola_1.LogLevel.Debug,
+};
+async function main(argv = (0, helpers_1.hideBin)(process.argv)) {
+    const done = (0, util_1.stopwatch)('main');
+    const y = (0, yargs_1.default)(argv);
+    return await y
+        .scriptName('appium-docs')
+        .command('build', 'Build docs', (yargs) => {
+        return yargs.options({
+            'mkdocs-path': {
+                describe: 'Path to mkdocs.yml',
+                normalize: true,
+                type: 'string',
+                nargs: 1,
+                array: false,
+            },
+        });
+    }, async () => { })
+        .command('validate', 'Validate Environment', (yargs) => yargs.options({
+        python: {
+            default: true,
+            description: 'Validate Python 3 environment',
+            group: NAME_GROUP_VALIDATE,
+            type: 'boolean',
+        },
+        'python-path': {
+            defaultDescription: '(derived from shell)',
+            description: 'Path to python 3 executable',
+            group: NAME_GROUP_VALIDATE,
+            nargs: 1,
+            normalize: true,
+            requiresArg: true,
+            type: 'string',
+        },
+        'tsconfig-json': {
+            defaultDescription: './tsconfig.json',
+            describe: 'Path to tsconfig.json',
+            group: NAME_GROUP_VALIDATE,
+            nargs: 1,
+            normalize: true,
+            requiresArg: true,
+            type: 'string',
+        },
+        typedoc: {
+            default: true,
+            description: 'Validate TypoDoc config',
+            group: NAME_GROUP_VALIDATE,
+            type: 'boolean',
+        },
+        'typedoc-json': {
+            defaultDescription: './typedoc.json',
+            describe: 'Path to typedoc.json',
+            group: NAME_GROUP_VALIDATE,
+            nargs: 1,
+            normalize: true,
+            requiresArg: true,
+            type: 'string',
+        },
+        typescript: {
+            default: true,
+            description: 'Validate TypeScript config',
+            group: NAME_GROUP_VALIDATE,
+            type: 'boolean',
+        },
+    }), async (argv) => {
+        if (!argv.python && !argv.typedoc && !argv.typescript) {
+            throw new Error('No validation targets specified; one or more of --python, --typescript or --typedoc must be provided');
+        }
+        await (0, validate_1.validate)(argv);
+    })
+        .command('build-reference', 'Build API reference docs', (yargs) => yargs.options({
+        'package-json': {
+            defaultDescription: './package.json',
+            describe: 'Path to package.json',
+            group: NAME_GROUP_BUILD_REFERENCE,
+            nargs: 1,
+            normalize: true,
+            requiresArg: true,
+            type: 'string',
+        },
+        title: {
+            defaultDescription: '(extension package name)',
+            describe: 'Title of the API reference',
+            group: NAME_GROUP_BUILD_REFERENCE,
+            nargs: 1,
+            requiresArg: true,
+            type: 'string',
+        },
+        'tsconfig-json': {
+            defaultDescription: './tsconfig.json',
+            describe: 'Path to tsconfig.json',
+            group: NAME_GROUP_BUILD_REFERENCE,
+            nargs: 1,
+            normalize: true,
+            requiresArg: true,
+            type: 'string',
+        },
+        'typedoc-json': {
+            defaultDescription: './typedoc.json',
+            describe: 'Path to typedoc.json',
+            group: NAME_GROUP_BUILD_REFERENCE,
+            nargs: 1,
+            normalize: true,
+            requiresArg: true,
+            type: 'string',
+        },
+    }), async (argv) => {
+        await (0, build_1.buildReference)(argv);
+    })
+        .command('init', 'Initialize package for docs', (yargs) => yargs.options({
+        copyright: {
+            descripiton: 'Copyright notice',
+            group: NAME_GROUP_INIT_MKDOCS,
+            nargs: 1,
+            requiresArg: true,
+            type: 'string',
+        },
+        dir: {
+            default: '.',
+            defaultDescription: '(current directory)',
+            description: 'Directory of package',
+            group: NAME_GROUP_INIT_PATHS,
+            normalize: true,
+            type: 'string',
+        },
+        'dry-run': {
+            describe: 'Do not write any files; show what would be done',
+            group: NAME_GROUP_INIT_BEHAVIOR,
+            type: 'boolean',
+        },
+        force: {
+            alias: 'f',
+            describe: 'Overwrite existing configurations',
+            group: NAME_GROUP_INIT_BEHAVIOR,
+            type: 'boolean',
+        },
+        include: {
+            alias: 'i',
+            array: true,
+            coerce: (value) => lodash_1.default.castArray(value),
+            description: 'Files to include in compilation (globs OK)',
+            nargs: 1,
+            requiresArg: true,
+            type: 'string',
+        },
+        mkdocs: {
+            default: true,
+            description: 'Create mkdocs.yml if needed',
+            group: NAME_GROUP_INIT_BEHAVIOR,
+            type: 'boolean',
+        },
+        'mkdocs-yml': {
+            defaultDescription: './mkdocs.yml',
+            description: 'Path to mkdocs.yml',
+            group: NAME_GROUP_INIT_PATHS,
+            nargs: 1,
+            normalize: true,
+            requiresArg: true,
+            type: 'string',
+        },
+        'package-json': {
+            defaultDescription: './package.json',
+            describe: 'Path to package.json',
+            group: NAME_GROUP_INIT_PATHS,
+            nargs: 1,
+            normalize: true,
+            requiresArg: true,
+            type: 'string',
+        },
+        python: {
+            default: true,
+            description: 'Install Python dependencies if needed',
+            group: NAME_GROUP_INIT_BEHAVIOR,
+            type: 'boolean',
+        },
+        'python-path': {
+            defaultDescription: '(derived from shell)',
+            description: 'Path to python 3 executable',
+            group: NAME_GROUP_INIT_PATHS,
+            nargs: 1,
+            normalize: true,
+            requiresArg: true,
+            type: 'string',
+        },
+        'repo-name': {
+            defaultDescription: '(derived from --repo-url)',
+            description: 'Name of extension repository',
+            group: NAME_GROUP_INIT_MKDOCS,
+            nargs: 1,
+            requiresArg: true,
+            type: 'string',
+        },
+        'repo-url': {
+            defaultDescription: '(from package.json)',
+            description: 'URL of extension repository',
+            group: NAME_GROUP_INIT_MKDOCS,
+            nargs: 1,
+            requiresArg: true,
+            type: 'string',
+        },
+        'site-description': {
+            defaultDescription: '(from package.json)',
+            description: 'Site description',
+            group: NAME_GROUP_INIT_MKDOCS,
+            nargs: 1,
+            requiresArg: true,
+            type: 'string',
+        },
+        'site-name': {
+            defaultDescription: '(extension package name)',
+            description: 'Name of site',
+            group: NAME_GROUP_INIT_MKDOCS,
+            nargs: 1,
+            requiresArg: true,
+            type: 'string',
+        },
+        'tsconfig-json': {
+            defaultDescription: './tsconfig.json',
+            describe: 'Path to tsconfig.json',
+            group: NAME_GROUP_INIT_PATHS,
+            nargs: 1,
+            normalize: true,
+            requiresArg: true,
+            type: 'string',
+        },
+        typedoc: {
+            default: true,
+            description: 'Create typedoc.json if needed',
+            group: NAME_GROUP_INIT_BEHAVIOR,
+            type: 'boolean',
+        },
+        'typedoc-json': {
+            defaultDescription: './typedoc.json',
+            describe: 'Path to typedoc.json',
+            group: NAME_GROUP_INIT_PATHS,
+            nargs: 1,
+            normalize: true,
+            requiresArg: true,
+            type: 'string',
+        },
+        typescript: {
+            default: true,
+            description: 'Create tsconfig.json if needed',
+            group: NAME_GROUP_INIT_BEHAVIOR,
+            type: 'boolean',
+        },
+    }), async (argv) => {
+        await (0, init_1.init)({ ...argv, overwrite: argv.force, cwd: argv.dir });
+        logger_1.default.success('Done (%dms)', done());
+    })
+        .options({
+        verbose: {
+            alias: 'V',
+            type: 'boolean',
+            describe: 'Alias for --log-level=debug',
+        },
+        'log-level': {
+            alias: 'L',
+            choices: ['debug', 'info', 'warn', 'error', 'silent'],
+            default: 'info',
+            describe: 'Sets the log level',
+            coerce: lodash_1.default.identity,
+        },
+    })
+        .middleware(
+    /**
+     * Configures logging; `--verbose` implies `--log-level=debug`
+     */
+    (argv) => {
+        const { logLevel, verbose } = argv;
+        logger_1.default.level = verbose ? LogLevelName.debug : LogLevelName[logLevel];
+    })
+        .fail(
+    /**
+     * Custom failure handler so we can log nicely.
+     */
+    (msg, error) => {
+        // if it is a DocutilsError, it has nothing to do with the CLI
+        if (error instanceof error_1.DocutilsError) {
+            logger_1.default.error(error.message);
+        }
+        else {
+            y.showHelp();
+            logger_1.default.error(msg ?? error.message);
+        }
+        y.exit(1, error);
+    })
+        // at least one command is required (but not for --version or --help)
+        .demandCommand(1)
+        // fail if unknown option or command is provided
+        .strict()
+        .parseAsync();
+}
+exports.main = main;
+if (require.main === module) {
+    // eslint-disable-next-line promise/prefer-await-to-then
+    main().catch((err) => {
+        logger_1.default.error('Caught otherwise-unhandled rejection (this is probably a bug):', err);
+    });
+}
+//# sourceMappingURL=cli.js.map

package/build/lib/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../../lib/cli.ts"],"names":[],"mappings":";;;;;;;AAEA,oDAAuB;AACvB,wDAAgC;AAChC,2CAAsC;AACtC,iCAA4B;AAC5B,sDAA2B;AAC3B,mCAAsC;AACtC,qCAAiC;AACjC,iCAAiC;AACjC,mCAAuC;AACvC,yCAAoC;AAEpC,MAAM,wBAAwB,GAAG,0BAA0B,CAAC;AAC5D,MAAM,sBAAsB,GAAG,gBAAgB,CAAC;AAChD,MAAM,0BAA0B,GAAG,YAAY,CAAC;AAChD,MAAM,qBAAqB,GAAG,QAAQ,CAAC;AACvC,MAAM,mBAAmB,GAAG,aAAa,CAAC;AAE1C,MAAM,YAAY,GAAG;IACnB,MAAM,EAAE,kBAAQ,CAAC,MAAM;IACvB,KAAK,EAAE,kBAAQ,CAAC,KAAK;IACrB,IAAI,EAAE,kBAAQ,CAAC,IAAI;IACnB,IAAI,EAAE,kBAAQ,CAAC,IAAI;IACnB,KAAK,EAAE,kBAAQ,CAAC,KAAK;CACb,CAAC;AAEJ,KAAK,UAAU,IAAI,CAAC,IAAI,GAAG,IAAA,iBAAO,EAAC,OAAO,CAAC,IAAI,CAAC;IACrD,MAAM,IAAI,GAAG,IAAA,gBAAS,EAAC,MAAM,CAAC,CAAC;IAC/B,MAAM,CAAC,GAAG,IAAA,eAAK,EAAC,IAAI,CAAC,CAAC;IACtB,OAAO,MAAM,CAAC;SACX,UAAU,CAAC,aAAa,CAAC;SACzB,OAAO,CACN,OAAO,EACP,YAAY,EACZ,CAAC,KAAK,EAAE,EAAE;QACR,OAAO,KAAK,CAAC,OAAO,CAAC;YACnB,aAAa,EAAE;gBACb,QAAQ,EAAE,oBAAoB;gBAC9B,SAAS,EAAE,IAAI;gBACf,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,CAAC;gBACR,KAAK,EAAE,KAAK;aACb;SACF,CAAC,CAAC;IACL,CAAC,EACD,KAAK,IAAI,EAAE,GAAE,CAAC,CACf;SACA,OAAO,CACN,UAAU,EACV,sBAAsB,EACtB,CAAC,KAAK,EAAE,EAAE,CACR,KAAK,CAAC,OAAO,CAAC;QACZ,MAAM,EAAE;YACN,OAAO,EAAE,IAAI;YACb,WAAW,EAAE,+BAA+B;YAC5C,KAAK,EAAE,mBAAmB;YAC1B,IAAI,EAAE,SAAS;SAChB;QACD,aAAa,EAAE;YACb,kBAAkB,EAAE,sBAAsB;YAC1C,WAAW,EAAE,6BAA6B;YAC1C,KAAK,EAAE,mBAAmB;YAC1B,KAAK,EAAE,CAAC;YACR,SAAS,EAAE,IAAI;YACf,WAAW,EAAE,IAAI;YACjB,IAAI,EAAE,QAAQ;SACf;QACD,eAAe,EAAE;YACf,kBAAkB,EAAE,iBAAiB;YACrC,QAAQ,EAAE,uBAAuB;YACjC,KAAK,EAAE,mBAAmB;YAC1B,KAAK,EAAE,CAAC;YACR,SAAS,EAAE,IAAI;YACf,WAAW,EAAE,IAAI;YACjB,IAAI,EAAE,QAAQ;SACf;QACD,OAAO,EAAE;YACP,OAAO,EAAE,IAAI;YACb,WAAW,EAAE,yBAAyB;YACtC,KAAK,EAAE,mBAAmB;YAC1B,IAAI,EAAE,SAAS;SAChB;QACD,cAAc,EAAE;YACd,kBAAkB,EAAE,gBAAgB;YACpC,QAAQ,EAAE,sBAAsB;YAChC,KAAK,EAAE,mBAAmB;YAC1B,KAAK,EAAE,CAAC;YACR,SAAS,EAAE,IAAI;YACf,WAAW,EAAE,IAAI;YACjB,IAAI,EAAE,QAAQ;SACf;QACD,UAAU,EAAE;YACV,OAAO,EAAE,IAAI;YACb,WAAW,EAAE,4BAA4B;YACzC,KAAK,EAAE,mBAAmB;YAC1B,IAAI,EAAE,SAAS;SAChB;KACF,CAAC,EACJ,KAAK,EAAE,IAAI,EAAE,EAAE;QACb,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YACrD,MAAM,IAAI,KAAK,CACb,sGAAsG,CACvG,CAAC;SACH;QACD,MAAM,IAAA,mBAAQ,EAAC,IAAI,CAAC,CAAC;IACvB,CAAC,CACF;SACA,OAAO,CACN,iBAAiB,EACjB,0BAA0B,EAC1B,CAAC,KAAK,EAAE,EAAE,CACR,KAAK,CAAC,OAAO,CAAC;QACZ,cAAc,EAAE;YACd,kBAAkB,EAAE,gBAAgB;YACpC,QAAQ,EAAE,sBAAsB;YAChC,KAAK,EAAE,0BAA0B;YACjC,KAAK,EAAE,CAAC;YACR,SAAS,EAAE,IAAI;YACf,WAAW,EAAE,IAAI;YACjB,IAAI,EAAE,QAAQ;SACf;QACD,KAAK,EAAE;YACL,kBAAkB,EAAE,0BAA0B;YAC9C,QAAQ,EAAE,4BAA4B;YACtC,KAAK,EAAE,0BAA0B;YACjC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,IAAI;YACjB,IAAI,EAAE,QAAQ;SACf;QACD,eAAe,EAAE;YACf,kBAAkB,EAAE,iBAAiB;YACrC,QAAQ,EAAE,uBAAuB;YACjC,KAAK,EAAE,0BAA0B;YACjC,KAAK,EAAE,CAAC;YACR,SAAS,EAAE,IAAI;YACf,WAAW,EAAE,IAAI;YACjB,IAAI,EAAE,QAAQ;SACf;QACD,cAAc,EAAE;YACd,kBAAkB,EAAE,gBAAgB;YACpC,QAAQ,EAAE,sBAAsB;YAChC,KAAK,EAAE,0BAA0B;YACjC,KAAK,EAAE,CAAC;YACR,SAAS,EAAE,IAAI;YACf,WAAW,EAAE,IAAI;YACjB,IAAI,EAAE,QAAQ;SACf;KACF,CAAC,EACJ,KAAK,EAAE,IAAI,EAAE,EAAE;QACb,MAAM,IAAA,sBAAc,EAAC,IAAI,CAAC,CAAC;IAC7B,CAAC,CACF;SACA,OAAO,CACN,MAAM,EACN,6BAA6B,EAC7B,CAAC,KAAK,EAAE,EAAE,CACR,KAAK,CAAC,OAAO,CAAC;QACZ,SAAS,EAAE;YACT,WAAW,EAAE,kBAAkB;YAC/B,KAAK,EAAE,sBAAsB;YAC7B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,IAAI;YACjB,IAAI,EAAE,QAAQ;SACf;QACD,GAAG,EAAE;YACH,OAAO,EAAE,GAAG;YACZ,kBAAkB,EAAE,qBAAqB;YACzC,WAAW,EAAE,sBAAsB;YACnC,KAAK,EAAE,qBAAqB;YAC5B,SAAS,EAAE,IAAI;YACf,IAAI,EAAE,QAAQ;SACf;QACD,SAAS,EAAE;YACT,QAAQ,EAAE,iDAAiD;YAC3D,KAAK,EAAE,wBAAwB;YAC/B,IAAI,EAAE,SAAS;SAChB;QACD,KAAK,EAAE;YACL,KAAK,EAAE,GAAG;YACV,QAAQ,EAAE,mCAAmC;YAC7C,KAAK,EAAE,wBAAwB;YAC/B,IAAI,EAAE,SAAS;SAChB;QACD,OAAO,EAAE;YACP,KAAK,EAAE,GAAG;YACV,KAAK,EAAE,IAAI;YACX,MAAM,EAAE,CAAC,KAAwB,EAAE,EAAE,CAAC,gBAAC,CAAC,SAAS,CAAC,KAAK,CAAC;YACxD,WAAW,EAAE,4CAA4C;YACzD,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,IAAI;YACjB,IAAI,EAAE,QAAQ;SACf;QACD,MAAM,EAAE;YACN,OAAO,EAAE,IAAI;YACb,WAAW,EAAE,6BAA6B;YAC1C,KAAK,EAAE,wBAAwB;YAC/B,IAAI,EAAE,SAAS;SAChB;QACD,YAAY,EAAE;YACZ,kBAAkB,EAAE,cAAc;YAClC,WAAW,EAAE,oBAAoB;YACjC,KAAK,EAAE,qBAAqB;YAC5B,KAAK,EAAE,CAAC;YACR,SAAS,EAAE,IAAI;YACf,WAAW,EAAE,IAAI;YACjB,IAAI,EAAE,QAAQ;SACf;QACD,cAAc,EAAE;YACd,kBAAkB,EAAE,gBAAgB;YACpC,QAAQ,EAAE,sBAAsB;YAChC,KAAK,EAAE,qBAAqB;YAC5B,KAAK,EAAE,CAAC;YACR,SAAS,EAAE,IAAI;YACf,WAAW,EAAE,IAAI;YACjB,IAAI,EAAE,QAAQ;SACf;QACD,MAAM,EAAE;YACN,OAAO,EAAE,IAAI;YACb,WAAW,EAAE,uCAAuC;YACpD,KAAK,EAAE,wBAAwB;YAC/B,IAAI,EAAE,SAAS;SAChB;QACD,aAAa,EAAE;YACb,kBAAkB,EAAE,sBAAsB;YAC1C,WAAW,EAAE,6BAA6B;YAC1C,KAAK,EAAE,qBAAqB;YAC5B,KAAK,EAAE,CAAC;YACR,SAAS,EAAE,IAAI;YACf,WAAW,EAAE,IAAI;YACjB,IAAI,EAAE,QAAQ;SACf;QACD,WAAW,EAAE;YACX,kBAAkB,EAAE,2BAA2B;YAC/C,WAAW,EAAE,8BAA8B;YAC3C,KAAK,EAAE,sBAAsB;YAC7B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,IAAI;YACjB,IAAI,EAAE,QAAQ;SACf;QACD,UAAU,EAAE;YACV,kBAAkB,EAAE,qBAAqB;YACzC,WAAW,EAAE,6BAA6B;YAC1C,KAAK,EAAE,sBAAsB;YAC7B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,IAAI;YACjB,IAAI,EAAE,QAAQ;SACf;QACD,kBAAkB,EAAE;YAClB,kBAAkB,EAAE,qBAAqB;YACzC,WAAW,EAAE,kBAAkB;YAC/B,KAAK,EAAE,sBAAsB;YAC7B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,IAAI;YACjB,IAAI,EAAE,QAAQ;SACf;QACD,WAAW,EAAE;YACX,kBAAkB,EAAE,0BAA0B;YAC9C,WAAW,EAAE,cAAc;YAC3B,KAAK,EAAE,sBAAsB;YAC7B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,IAAI;YACjB,IAAI,EAAE,QAAQ;SACf;QACD,eAAe,EAAE;YACf,kBAAkB,EAAE,iBAAiB;YACrC,QAAQ,EAAE,uBAAuB;YACjC,KAAK,EAAE,qBAAqB;YAC5B,KAAK,EAAE,CAAC;YACR,SAAS,EAAE,IAAI;YACf,WAAW,EAAE,IAAI;YACjB,IAAI,EAAE,QAAQ;SACf;QACD,OAAO,EAAE;YACP,OAAO,EAAE,IAAI;YACb,WAAW,EAAE,+BAA+B;YAC5C,KAAK,EAAE,wBAAwB;YAC/B,IAAI,EAAE,SAAS;SAChB;QACD,cAAc,EAAE;YACd,kBAAkB,EAAE,gBAAgB;YACpC,QAAQ,EAAE,sBAAsB;YAChC,KAAK,EAAE,qBAAqB;YAC5B,KAAK,EAAE,CAAC;YACR,SAAS,EAAE,IAAI;YACf,WAAW,EAAE,IAAI;YACjB,IAAI,EAAE,QAAQ;SACf;QACD,UAAU,EAAE;YACV,OAAO,EAAE,IAAI;YACb,WAAW,EAAE,gCAAgC;YAC7C,KAAK,EAAE,wBAAwB;YAC/B,IAAI,EAAE,SAAS;SAChB;KACF,CAAC,EACJ,KAAK,EAAE,IAAI,EAAE,EAAE;QACb,MAAM,IAAA,WAAI,EAAC,EAAC,GAAG,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,EAAC,CAAC,CAAC;QAC5D,gBAAG,CAAC,OAAO,CAAC,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;IACrC,CAAC,CACF;SACA,OAAO,CAAC;QACP,OAAO,EAAE;YACP,KAAK,EAAE,GAAG;YACV,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,6BAA6B;SACxC;QACD,WAAW,EAAE;YACX,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAC;YACrD,OAAO,EAAE,MAAM;YACf,QAAQ,EAAE,oBAAoB;YAC9B,MAAM,EAAE,gBAAC,CAAC,QAAoD;SAC/D;KACF,CAAC;SACD,UAAU;IACT;;OAEG;IACH,CAAC,IAAI,EAAE,EAAE;QACP,MAAM,EAAC,QAAQ,EAAE,OAAO,EAAC,GAAG,IAAI,CAAC;QACjC,gBAAG,CAAC,KAAK,GAAG,OAAO,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACpE,CAAC,CACF;SAEA,IAAI;IACH;;OAEG;IACH,CAAC,GAAkB,EAAE,KAAK,EAAE,EAAE;QAC5B,8DAA8D;QAC9D,IAAI,KAAK,YAAY,qBAAa,EAAE;YAClC,gBAAG,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;SAC1B;aAAM;YACL,CAAC,CAAC,QAAQ,EAAE,CAAC;YACb,gBAAG,CAAC,KAAK,CAAC,GAAG,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;SACjC;QACD,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IACnB,CAAC,CACF;QACD,qEAAqE;SACpE,aAAa,CAAC,CAAC,CAAC;QACjB,gDAAgD;SAC/C,MAAM,EAAE;SACR,UAAU,EAAE,CAAC;AAClB,CAAC;AA7TD,oBA6TC;AAED,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM,EAAE;IAC3B,wDAAwD;IACxD,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;QACnB,gBAAG,CAAC,KAAK,CAAC,gEAAgE,EAAE,GAAG,CAAC,CAAC;IACnF,CAAC,CAAC,CAAC;CACJ"}

package/build/lib/constants.d.ts

@@ -0,0 +1,125 @@
+/**
+ * Constants used across various modules in this package
+ * @module
+ */
+import { LogLevel } from 'consola';
+import { PackageJson } from 'type-fest';
+/**
+ * CLI executable name
+ */
+export declare const NAME_BIN = "appium-docs";
+/**
+ * Expected name of the `mkdocs.yml` config file
+ */
+export declare const NAME_MKDOCS_YML = "mkdocs.yml";
+/**
+ * Default name of the `tsconfig.json` config file
+ */
+export declare const NAME_TSCONFIG_JSON = "tsconfig.json";
+/**
+ * `python` executable
+ */
+export declare const NAME_PYTHON = "python";
+/**
+ * Default name of the `typedoc.json` config file
+ */
+export declare const NAME_TYPEDOC_JSON = "typedoc.json";
+/**
+ * It's `package.json`!
+ */
+export declare const NAME_PACKAGE_JSON = "package.json";
+/**
+ * Name of the `requirements.txt` file for `pip`
+ */
+export declare const NAME_REQUIREMENTS_TXT = "requirements.txt";
+/**
+ * Name of the `$schema` property which can be present in JSON files; it may need to be removed to
+ * avoid warnings/errors by 3p libs
+ */
+export declare const NAME_SCHEMA = "$schema";
+/**
+ * Name of the `mkdocs` executable
+ */
+export declare const NAME_MKDOCS = "mkdocs";
+/**
+ * Name of the `mike` executable
+ */
+export declare const NAME_MIKE = "mike";
+/**
+ * Name of the `typedoc` executable
+ */
+export declare const NAME_TYPEDOC = "typedoc";
+/**
+ * Name of the `pip` module.
+ *
+ * @remarks We don't execute the `pip` executable; but rather use `python -m pip` since that seems
+ * to work better ... on my computer.
+ */
+export declare const NAME_PIP = "pip";
+/**
+ * Name of the `npm` executable, which we use to check for
+ */
+export declare const NAME_NPM = "npm";
+/**
+ * The name of the `typescript` package (not the `tsc` executable)
+ */
+export declare const NAME_TYPESCRIPT = "typescript";
+/**
+ * Code for a "file not found" error
+ */
+export declare const NAME_ERR_ENOENT = "ENOENT";
+/**
+ * Code for a "file already exists" error
+ */
+export declare const NAME_ERR_EEXIST = "EEXIST";
+/**
+ * Default log level
+ */
+export declare const DEFAULT_LOG_LEVEL = "info";
+/**
+ * Blocking I/O
+ */
+export declare const PKG_ROOT_DIR: string;
+/**
+ * Blocking I/O
+ */
+export declare const DOCUTILS_PKG: PackageJson;
+/**
+ * Path to the `requirements.txt` file (in this package)
+ */
+export declare const REQUIREMENTS_TXT_PATH: string;
+/**
+ * The default output path for Typedoc, computed relative to the consuming package's root
+ */
+export declare const DEFAULT_REL_TYPEDOC_OUT_PATH: string;
+/**
+ * The default branch to deploy to
+ */
+export declare const DEFAULT_DEPLOY_BRANCH = "gh-pages";
+/**
+ * The default remote to push the deployed branch to
+ */
+export declare const DEFAULT_DEPLOY_REMOTE = "origin";
+/**
+ * The default port for serving docs
+ */
+export declare const DEFAULT_SERVE_PORT = 8000;
+/**
+ * The default host for serving docs
+ */
+export declare const DEFAULT_SERVE_HOST = "localhost";
+/**
+ * Mapping of `@appium/docutils`' log levels to `consola` log levels
+ */
+export declare const LogLevelMap: {
+    readonly silent: LogLevel;
+    readonly error: LogLevel;
+    readonly warn: LogLevel;
+    readonly info: LogLevel;
+    readonly debug: LogLevel;
+};
+/**
+ * Default site nav header text
+ */
+export declare const DEFAULT_NAV_HEADER = "Reference";
+//# sourceMappingURL=constants.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../lib/constants.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAC,QAAQ,EAAC,MAAM,SAAS,CAAC;AAIjC,OAAO,EAAC,WAAW,EAAC,MAAM,WAAW,CAAC;AAEtC;;GAEG;AACH,eAAO,MAAM,QAAQ,gBAAgB,CAAC;AAEtC;;GAEG;AACH,eAAO,MAAM,eAAe,eAAe,CAAC;AAE5C;;GAEG;AACH,eAAO,MAAM,kBAAkB,kBAAkB,CAAC;AAClD;;GAEG;AACH,eAAO,MAAM,WAAW,WAAW,CAAC;AACpC;;GAEG;AACH,eAAO,MAAM,iBAAiB,iBAAiB,CAAC;AAChD;;GAEG;AACH,eAAO,MAAM,iBAAiB,iBAAiB,CAAC;AAChD;;GAEG;AACH,eAAO,MAAM,qBAAqB,qBAAqB,CAAC;AACxD;;;GAGG;AACH,eAAO,MAAM,WAAW,YAAY,CAAC;AACrC;;GAEG;AACH,eAAO,MAAM,WAAW,WAAW,CAAC;AAEpC;;GAEG;AACH,eAAO,MAAM,SAAS,SAAS,CAAC;AAEhC;;GAEG;AACH,eAAO,MAAM,YAAY,YAAY,CAAC;AAEtC;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,QAAQ,CAAC;AAE9B;;GAEG;AACH,eAAO,MAAM,QAAQ,QAAQ,CAAC;AAE9B;;GAEG;AACH,eAAO,MAAM,eAAe,eAAe,CAAC;AAE5C;;GAEG;AACH,eAAO,MAAM,eAAe,WAAW,CAAC;AAExC;;GAEG;AACH,eAAO,MAAM,eAAe,WAAW,CAAC;AAExC;;GAEG;AACH,eAAO,MAAM,iBAAiB,SAAS,CAAC;AACxC;;GAEG;AACH,eAAO,MAAM,YAAY,QAAyB,CAAC;AACnD;;GAEG;AAEH,eAAO,MAAM,YAAY,EAAE,WAE1B,CAAC;AAEF;;GAEG;AAEH,eAAO,MAAM,qBAAqB,QAAiD,CAAC;AAEpF;;GAEG;AACH,eAAO,MAAM,4BAA4B,QAAiC,CAAC;AAE3E;;GAEG;AACH,eAAO,MAAM,qBAAqB,aAAa,CAAC;AAEhD;;GAEG;AACH,eAAO,MAAM,qBAAqB,WAAW,CAAC;AAE9C;;GAEG;AACH,eAAO,MAAM,kBAAkB,OAAO,CAAC;AAEvC;;GAEG;AACH,eAAO,MAAM,kBAAkB,cAAc,CAAC;AAE9C;;GAEG;AACH,eAAO,MAAM,WAAW;;;;;;CAMd,CAAC;AAEX;;GAEG;AACH,eAAO,MAAM,kBAAkB,cAAc,CAAC"}

package/build/lib/constants.js

@@ -0,0 +1,133 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_NAV_HEADER = exports.LogLevelMap = exports.DEFAULT_SERVE_HOST = exports.DEFAULT_SERVE_PORT = exports.DEFAULT_DEPLOY_REMOTE = exports.DEFAULT_DEPLOY_BRANCH = exports.DEFAULT_REL_TYPEDOC_OUT_PATH = exports.REQUIREMENTS_TXT_PATH = exports.DOCUTILS_PKG = exports.PKG_ROOT_DIR = exports.DEFAULT_LOG_LEVEL = exports.NAME_ERR_EEXIST = exports.NAME_ERR_ENOENT = exports.NAME_TYPESCRIPT = exports.NAME_NPM = exports.NAME_PIP = exports.NAME_TYPEDOC = exports.NAME_MIKE = exports.NAME_MKDOCS = exports.NAME_SCHEMA = exports.NAME_REQUIREMENTS_TXT = exports.NAME_PACKAGE_JSON = exports.NAME_TYPEDOC_JSON = exports.NAME_PYTHON = exports.NAME_TSCONFIG_JSON = exports.NAME_MKDOCS_YML = exports.NAME_BIN = void 0;
+/**
+ * Constants used across various modules in this package
+ * @module
+ */
+const consola_1 = require("consola");
+const node_fs_1 = require("node:fs");
+const support_1 = require("@appium/support");
+const node_path_1 = __importDefault(require("node:path"));
+/**
+ * CLI executable name
+ */
+exports.NAME_BIN = 'appium-docs';
+/**
+ * Expected name of the `mkdocs.yml` config file
+ */
+exports.NAME_MKDOCS_YML = 'mkdocs.yml';
+/**
+ * Default name of the `tsconfig.json` config file
+ */
+exports.NAME_TSCONFIG_JSON = 'tsconfig.json';
+/**
+ * `python` executable
+ */
+exports.NAME_PYTHON = 'python';
+/**
+ * Default name of the `typedoc.json` config file
+ */
+exports.NAME_TYPEDOC_JSON = 'typedoc.json';
+/**
+ * It's `package.json`!
+ */
+exports.NAME_PACKAGE_JSON = 'package.json';
+/**
+ * Name of the `requirements.txt` file for `pip`
+ */
+exports.NAME_REQUIREMENTS_TXT = 'requirements.txt';
+/**
+ * Name of the `$schema` property which can be present in JSON files; it may need to be removed to
+ * avoid warnings/errors by 3p libs
+ */
+exports.NAME_SCHEMA = '$schema';
+/**
+ * Name of the `mkdocs` executable
+ */
+exports.NAME_MKDOCS = 'mkdocs';
+/**
+ * Name of the `mike` executable
+ */
+exports.NAME_MIKE = 'mike';
+/**
+ * Name of the `typedoc` executable
+ */
+exports.NAME_TYPEDOC = 'typedoc';
+/**
+ * Name of the `pip` module.
+ *
+ * @remarks We don't execute the `pip` executable; but rather use `python -m pip` since that seems
+ * to work better ... on my computer.
+ */
+exports.NAME_PIP = 'pip';
+/**
+ * Name of the `npm` executable, which we use to check for
+ */
+exports.NAME_NPM = 'npm';
+/**
+ * The name of the `typescript` package (not the `tsc` executable)
+ */
+exports.NAME_TYPESCRIPT = 'typescript';
+/**
+ * Code for a "file not found" error
+ */
+exports.NAME_ERR_ENOENT = 'ENOENT';
+/**
+ * Code for a "file already exists" error
+ */
+exports.NAME_ERR_EEXIST = 'EEXIST';
+/**
+ * Default log level
+ */
+exports.DEFAULT_LOG_LEVEL = 'info';
+/**
+ * Blocking I/O
+ */
+exports.PKG_ROOT_DIR = support_1.fs.findRoot(__dirname);
+/**
+ * Blocking I/O
+ */
+exports.DOCUTILS_PKG = JSON.parse((0, node_fs_1.readFileSync)(node_path_1.default.join(exports.PKG_ROOT_DIR, exports.NAME_PACKAGE_JSON), 'utf8'));
+/**
+ * Path to the `requirements.txt` file (in this package)
+ */
+exports.REQUIREMENTS_TXT_PATH = node_path_1.default.join(exports.PKG_ROOT_DIR, exports.NAME_REQUIREMENTS_TXT);
+/**
+ * The default output path for Typedoc, computed relative to the consuming package's root
+ */
+exports.DEFAULT_REL_TYPEDOC_OUT_PATH = node_path_1.default.join('docs', 'reference');
+/**
+ * The default branch to deploy to
+ */
+exports.DEFAULT_DEPLOY_BRANCH = 'gh-pages';
+/**
+ * The default remote to push the deployed branch to
+ */
+exports.DEFAULT_DEPLOY_REMOTE = 'origin';
+/**
+ * The default port for serving docs
+ */
+exports.DEFAULT_SERVE_PORT = 8000;
+/**
+ * The default host for serving docs
+ */
+exports.DEFAULT_SERVE_HOST = 'localhost';
+/**
+ * Mapping of `@appium/docutils`' log levels to `consola` log levels
+ */
+exports.LogLevelMap = {
+    silent: consola_1.LogLevel.Silent,
+    error: consola_1.LogLevel.Error,
+    warn: consola_1.LogLevel.Warn,
+    info: consola_1.LogLevel.Info,
+    debug: consola_1.LogLevel.Debug,
+};
+/**
+ * Default site nav header text
+ */
+exports.DEFAULT_NAV_HEADER = 'Reference';
+//# sourceMappingURL=constants.js.map

package/build/lib/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../lib/constants.ts"],"names":[],"mappings":";;;;;;AAAA;;;GAGG;AACH,qCAAiC;AACjC,qCAAqC;AACrC,6CAAmC;AACnC,0DAA6B;AAG7B;;GAEG;AACU,QAAA,QAAQ,GAAG,aAAa,CAAC;AAEtC;;GAEG;AACU,QAAA,eAAe,GAAG,YAAY,CAAC;AAE5C;;GAEG;AACU,QAAA,kBAAkB,GAAG,eAAe,CAAC;AAClD;;GAEG;AACU,QAAA,WAAW,GAAG,QAAQ,CAAC;AACpC;;GAEG;AACU,QAAA,iBAAiB,GAAG,cAAc,CAAC;AAChD;;GAEG;AACU,QAAA,iBAAiB,GAAG,cAAc,CAAC;AAChD;;GAEG;AACU,QAAA,qBAAqB,GAAG,kBAAkB,CAAC;AACxD;;;GAGG;AACU,QAAA,WAAW,GAAG,SAAS,CAAC;AACrC;;GAEG;AACU,QAAA,WAAW,GAAG,QAAQ,CAAC;AAEpC;;GAEG;AACU,QAAA,SAAS,GAAG,MAAM,CAAC;AAEhC;;GAEG;AACU,QAAA,YAAY,GAAG,SAAS,CAAC;AAEtC;;;;;GAKG;AACU,QAAA,QAAQ,GAAG,KAAK,CAAC;AAE9B;;GAEG;AACU,QAAA,QAAQ,GAAG,KAAK,CAAC;AAE9B;;GAEG;AACU,QAAA,eAAe,GAAG,YAAY,CAAC;AAE5C;;GAEG;AACU,QAAA,eAAe,GAAG,QAAQ,CAAC;AAExC;;GAEG;AACU,QAAA,eAAe,GAAG,QAAQ,CAAC;AAExC;;GAEG;AACU,QAAA,iBAAiB,GAAG,MAAM,CAAC;AACxC;;GAEG;AACU,QAAA,YAAY,GAAG,YAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;AACnD;;GAEG;AAEU,QAAA,YAAY,GAAgB,IAAI,CAAC,KAAK,CACjD,IAAA,sBAAY,EAAC,mBAAI,CAAC,IAAI,CAAC,oBAAY,EAAE,yBAAiB,CAAC,EAAE,MAAM,CAAC,CACjE,CAAC;AAEF;;GAEG;AAEU,QAAA,qBAAqB,GAAG,mBAAI,CAAC,IAAI,CAAC,oBAAY,EAAE,6BAAqB,CAAC,CAAC;AAEpF;;GAEG;AACU,QAAA,4BAA4B,GAAG,mBAAI,CAAC,IAAI,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;AAE3E;;GAEG;AACU,QAAA,qBAAqB,GAAG,UAAU,CAAC;AAEhD;;GAEG;AACU,QAAA,qBAAqB,GAAG,QAAQ,CAAC;AAE9C;;GAEG;AACU,QAAA,kBAAkB,GAAG,IAAI,CAAC;AAEvC;;GAEG;AACU,QAAA,kBAAkB,GAAG,WAAW,CAAC;AAE9C;;GAEG;AACU,QAAA,WAAW,GAAG;IACzB,MAAM,EAAE,kBAAQ,CAAC,MAAM;IACvB,KAAK,EAAE,kBAAQ,CAAC,KAAK;IACrB,IAAI,EAAE,kBAAQ,CAAC,IAAI;IACnB,IAAI,EAAE,kBAAQ,CAAC,IAAI;IACnB,KAAK,EAAE,kBAAQ,CAAC,KAAK;CACb,CAAC;AAEX;;GAEG;AACU,QAAA,kBAAkB,GAAG,WAAW,CAAC"}

package/build/lib/error.d.ts

@@ -0,0 +1,3 @@
+export declare class DocutilsError extends Error {
+}
+//# sourceMappingURL=error.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../../lib/error.ts"],"names":[],"mappings":"AAAA,qBAAa,aAAc,SAAQ,KAAK;CAAG"}

package/build/lib/error.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocutilsError = void 0;
+class DocutilsError extends Error {
+}
+exports.DocutilsError = DocutilsError;
+//# sourceMappingURL=error.js.map

package/build/lib/error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.js","sourceRoot":"","sources":["../../lib/error.ts"],"names":[],"mappings":";;;AAAA,MAAa,aAAc,SAAQ,KAAK;CAAG;AAA3C,sCAA2C"}