@appium/docutils 0.1.6 → 0.2.0

package/build/lib/init.d.ts

@@ -0,0 +1,202 @@
+/**
+ * Scaffolding functions for CLI `init` command
+ *
+ * @module
+ */
+import { Simplify } from 'type-fest';
+import { ScaffoldTaskOptions } from './scaffold';
+/**
+ * Function which scaffolds a `tsconfig.json` file
+ */
+export declare const initTsConfigJson: import("./scaffold").ScaffoldTask<InitTsConfigOptions, import("type-fest/source/jsonify").JsonifyObject<Simplify<{} & {
+    $schema?: string | undefined;
+    compilerOptions?: import("type-fest").TsConfigJson.CompilerOptions | undefined;
+    watchOptions?: import("type-fest").TsConfigJson.WatchOptions | undefined;
+    typeAcquisition?: import("type-fest").TsConfigJson.TypeAcquisition | undefined;
+    compileOnSave?: boolean | undefined;
+    extends?: string | undefined;
+    files?: string[] | undefined;
+    exclude?: string[] | undefined;
+    include?: string[] | undefined;
+    references?: import("type-fest").TsConfigJson.References[] | undefined;
+}>>>;
+/**
+ * Function which scaffolds a `typedoc.json` file
+ */
+export declare const initTypeDocJson: import("./scaffold").ScaffoldTask<InitTypeDocOptions, import("type-fest/source/jsonify").JsonifyObject<Simplify<{} & {
+    $schema?: string | undefined;
+    includes?: string | undefined;
+    extends?: string | undefined;
+    exclude?: string[] | undefined;
+    options?: string | undefined;
+    tsconfig?: string | undefined;
+    entryPoints?: string[] | undefined;
+    entryPointStrategy?: "Resolve" | "resolve" | "Expand" | "Packages" | "expand" | "packages" | undefined;
+    externalPattern?: string[] | undefined;
+    excludeExternals?: boolean | undefined;
+    excludeNotDocumented?: boolean | undefined;
+    excludeInternal?: boolean | undefined;
+    excludePrivate?: boolean | undefined;
+    excludeProtected?: boolean | undefined;
+    externalSymbolLinkMappings?: Record<string, Record<string, string>> | undefined;
+    media?: string | undefined;
+    out?: string | undefined;
+    json?: string | undefined;
+    pretty?: boolean | undefined;
+    emit?: "docs" | "both" | "none" | undefined;
+    theme?: string | undefined;
+    lightHighlightTheme?: import("shiki").Theme | undefined;
+    darkHighlightTheme?: import("shiki").Theme | undefined;
+    customCss?: string | undefined;
+    name?: string | undefined;
+    includeVersion?: boolean | undefined;
+    disableSources?: boolean | undefined;
+    basePath?: string | undefined;
+    excludeTags?: `@${string}`[] | undefined;
+    readme?: string | undefined;
+    cname?: string | undefined;
+    sourceLinkTemplate?: string | undefined;
+    gitRevision?: string | undefined;
+    gitRemote?: string | undefined;
+    htmlLang?: string | undefined;
+    githubPages?: boolean | undefined;
+    gaID?: string | undefined;
+    hideGenerator?: boolean | undefined;
+    searchInComments?: boolean | undefined;
+    cleanOutputDir?: boolean | undefined;
+    titleLink?: string | undefined;
+    navigationLinks?: Record<string, string> | undefined;
+    sidebarLinks?: Record<string, string> | undefined;
+    commentStyle?: "JSDoc" | "jsdoc" | "Block" | "Line" | "All" | "block" | "line" | "all" | undefined;
+    blockTags?: `@${string}`[] | undefined;
+    inlineTags?: `@${string}`[] | undefined;
+    modifierTags?: `@${string}`[] | undefined;
+    categorizeByGroup?: boolean | undefined;
+    defaultCategory?: string | undefined;
+    categoryOrder?: string[] | undefined;
+    sort?: ("source-order" | "alphabetical" | "enum-value-ascending" | "enum-value-descending" | "static-first" | "instance-first" | "visibility" | "required-first" | "kind")[] | undefined;
+    kindSortOrder?: ("Reference" | "All" | "Project" | "Module" | "Namespace" | "Enum" | "EnumMember" | "Variable" | "Function" | "Class" | "Interface" | "Constructor" | "Property" | "Method" | "CallSignature" | "IndexSignature" | "ConstructorSignature" | "Parameter" | "TypeLiteral" | "TypeParameter" | "Accessor" | "GetSignature" | "SetSignature" | "ObjectLiteral" | "TypeAlias" | "ClassOrInterface" | "VariableOrProperty" | "FunctionOrMethod" | "ClassMember" | "SomeSignature" | "SomeModule" | "SomeType" | "SomeValue" | "SomeMember" | "SomeExport" | "ExportContainer" | "Inheritable" | "ContainsCallSignatures" | "SignatureContainer")[] | undefined;
+    visibilityFilters?: {
+        [tag: `@${string}`]: boolean;
+        protected?: boolean | undefined;
+        private?: boolean | undefined;
+        inherited?: boolean | undefined;
+        external?: boolean | undefined;
+    } | undefined;
+    searchCategoryBoosts?: Record<string, number> | undefined;
+    searchGroupBoosts?: Record<string, number> | undefined;
+    watch?: boolean | undefined;
+    preserveWatchOutput?: boolean | undefined;
+    skipErrorChecking?: boolean | undefined;
+    help?: boolean | undefined;
+    version?: boolean | undefined;
+    showConfig?: boolean | undefined;
+    plugin?: string[] | undefined;
+    logLevel?: import("typedoc").LogLevel | "Verbose" | "Info" | "Warn" | "Error" | undefined;
+    treatWarningsAsErrors?: boolean | undefined;
+    intentionallyNotExported?: string[] | undefined;
+    validation?: boolean | Partial<import("typedoc").ValidationOptions> | undefined;
+    requiredToBeDocumented?: ("Reference" | "All" | "Project" | "Module" | "Namespace" | "Enum" | "EnumMember" | "Variable" | "Function" | "Class" | "Interface" | "Constructor" | "Property" | "Method" | "CallSignature" | "IndexSignature" | "ConstructorSignature" | "Parameter" | "TypeLiteral" | "TypeParameter" | "Accessor" | "GetSignature" | "SetSignature" | "ObjectLiteral" | "TypeAlias" | "ClassOrInterface" | "VariableOrProperty" | "FunctionOrMethod" | "ClassMember" | "SomeSignature" | "SomeModule" | "SomeType" | "SomeValue" | "SomeMember" | "SomeExport" | "ExportContainer" | "Inheritable" | "ContainsCallSignatures" | "SignatureContainer")[] | undefined;
+}>>>;
+/**
+ * Function which scaffolds an `mkdocs.yml` file
+ */
+export declare const initMkDocs: import("./scaffold").ScaffoldTask<InitMkDocsOptions, import("type-fest/source/jsonify").JsonifyObject<Simplify<{} & {
+    theme?: import("./model").MkDocsYmlTheme | undefined;
+    watch?: string[] | undefined;
+    copyright?: string | undefined;
+    dev_addr?: string | undefined;
+    docs_dir?: string | undefined;
+    extra_css?: string[] | undefined;
+    extra_javascript?: string[] | undefined;
+    extra_templates?: string[] | undefined;
+    extra?: Record<string, import("type-fest").JsonValue> | undefined;
+    hooks?: string[] | undefined;
+    INHERIT?: string | undefined;
+    markdown_extensions?: (string | Record<string, import("type-fest").JsonValue>)[] | undefined;
+    nav?: import("./model").MkDocsYmlNav | undefined;
+    plugins?: (string | Record<string, import("type-fest").JsonValue>)[] | undefined;
+    repo_name?: string | undefined;
+    repo_url?: string | undefined;
+    site_dir?: string | undefined;
+    site_name?: string | undefined;
+    site_description?: string | undefined;
+    strict?: boolean | undefined;
+    use_directory_urls?: boolean | undefined;
+}>>>;
+/**
+ * Installs Python dependencies
+ * @param opts Options
+ */
+export declare function initPython({ pythonPath, dryRun, }?: InitPythonOptions): Promise<void>;
+/**
+ * Options for {@linkcode initMkDocs}
+ */
+export interface InitMkDocsOptions extends ScaffoldTaskOptions {
+    copyright?: string;
+    repoName?: string;
+    repoUrl?: string;
+    siteDescription?: string;
+    siteName?: string;
+}
+/**
+ * Main handler for `init` command.
+ *
+ * This runs tasks in serial; it _could_ run in parallel, but it has deleterious effects upon
+ * console output which would need mitigation.
+ */
+export declare function init({ typescript, typedoc, python, tsconfigJson: tsconfigJsonPath, packageJson: packageJsonPath, overwrite, include, mkdocs, mkdocsYml: mkdocsYmlPath, siteName, repoName, repoUrl, copyright, dryRun, cwd, pythonPath, typedocJson: typeDocJsonPath, }?: InitOptions): Promise<void>;
+export interface InitTypeDocOptions extends ScaffoldTaskOptions {
+}
+export interface InitTsConfigOptions extends ScaffoldTaskOptions {
+    /**
+     * List of source files (globs supported); typically `src` or `lib`
+     */
+    include?: string[];
+}
+export interface InitPythonOptions extends ScaffoldTaskOptions {
+    /**
+     * Path to `python` (v3.x) executable
+     */
+    pythonPath?: string;
+}
+/**
+ * Options for `init` command handler
+ *
+ * The props of the various "path" options are rewritten as `dest` for the scaffold tasks functions.
+ */
+export declare type InitOptions = Simplify<Omit<InitPythonOptions & InitTsConfigOptions & InitTypeDocOptions & InitMkDocsOptions, 'dest'> & {
+    /**
+     * If `true` will initialize a `tsconfig.json` file
+     */
+    typescript?: boolean;
+    /**
+     * If `true` will initialize a `typedoc.json` file
+     */
+    typedoc?: boolean;
+    /**
+     * If `true` will install Python deps
+     */
+    python?: boolean;
+    /**
+     * If `true` will initialize a `mkdocs.yml` file
+     */
+    mkdocs?: boolean;
+    /**
+     * Path to new or existing `typedoc.json` file
+     */
+    typedocJson?: string;
+    /**
+     * Path to new or existing `tsconfig.json` file
+     */
+    tsconfigJson?: string;
+    /**
+     * Path to existing `package.json` file
+     */
+    packageJson?: string;
+    /**
+     * Path to new or existing `mkdocs.yml` file
+     */
+    mkdocsYml?: string;
+}>;
+//# sourceMappingURL=init.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../../lib/init.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAYH,OAAO,EAAC,QAAQ,EAAC,MAAM,WAAW,CAAC;AAEnC,OAAO,EAAqB,mBAAmB,EAAC,MAAM,YAAY,CAAC;AA0CnE;;GAEG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;;;;IAyB5B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAI3B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;IAiDtB,CAAC;AAEF;;;GAGG;AACH,wBAAsB,UAAU,CAAC,EAC/B,UAAwB,EACxB,MAAc,GACf,GAAE,iBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC,CAoBxC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,mBAAmB;IAC5D,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;;GAKG;AACH,wBAAsB,IAAI,CAAC,EACzB,UAAU,EACV,OAAO,EACP,MAAM,EACN,YAAY,EAAE,gBAAgB,EAC9B,WAAW,EAAE,eAAe,EAC5B,SAAS,EACT,OAAO,EACP,MAAM,EACN,SAAS,EAAE,aAAa,EACxB,QAAQ,EACR,QAAQ,EACR,OAAO,EACP,SAAS,EACT,MAAM,EACN,GAAG,EACH,UAAU,EACV,WAAW,EAAE,eAAe,GAC7B,GAAE,WAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CA6ClC;AAED,MAAM,WAAW,kBAAmB,SAAQ,mBAAmB;CAAG;AAClE,MAAM,WAAW,mBAAoB,SAAQ,mBAAmB;IAC9D;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB;AACD,MAAM,WAAW,iBAAkB,SAAQ,mBAAmB;IAC5D;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;GAIG;AACH,oBAAY,WAAW,GAAG,QAAQ,CAChC,IAAI,CAAC,iBAAiB,GAAG,mBAAmB,GAAG,kBAAkB,GAAG,iBAAiB,EAAE,MAAM,CAAC,GAAG;IAC/F;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CACF,CAAC"}

