@appium/docutils 0.2.0 → 0.2.2

package/build/lib/typedoc.js

@@ -1,122 +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.buildReference = 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;
-});
-/**
- * Converts an object of string values to an array of arguments for CLI
- */
-const argify = lodash_1.default.flow(lodash_1.default.entries, lodash_1.default.flatten, (list) => list.map((v, idx) => (idx % 2 === 0 ? `--${v}` : v)));
-/**
- * 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 = 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 buildReference({ typedocJson: typeDocJsonPath, cwd = process.cwd(), tsconfigJson: tsconfig, logLevel = constants_1.DEFAULT_LOG_LEVEL, title, } = {}) {
-    const stop = (0, util_1.stopwatch)('buildReference');
-    typeDocJsonPath = 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.buildReference = buildReference;
-//# sourceMappingURL=typedoc.js.map

package/build/lib/typedoc.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"typedoc.js","sourceRoot":"","sources":["../../lib/typedoc.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;;;;AAEH,6CAAmC;AACnC,gDAAwB;AACxB,oDAAuB;AACvB,0DAA6B;AAC7B,qCAAoF;AACpF,2CAKqB;AACrB,mCAAsC;AACtC,6BAA0D;AAC1D,sDAA8B;AAC9B,iCAA2C;AAE3C,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;;GAEG;AACH,MAAM,MAAM,GAA8C,gBAAC,CAAC,IAAI,CAAC,gBAAC,CAAC,OAAO,EAAE,gBAAC,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE,CAC9F,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CACrD,CAAC;AAEF;;;;;;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,MAAM,CAAC,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,cAAc,CAAC,EACnC,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,gBAAgB,CAAC,CAAC;IACzC,eAAe,GAAG,eAAe,IAAI,CAAC,MAAM,IAAA,wBAAmB,EAAC,GAAG,CAAC,CAAC,CAAC;IACtE,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;AA9DD,wCA8DC"}

package/build/lib/types.d.ts

@@ -1,52 +0,0 @@
-/**
- * Utility types
- * @module
- */
-import type { Jsonify, JsonValue, TsConfigJson as TsConfigJsonBase } from 'type-fest';
-import type { TypeDocOptions } from 'typedoc';
-/**
- * A `tsconfig.json` file w/ `$schema` prop
- */
-export declare type TsConfigJson = Jsonify<TsConfigJsonBase & {
-    $schema?: string;
-}>;
-/**
- * A `typedoc.json` file w/ `$schema` and `extends` props
- */
-export declare type TypeDocJson = Jsonify<Partial<TypeDocOptions> & {
-    $schema?: string;
-    extends?: string;
-}>;
-export declare type MkDocsYml = Jsonify<{
-    copyright?: string;
-    dev_addr?: string;
-    docs_dir?: string;
-    extra_css?: string[];
-    extra_javascript?: string[];
-    extra_templates?: string[];
-    extra?: Record<string, JsonValue>;
-    hooks?: string[];
-    INHERIT?: string;
-    markdown_extensions?: (string | Record<string, JsonValue>)[];
-    nav?: (string | Record<string, string>)[];
-    plugins?: (string | Record<string, JsonValue>)[];
-    repo_name?: string;
-    repo_url?: string;
-    site_dir?: string;
-    /**
-     * This is _actually_ required by mkdocs
-     */
-    site_name?: string;
-    site_description?: string;
-    strict?: boolean;
-    theme?: MkDocsYmlTheme;
-    use_directory_urls?: boolean;
-    watch?: string[];
-}>;
-export declare type MkDocsYmlTheme = string | ({
-    name: string;
-    locale?: string;
-    custom_dir?: string;
-    static_templates?: string[];
-} & Record<string, JsonValue>);
-//# sourceMappingURL=types.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../lib/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAC,OAAO,EAAE,SAAS,EAAe,YAAY,IAAI,gBAAgB,EAAC,MAAM,WAAW,CAAC;AACjG,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,SAAS,CAAC;AAE5C;;GAEG;AACH,oBAAY,YAAY,GAAG,OAAO,CAChC,gBAAgB,GAAG;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CACF,CAAC;AAEF;;GAEG;AACH,oBAAY,WAAW,GAAG,OAAO,CAC/B,OAAO,CAAC,cAAc,CAAC,GAAG;IACxB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CACF,CAAC;AAEF,oBAAY,SAAS,GAAG,OAAO,CAAC;IAC9B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC5B,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IAClC,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,mBAAmB,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC;IAC7D,GAAG,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC;IAC1C,OAAO,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC;IACjD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,cAAc,CAAC;IACvB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB,CAAC,CAAC;AAEH,oBAAY,cAAc,GACtB,MAAM,GACN,CAAC;IACC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;CAC7B,GAAG,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC"}