package/build/lib/init.js

@@ -0,0 +1,225 @@
+"use strict";
+/**
+ * Scaffolding functions for CLI `init` command
+ *
+ * @module
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.init = exports.initPython = exports.initMkDocs = exports.initTypeDocJson = exports.initTsConfigJson = void 0;
+const JSON5 = __importStar(require("json5"));
+const constants_1 = require("./constants");
+const yaml_1 = __importDefault(require("yaml"));
+const teen_process_1 = require("teen_process");
+const error_1 = require("./error");
+const scaffold_1 = require("./scaffold");
+const logger_1 = __importDefault(require("./logger"));
+const lodash_1 = __importDefault(require("lodash"));
+const fs_1 = require("./fs");
+/**
+ * Data for the base `mkdocs.yml` file
+ */
+const BASE_MKDOCS_YML = Object.freeze({
+    INHERIT: './node_modules/@appium/docutils/base-mkdocs.yml',
+    docs_dir: 'docs',
+    site_dir: 'site',
+});
+/**
+ * Data for the base `typedoc.json` file
+ */
+const BASE_TYPEDOC_JSON = Object.freeze({
+    $schema: 'https://typedoc.org/schema.json',
+    cleanOutputDir: true,
+    entryPointStrategy: 'packages',
+    theme: 'appium',
+    readme: 'none',
+    entryPoints: ['.'],
+});
+/**
+ * Data for the base `tsconfig.json` file
+ */
+const BASE_TSCONFIG_JSON = Object.freeze({
+    $schema: 'https://json.schemastore.org/tsconfig',
+    extends: '@appium/tsconfig/tsconfig.json',
+    compilerOptions: {
+        outDir: 'build',
+    },
+});
+const log = logger_1.default.withTag('init');
+const dryRunLog = log.withTag('dry-run');
+const DEFAULT_INCLUDE = ['lib', 'test', 'index.js'];
+/**
+ * Function which scaffolds a `tsconfig.json` file
+ */
+exports.initTsConfigJson = (0, scaffold_1.createScaffoldTask)(constants_1.NAME_TSCONFIG_JSON, BASE_TSCONFIG_JSON, 'TypeScript configuration', {
+    /**
+     * Merges the contents of the `include` property with any passed on the CLI. If neither exists,
+     * uses the default set of includes.
+     * @param content Parsed and/or scaffolded `tsconfig.json`
+     * @param opts Options specific to this task
+     * @returns `tsconfig.json` content with potentially-modified `include` prop
+     */
+    transform: (content, { include }) => {
+        include = [...(content.include ?? include ?? [])];
+        if (lodash_1.default.isEmpty(include)) {
+            include = [...DEFAULT_INCLUDE];
+        }
+        return {
+            ...content,
+            include: lodash_1.default.uniq(include),
+        };
+    },
+    deserialize: JSON5.parse,
+    serialize: fs_1.stringifyJson5,
+});
+/**
+ * Function which scaffolds a `typedoc.json` file
+ */
+exports.initTypeDocJson = (0, scaffold_1.createScaffoldTask)(constants_1.NAME_TYPEDOC_JSON, BASE_TYPEDOC_JSON, 'TypeDoc configuration');
+/**
+ * Function which scaffolds an `mkdocs.yml` file
+ */
+exports.initMkDocs = (0, scaffold_1.createScaffoldTask)(constants_1.NAME_MKDOCS_YML, BASE_MKDOCS_YML, 'MkDocs configuration', {
+    deserialize: yaml_1.default.parse,
+    serialize: fs_1.stringifyYaml,
+    transform: (content, opts, pkg) => {
+        let siteName = opts.siteName ?? content.site_name;
+        if (!siteName) {
+            siteName = pkg.name ?? '(no name)';
+            if (siteName) {
+                log.info('Using site name from package.json: %s', siteName);
+            }
+        }
+        let repoUrl = opts.repoUrl ?? content.repo_url;
+        if (!repoUrl) {
+            repoUrl = pkg.repository?.url;
+            if (repoUrl) {
+                log.info('Using repo URL from package.json: %s', repoUrl);
+            }
+        }
+        let repoName = opts.repoName ?? content.repo_name;
+        if (repoUrl && !repoName) {
+            let { pathname } = new URL(repoUrl);
+            pathname = pathname.slice(1);
+            let [owner, repo] = pathname.split('/');
+            repo = repo.replace(/\.git$/, '');
+            repoName = [owner, repo].join('/');
+            if (repoName) {
+                log.info('Using repo name from package.json: %s', repoName);
+            }
+        }
+        let siteDescription = opts.siteDescription ?? content.site_description;
+        if (!siteDescription) {
+            siteDescription = pkg.description;
+            if (siteDescription) {
+                log.info('Using site description URL from package.json: %s', siteDescription);
+            }
+        }
+        return {
+            ...content,
+            site_name: siteName,
+            repo_url: repoUrl,
+            repo_name: repoName,
+            site_description: siteDescription,
+        };
+    },
+});
+/**
+ * Installs Python dependencies
+ * @param opts Options
+ */
+async function initPython({ pythonPath = constants_1.NAME_PYTHON, dryRun = false, } = {}) {
+    const args = ['-m', 'pip', 'install', '-r', constants_1.REQUIREMENTS_TXT_PATH];
+    if (dryRun) {
+        dryRunLog.info('Would execute command: %s %s', pythonPath, args.join(' '));
+    }
+    else {
+        log.debug('Executing command: %s %s', pythonPath, args.join(' '));
+        log.info('Installing Python dependencies...');
+        try {
+            const result = await (0, teen_process_1.exec)(pythonPath, args, { shell: true });
+            const { code, stdout } = result;
+            if (code !== 0) {
+                throw new error_1.DocutilsError(`Could not install Python dependencies. Reason: ${stdout}`);
+            }
+        }
+        catch (err) {
+            throw new error_1.DocutilsError(`Could not install Python dependencies. Reason: ${err.message}`);
+        }
+    }
+    log.success('Installed Python dependencies (or dependencies already installed)');
+}
+exports.initPython = initPython;
+/**
+ * Main handler for `init` command.
+ *
+ * This runs tasks in serial; it _could_ run in parallel, but it has deleterious effects upon
+ * console output which would need mitigation.
+ */
+async function init({ typescript, typedoc, python, tsconfigJson: tsconfigJsonPath, packageJson: packageJsonPath, overwrite, include, mkdocs, mkdocsYml: mkdocsYmlPath, siteName, repoName, repoUrl, copyright, dryRun, cwd, pythonPath, typedocJson: typeDocJsonPath, } = {}) {
+    if (!typescript && typedoc) {
+        log.warn('Initialization of tsconfig.json disabled. TypeDoc requires a tsconfig.json; please ensure it exists');
+    }
+    if (typescript) {
+        await (0, exports.initTsConfigJson)({
+            dest: tsconfigJsonPath,
+            packageJson: packageJsonPath,
+            overwrite,
+            include,
+            dryRun,
+            cwd,
+        });
+    }
+    if (typedoc) {
+        await (0, exports.initTypeDocJson)({
+            dest: typeDocJsonPath,
+            packageJson: packageJsonPath,
+            overwrite,
+            dryRun,
+            cwd,
+        });
+    }
+    if (python) {
+        await initPython({ pythonPath, dryRun });
+    }
+    if (mkdocs) {
+        await (0, exports.initMkDocs)({
+            dest: mkdocsYmlPath,
+            cwd,
+            siteName,
+            repoUrl,
+            repoName,
+            copyright,
+            packageJson: packageJsonPath,
+            overwrite,
+            dryRun,
+        });
+    }
+}
+exports.init = init;
+//# sourceMappingURL=init.js.map

package/build/lib/init.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"init.js","sourceRoot":"","sources":["../../lib/init.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,6CAA+B;AAC/B,2CAMqB;AACrB,gDAAwB;AACxB,+CAAkC;AAElC,mCAAsC;AACtC,yCAAmE;AACnE,sDAA8B;AAE9B,oDAAuB;AACvB,6BAAmD;AAEnD;;GAEG;AACH,MAAM,eAAe,GAAwB,MAAM,CAAC,MAAM,CAAC;IACzD,OAAO,EAAE,iDAAiD;IAC1D,QAAQ,EAAE,MAAM;IAChB,QAAQ,EAAE,MAAM;CACjB,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,iBAAiB,GAA0B,MAAM,CAAC,MAAM,CAAC;IAC7D,OAAO,EAAE,iCAAiC;IAC1C,cAAc,EAAE,IAAI;IACpB,kBAAkB,EAAE,UAAU;IAC9B,KAAK,EAAE,QAAQ;IACf,MAAM,EAAE,MAAM;IACd,WAAW,EAAE,CAAC,GAAG,CAAC;CACnB,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,kBAAkB,GAA2B,MAAM,CAAC,MAAM,CAAC;IAC/D,OAAO,EAAE,uCAAuC;IAChD,OAAO,EAAE,gCAAgC;IACzC,eAAe,EAAE;QACf,MAAM,EAAE,OAAO;KAChB;CACF,CAAC,CAAC;AAEH,MAAM,GAAG,GAAG,gBAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;AACnC,MAAM,SAAS,GAAG,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;AAEzC,MAAM,eAAe,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;AACpD;;GAEG;AACU,QAAA,gBAAgB,GAAG,IAAA,6BAAkB,EAChD,8BAAkB,EAClB,kBAAkB,EAClB,0BAA0B,EAC1B;IACE;;;;;;OAMG;IACH,SAAS,EAAE,CAAC,OAAO,EAAE,EAAC,OAAO,EAAC,EAAE,EAAE;QAChC,OAAO,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,IAAI,OAAO,IAAI,EAAE,CAAC,CAAC,CAAC;QAClD,IAAI,gBAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;YACtB,OAAO,GAAG,CAAC,GAAG,eAAe,CAAC,CAAC;SAChC;QACD,OAAO;YACL,GAAG,OAAO;YACV,OAAO,EAAE,gBAAC,CAAC,IAAI,CAAC,OAAO,CAAC;SACzB,CAAC;IACJ,CAAC;IACD,WAAW,EAAE,KAAK,CAAC,KAAK;IACxB,SAAS,EAAE,mBAAc;CAC1B,CACF,CAAC;AAEF;;GAEG;AACU,QAAA,eAAe,GAAG,IAAA,6BAAkB,EAC/C,6BAAiB,EACjB,iBAAiB,EACjB,uBAAuB,CACxB,CAAC;AAEF;;GAEG;AACU,QAAA,UAAU,GAAG,IAAA,6BAAkB,EAC1C,2BAAe,EACf,eAAe,EACf,sBAAsB,EACtB;IACE,WAAW,EAAE,cAAI,CAAC,KAAK;IACvB,SAAS,EAAE,kBAAa;IACxB,SAAS,EAAE,CAAC,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,EAAE;QAChC,IAAI,QAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,CAAC,SAAS,CAAC;QAClD,IAAI,CAAC,QAAQ,EAAE;YACb,QAAQ,GAAG,GAAG,CAAC,IAAI,IAAI,WAAW,CAAC;YACnC,IAAI,QAAQ,EAAE;gBACZ,GAAG,CAAC,IAAI,CAAC,uCAAuC,EAAE,QAAQ,CAAC,CAAC;aAC7D;SACF;QACD,IAAI,OAAO,GAAuB,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,QAAQ,CAAC;QACnE,IAAI,CAAC,OAAO,EAAE;YACZ,OAAO,GAAG,GAAG,CAAC,UAAU,EAAE,GAAG,CAAC;YAC9B,IAAI,OAAO,EAAE;gBACX,GAAG,CAAC,IAAI,CAAC,sCAAsC,EAAE,OAAO,CAAC,CAAC;aAC3D;SACF;QACD,IAAI,QAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,CAAC,SAAS,CAAC;QAClD,IAAI,OAAO,IAAI,CAAC,QAAQ,EAAE;YACxB,IAAI,EAAC,QAAQ,EAAC,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC;YAClC,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAC7B,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACxC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;YAClC,QAAQ,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACnC,IAAI,QAAQ,EAAE;gBACZ,GAAG,CAAC,IAAI,CAAC,uCAAuC,EAAE,QAAQ,CAAC,CAAC;aAC7D;SACF;QACD,IAAI,eAAe,GAAG,IAAI,CAAC,eAAe,IAAI,OAAO,CAAC,gBAAgB,CAAC;QACvE,IAAI,CAAC,eAAe,EAAE;YACpB,eAAe,GAAG,GAAG,CAAC,WAAW,CAAC;YAClC,IAAI,eAAe,EAAE;gBACnB,GAAG,CAAC,IAAI,CAAC,kDAAkD,EAAE,eAAe,CAAC,CAAC;aAC/E;SACF;QACD,OAAO;YACL,GAAG,OAAO;YACV,SAAS,EAAE,QAAQ;YACnB,QAAQ,EAAE,OAAO;YACjB,SAAS,EAAE,QAAQ;YACnB,gBAAgB,EAAE,eAAe;SAClC,CAAC;IACJ,CAAC;CACF,CACF,CAAC;AAEF;;;GAGG;AACI,KAAK,UAAU,UAAU,CAAC,EAC/B,UAAU,GAAG,uBAAW,EACxB,MAAM,GAAG,KAAK,MACO,EAAE;IACvB,MAAM,IAAI,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,iCAAqB,CAAC,CAAC;IACnE,IAAI,MAAM,EAAE;QACV,SAAS,CAAC,IAAI,CAAC,8BAA8B,EAAE,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;KAC5E;SAAM;QACL,GAAG,CAAC,KAAK,CAAC,0BAA0B,EAAE,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QAClE,GAAG,CAAC,IAAI,CAAC,mCAAmC,CAAC,CAAC;QAC9C,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,IAAA,mBAAI,EAAC,UAAU,EAAE,IAAI,EAAE,EAAC,KAAK,EAAE,IAAI,EAAC,CAAC,CAAC;YAC3D,MAAM,EAAC,IAAI,EAAE,MAAM,EAAC,GAAG,MAAM,CAAC;YAC9B,IAAI,IAAI,KAAK,CAAC,EAAE;gBACd,MAAM,IAAI,qBAAa,CAAC,kDAAkD,MAAM,EAAE,CAAC,CAAC;aACrF;SACF;QAAC,OAAO,GAAG,EAAE;YACZ,MAAM,IAAI,qBAAa,CACrB,kDAAmD,GAAa,CAAC,OAAO,EAAE,CAC3E,CAAC;SACH;KACF;IACD,GAAG,CAAC,OAAO,CAAC,mEAAmE,CAAC,CAAC;AACnF,CAAC;AAvBD,gCAuBC;AAaD;;;;;GAKG;AACI,KAAK,UAAU,IAAI,CAAC,EACzB,UAAU,EACV,OAAO,EACP,MAAM,EACN,YAAY,EAAE,gBAAgB,EAC9B,WAAW,EAAE,eAAe,EAC5B,SAAS,EACT,OAAO,EACP,MAAM,EACN,SAAS,EAAE,aAAa,EACxB,QAAQ,EACR,QAAQ,EACR,OAAO,EACP,SAAS,EACT,MAAM,EACN,GAAG,EACH,UAAU,EACV,WAAW,EAAE,eAAe,MACb,EAAE;IACjB,IAAI,CAAC,UAAU,IAAI,OAAO,EAAE;QAC1B,GAAG,CAAC,IAAI,CACN,qGAAqG,CACtG,CAAC;KACH;IAED,IAAI,UAAU,EAAE;QACd,MAAM,IAAA,wBAAgB,EAAC;YACrB,IAAI,EAAE,gBAAgB;YACtB,WAAW,EAAE,eAAe;YAC5B,SAAS;YACT,OAAO;YACP,MAAM;YACN,GAAG;SACJ,CAAC,CAAC;KACJ;IAED,IAAI,OAAO,EAAE;QACX,MAAM,IAAA,uBAAe,EAAC;YACpB,IAAI,EAAE,eAAe;YACrB,WAAW,EAAE,eAAe;YAC5B,SAAS;YACT,MAAM;YACN,GAAG;SACJ,CAAC,CAAC;KACJ;IAED,IAAI,MAAM,EAAE;QACV,MAAM,UAAU,CAAC,EAAC,UAAU,EAAE,MAAM,EAAC,CAAC,CAAC;KACxC;IAED,IAAI,MAAM,EAAE;QACV,MAAM,IAAA,kBAAU,EAAC;YACf,IAAI,EAAE,aAAa;YACnB,GAAG;YACH,QAAQ;YACR,OAAO;YACP,QAAQ;YACR,SAAS;YACT,WAAW,EAAE,eAAe;YAC5B,SAAS;YACT,MAAM;SACP,CAAC,CAAC;KACJ;AACH,CAAC;AA/DD,oBA+DC"}