package/build/lib/types.js

@@ -1,7 +0,0 @@
-"use strict";
-/**
- * Utility types
- * @module
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=types.js.map

package/build/lib/types.js.map

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

package/build/lib/validation/base-validator.d.ts

@@ -1,218 +0,0 @@
-/// <reference types="node" />
-import 'type-fest';
-import { EventEmitter } from 'node:events';
-import { NAME_MKDOCS, NAME_NPM, NAME_PYTHON, NAME_TYPEDOC, NAME_TYPESCRIPT } from '../constants';
-import { DocutilsError } from '../error';
-import { PipPackage } from '../model';
-/**
- * The "kinds" of validation which were requested to be performed
- */
-export declare type ValidationKind = typeof NAME_PYTHON | typeof NAME_TYPESCRIPT | typeof NAME_TYPEDOC | typeof NAME_NPM | typeof NAME_MKDOCS;
-/**
- * This class is designed to run _all_ validation checks (as requested by the user), and emit events for
- * each failure encountered.
- *
- * Whenever a method _rejects or throws_, this is considered an "unexpected" error, and the validation
- * will abort.
- *
- * @todo Use [`strict-event-emitter-types`](https://npm.im/strict-event-emitter-types)
- */
-export declare abstract class BaseValidator extends EventEmitter {
-    protected requirementsTxt: PipPackage[] | undefined;
-    /**
-     * Current working directory. Defaults to `process.cwd()`
-     * @todo This cannot yet be overriden by user
-     */
-    protected readonly cwd: string;
-    /**
-     * Path to `npm` executable.
-     */
-    protected readonly npmPath: string | undefined;
-    /**
-     * Path to `python` executable.
-     */
-    protected readonly pythonPath: string | undefined;
-    /**
-     * List of validations to perform
-     */
-    protected readonly _validations: Set<ValidationKind>;
-    /**
-     * Mapping of error messages to errors.
-     *
-     * Used to prevent duplicate emission of errors and track error count; if non-empty, the validation
-     * process should be considered to have failed.
-     *
-     * Reset after {@linkcode BaseValidator.validate validate} completes.
-     */
-    protected emittedErrors: Map<string, DocutilsError>;
-    /**
-     * Path to `mkdocs.yml`.  If not provided, will be lazily resolved.
-     */
-    protected mkDocsYmlPath: string | undefined;
-    /**
-     * Path to `package.json`.  If not provided, will be lazily resolved.
-     */
-    protected packageJsonPath: string | undefined;
-    /**
-     * Path to the package directory.  If not provided, will be lazily resolved.
-     */
-    protected pkgDir: string | undefined;
-    /**
-     * Path to `tsconfig.json`.  If not provided, will be lazily resolved.
-     */
-    protected tsconfigJsonPath: string | undefined;
-    /**
-     * Path to `typedoc.json`.  If not provided, will be lazily resolved.
-     */
-    protected typeDocJsonPath: string | undefined;
-    /**
-     * Emitted when validation begins with a list of validation kinds to be performed
-     * @event
-     */
-    static readonly BEGIN = "begin";
-    /**
-     * Emitted when validation ends with an error count
-     * @event
-     */
-    static readonly END = "end";
-    /**
-     * Emitted when a validation fails, with the associated {@linkcode DocutilsError}
-     * @event
-     */
-    static readonly FAILURE = "fail";
-    /**
-     * Emitted when a validation succeeds
-     * @event
-     */
-    static readonly SUCCESS = "ok";
-    readonly opts: DocutilsValidatorOpts;
-    /**
-     * Creates a listener to track errors emitted
-     */
-    constructor(opts?: Partial<DocutilsValidatorOpts>);
-    get errorCount(): number;
-    /**
-     * Runs the configured validations, then resets internal state upon completion or rejection.
-     */
-    validate(): Promise<void>;
-    /**
-     * If a thing like `err` has not already been emitted, emit
-     * {@linkcode BaseValidator.FAILURE}.
-     * @param err A validation error
-     * @returns
-     */
-    protected fail(err: DocutilsError | string): void;
-    /**
-     * Resolves with a the parent directory of `package.json`, if we can find it.
-     */
-    protected findPkgDir(): Promise<string | undefined>;
-    /**
-     * Emits a {@linkcode BaseValidator.SUCCESS} event
-     * @param message Success message
-     */
-    protected ok(message: string): void;
-    /**
-     * Parses a `requirements.txt` file and returns an array of packages
-     *
-     * Caches the result.
-     * @returns List of package data w/ name and version
-     */
-    protected parseRequirementsTxt(): Promise<PipPackage[]>;
-    /**
-     * Resets the cache of emitted errors
-     */
-    protected reset(): void;
-    /**
-     * Validates (sort of) an `mkdocs.yml` config file.
-     *
-     * It checks if the file exists, if it can be parsed as YAML, and if it has a `site_name` property.
-     */
-    protected validateMkDocsConfig(mkDocsYmlPath?: string): Promise<void>;
-    /**
-     * Validates that the version of `npm` matches what's described in this package's `engines` field.
-     *
-     * This is required because other validators need `npm exec` to work, which is only available in npm 7+.
-     */
-    protected validateNpmVersion(): Promise<void>;
-    /**
-     * Asserts that the dependencies as listed in `requirements.txt` are installed.
-     *
-     * @privateRemarks This lists all installed packages with `pip` and then compares them to the
-     * contents of our `requirements.txt`. Versions _must_ match exactly.
-     */
-    protected validatePythonDeps(): Promise<void>;
-    /**
-     * Asserts that the Python version is 3.x
-     */
-    protected validatePythonVersion(): Promise<void>;
-    /**
-     * Asserts TypeDoc is installed, runnable, the correct version, and that the config file is readable
-     * and constaints required options
-     */
-    protected validateTypeDoc(): Promise<void>;
-    /**
-     * Validates the `typedoc.json` file
-     */
-    protected validateTypeDocConfig(): Promise<void>;
-    /**
-     * Asserts that TypeScript is installed, runnable, the correct version, and a parseable `tsconfig.json` exists.
-     */
-    protected validateTypeScript(): Promise<void>;
-    /**
-     * Validates a `tsconfig.json` file
-     */
-    protected validateTypeScriptConfig(): Promise<void>;
-}
-/**
- * Options for {@linkcode BaseValidator} constructor
- */
-export interface DocutilsValidatorOpts {
-    /**
-     * Current working directory
-     */
-    cwd: string;
-    /**
-     * If `true`, run MkDocs validation
-     */
-    mkdocs?: boolean;
-    /**
-     * Path to `mkdocs.yml`
-     */
-    mkdocsYml?: string;
-    /**
-     * Path to `npm` executable
-     */
-    npm?: string;
-    /**
-     * Path to `package.json`
-     */
-    packageJson?: string;
-    /**
-     * If `true`, run Python validation
-     */
-    python?: boolean;
-    /**
-     * Path to `python` executable
-     */
-    pythonPath?: string;
-    /**
-     * Path to `tsconfig.json`
-     */
-    tsconfigJson?: string;
-    /**
-     * If `true`, run TypeDoc validation
-     */
-    typedoc?: boolean;
-    /**
-     * Path to `typedoc.json`
-     */
-    typedocJson?: string;
-    /**
-     * If `true`, run TypeScript validation
-     */
-    typescript?: boolean;
-}
-export interface IDocutilsValidator {
-    validate(): Promise<void>;
-}
-//# sourceMappingURL=base-validator.d.ts.map

package/build/lib/validation/base-validator.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"base-validator.d.ts","sourceRoot":"","sources":["../../../lib/validation/base-validator.ts"],"names":[],"mappings":";AAAA,OAAO,WAAW,CAAC;AAUnB,OAAO,EAAC,YAAY,EAAC,MAAM,aAAa,CAAC;AAKzC,OAAO,EAKL,WAAW,EAEX,QAAQ,EAGR,WAAW,EAGX,YAAY,EAEZ,eAAe,EAEhB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAC,aAAa,EAAC,MAAM,UAAU,CAAC;AAYvC,OAAO,EAAY,UAAU,EAAc,MAAM,UAAU,CAAC;AAoB5D;;GAEG;AACH,oBAAY,cAAc,GACtB,OAAO,WAAW,GAClB,OAAO,eAAe,GACtB,OAAO,YAAY,GACnB,OAAO,QAAQ,GACf,OAAO,WAAW,CAAC;AAEvB;;;;;;;;GAQG;AACH,8BAAsB,aAAc,SAAQ,YAAY;IACtD,SAAS,CAAC,eAAe,EAAE,UAAU,EAAE,GAAG,SAAS,CAAC;IAEpD;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IAC/B;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/C;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;IAClD;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,YAAY,sBAA6B;IAE5D;;;;;;;OAOG;IACH,SAAS,CAAC,aAAa,6BAAoC;IAC3D;;OAEG;IACH,SAAS,CAAC,aAAa,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5C;;OAEG;IACH,SAAS,CAAC,eAAe,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9C;;OAEG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IACrC;;OAEG;IACH,SAAS,CAAC,gBAAgB,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/C;;OAEG;IACH,SAAS,CAAC,eAAe,EAAE,MAAM,GAAG,SAAS,CAAC;IAE9C;;;OAGG;IACH,gBAAuB,KAAK,WAAW;IACvC;;;OAGG;IACH,gBAAuB,GAAG,SAAS;IACnC;;;OAGG;IACH,gBAAuB,OAAO,UAAU;IACxC;;;OAGG;IACH,gBAAuB,OAAO,QAAQ;IAEtC,SAAgB,IAAI,EAAE,qBAAqB,CAAC;IAE5C;;OAEG;gBACS,IAAI,GAAE,OAAO,CAAC,qBAAqB,CAAM;IAkBrD,IAAW,UAAU,WAEpB;IAED;;OAEG;IACU,QAAQ;IAkCrB;;;;;OAKG;IACH,SAAS,CAAC,IAAI,CAAC,GAAG,EAAE,aAAa,GAAG,MAAM;IAO1C;;OAEG;cACa,UAAU,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IASzD;;;OAGG;IACH,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM;IAI5B;;;;;OAKG;cACa,oBAAoB,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;IAuB7D;;OAEG;IACH,SAAS,CAAC,KAAK;IAIf;;;;OAIG;cACa,oBAAoB,CAAC,aAAa,CAAC,EAAE,MAAM;IA2B3D;;;;OAIG;cACa,kBAAkB;IAuBlC;;;;;OAKG;cACa,kBAAkB;IA0ElC;;OAEG;cACa,qBAAqB;IAmBrC;;;OAGG;cACa,eAAe;IAgC/B;;OAEG;cACa,qBAAqB;IAgDrC;;OAEG;cACa,kBAAkB;IAwClC;;OAEG;cACa,wBAAwB;CAyBzC;AAED;;GAEG;AAEH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED,MAAM,WAAW,kBAAkB;IACjC,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CAC3B"}