package/build/lib/io.d.ts

@@ -0,0 +1 @@
+//# sourceMappingURL=io.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"io.d.ts","sourceRoot":"","sources":["../../lib/io.ts"],"names":[],"mappings":""}

package/build/lib/io.js

@@ -0,0 +1,2 @@
+"use strict";
+//# sourceMappingURL=io.js.map

package/build/lib/io.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"io.js","sourceRoot":"","sources":["../../lib/io.ts"],"names":[],"mappings":""}

package/build/lib/logger.d.ts

@@ -1,3 +1,18 @@
-declare const _default: import("../../types/build/lib").AppiumLogger;
-export default _default;
+/**
+ * It's a logger.
+ *
+ * Since this is a CLI app only, it doesn't necessarily make sense to consume `@appium/support`'s logger.
+ *
+ * @module
+ */
+import { Consola } from 'consola';
+/**
+ * The logger from which all loggers are created.  This one uses a unique tag and our custom reporter.
+ */
+declare const rootLogger: Consola;
+/**
+ * The proxied root logger
+ * @see {createLogProxy}
+ */
+export default rootLogger;
 //# sourceMappingURL=logger.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../lib/logger.js"],"names":[],"mappings":""}
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../lib/logger.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAKH,OAAgB,EAKd,OAAO,EAGR,MAAM,SAAS,CAAC;AAuHjB;;GAEG;AACH,QAAA,MAAM,UAAU,SAEf,CAAC;AA6CF;;;GAGG;AACH,eAAe,UAAU,CAAC"}

package/build/lib/logger.js

@@ -1,5 +1,190 @@
 "use strict";
+/**
+ * It's a logger.
+ *
+ * Since this is a CLI app only, it doesn't necessarily make sense to consume `@appium/support`'s logger.
+ *
+ * @module
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-const support_1 = require("@appium/support");
-exports.default = support_1.logger.getLogger('Docutils');
+const figures_1 = __importDefault(require("figures"));
+const log_symbols_1 = __importDefault(require("log-symbols"));
+const chalk_1 = __importDefault(require("chalk"));
+const consola_1 = __importStar(require("consola"));
+const constants_1 = require("./constants");
+const lodash_1 = __importDefault(require("lodash"));
+/**
+ * This is a reporter for `consola` which uses some extra/custom icons and colors.
+ *
+ * @privateRemarks
+ * I did not like that the default `FancyReport` logs errors in _green_ without any sort of icon.
+ * Both `log-symbols` and `consola` consume `chalk`, so we do too. `consola` also depends on `figures`.
+ */
+class DocutilsReporter extends consola_1.FancyReporter {
+    /**
+     * Type guard to check if a log type has a color
+     * @param type A log type
+     */
+    static hasTypeColor(type) {
+        return type in DocutilsReporter.TYPE_COLOR_MAP;
+    }
+    /**
+     * Type guard to check if a log level has a color
+     * @param level A log level
+     */
+    static hasLevelColor(level) {
+        return level in DocutilsReporter.LEVEL_COLORS;
+    }
+    /**
+     * Type guard to check if a log type has an icon
+     * @param type A log type
+     */
+    static hasTypeIcon(type) {
+        return type in DocutilsReporter.TYPE_ICONS;
+    }
+    /**
+     * Prefixes the logging output with colors and symbols, depending on contents of `logObj`.
+     * @param logObj Consola's log object
+     * @param isBadge {@linkcode FancyReporter} uses this; I think it depends on the terminal width
+     * @returns
+     */
+    formatType(logObj, isBadge) {
+        const { TYPE_COLOR_MAP, LEVEL_COLORS, TYPE_ICONS, hasTypeColor, hasLevelColor, hasTypeIcon, DEFAULT_COLOR, } = DocutilsReporter;
+        let typeColor;
+        if (hasTypeColor(logObj.type)) {
+            typeColor = TYPE_COLOR_MAP[logObj.type];
+        }
+        else if (hasLevelColor(logObj.level)) {
+            typeColor = LEVEL_COLORS[logObj.level];
+        }
+        else {
+            typeColor = ((this.options.secondaryColor ?? DEFAULT_COLOR));
+        }
+        if (isBadge) {
+            return chalk_1.default[('bg' + lodash_1.default.capitalize(typeColor))].black(` ${lodash_1.default.toUpper(logObj.type)}`);
+        }
+        const type = hasTypeIcon(logObj.type) ? TYPE_ICONS[logObj.type] : logObj.type;
+        return type ? chalk_1.default[typeColor](type) : '';
+    }
+}
+/**
+ * Mapping of log types (the name of the logging method called) to chalk fg colors
+ */
+DocutilsReporter.TYPE_COLOR_MAP = {
+    info: 'cyan',
+    success: 'green',
+    error: 'red',
+    warn: 'yellow',
+};
+/**
+ * Mapping of log levels to chalk fg colors
+ */
+DocutilsReporter.LEVEL_COLORS = {
+    0: 'red',
+    1: 'yellow',
+    2: 'white',
+    3: 'green',
+};
+/**
+ * Mapping of log types to icons/symbols
+ */
+DocutilsReporter.TYPE_ICONS = {
+    info: log_symbols_1.default.info,
+    success: log_symbols_1.default.success,
+    error: log_symbols_1.default.error,
+    warn: log_symbols_1.default.warning,
+    debug: (0, figures_1.default)('›'),
+    trace: (0, figures_1.default)('›'),
+};
+/**
+ * Default color to use if we can't find a color for the log type or level
+ */
+DocutilsReporter.DEFAULT_COLOR = 'grey';
+/**
+ * The global log level
+ *
+ * "Global" inasmuch as any logger created from the root logger will use this level.
+ */
+let globalLevel = constants_1.LogLevelMap[constants_1.DEFAULT_LOG_LEVEL];
+/**
+ * The logger from which all loggers are created.  This one uses a unique tag and our custom reporter.
+ */
+const rootLogger = createLogProxy(consola_1.default.create({ defaults: { tag: 'docutils' }, reporters: [new DocutilsReporter()] }));
+/**
+ * @summary Creates a log-level-propagating proxy for a {@linkcode Consola} logger.
+ * @description
+ * Alright.  So when you create a new logger via {@linkcode Consola.create}, it's basically a clone
+ * of its parent with a new set of options.
+ *
+ * If we change the log level of the root logger (which we do: see `cli/index.ts`), we may (almost
+ * certainly) have
+ * child loggers which: a) have already been created and b) have inherited the old/default log level
+ * from the root logger. We don't _want_ that (though this is likely a reasonable use case) for our
+ * purposes.
+ *
+ * The implementation below solves the problem by maintaining its own singleton log level value, and
+ * intercepts the `level` property of any logger created from the root logger.
+ *
+ * There are other ways to go about this which may be better, but this seemed pretty straightforward.
+ */
+function createLogProxy(logger) {
+    return new Proxy(logger, {
+        get(target, prop, receiver) {
+            if (prop === 'level') {
+                return globalLevel;
+            }
+            if (prop === 'create') {
+                const create = Reflect.get(target, prop, receiver);
+                return (opts) => createLogProxy(create.call(receiver, opts));
+            }
+            if (prop === '_defaults') {
+                const defaults = Reflect.get(target, prop, receiver);
+                return { ...defaults, level: globalLevel };
+            }
+            return Reflect.get(target, prop, receiver);
+        },
+        set(target, prop, value, receiver) {
+            if (prop === 'level') {
+                globalLevel = value;
+                return true;
+            }
+            return Reflect.set(target, prop, value, receiver);
+        },
+    });
+}
+/**
+ * The proxied root logger
+ * @see {createLogProxy}
+ */
+exports.default = rootLogger;
+// these are just type-sanity checks
+DocutilsReporter.TYPE_COLOR_MAP;
+DocutilsReporter.LEVEL_COLORS;
+DocutilsReporter.TYPE_ICONS;
 //# sourceMappingURL=logger.js.map