@appium/docutils 0.2.1 → 0.3.0

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"}

package/build/lib/validation/base-validator.js

@@ -1,453 +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.BaseValidator = void 0;
-require("type-fest");
-/**
- * Validates an environment for building documentation
- *
- * @module
- */
-const support_1 = require("@appium/support");
-const chalk_1 = __importDefault(require("chalk"));
-const lodash_1 = __importDefault(require("lodash"));
-const node_events_1 = require("node:events");
-const node_path_1 = __importDefault(require("node:path"));
-const pluralize_1 = __importDefault(require("pluralize"));
-const semver_1 = require("semver");
-const teen_process_1 = require("teen_process");
-const constants_1 = require("../constants");
-const error_1 = require("../error");
-const fs_1 = require("../fs");
-const logger_1 = __importDefault(require("../logger"));
-const util_1 = require("../util");
-/**
- * Matches the Python version string from `python --version`
- */
-const PYTHON_VER_STR = 'Python 3.';
-/**
- * Matches the TypeScript version string from `tsc --version`
- */
-const TYPESCRIPT_VERSION_REGEX = /Version\s(\d+\.\d+\..+)/;
-/**
- * Matches the TypeDoc version string from `typedoc --version`
- */
-const TYPEDOC_VERSION_REGEX = /TypeDoc\s(\d+\.\d+\..+)/;
-const log = logger_1.default.withTag('validate');
-/**
- * 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)
- */
-class BaseValidator extends node_events_1.EventEmitter {
-    /**
-     * Creates a listener to track errors emitted
-     */
-    constructor(opts = {}) {
-        super();
-        /**
-         * List of validations to perform
-         */
-        this._validations = new Set();
-        /**
-         * 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.
-         */
-        this.emittedErrors = new Map();
-        this.opts = Object.freeze(lodash_1.default.defaultsDeep(opts, { cwd: process.cwd() }));
-        this.packageJsonPath = this.opts.packageJson;
-        this.pythonPath = this.opts.pythonPath;
-        this.cwd = this.opts.cwd;
-        this.tsconfigJsonPath = this.opts.tsconfigJson;
-        this.typeDocJsonPath = this.opts.typedocJson;
-        this.npmPath = this.opts.npm;
-        this.mkDocsYmlPath = this.opts.mkdocsYml;
-        // this just tracks the emitted errors
-        this.on(BaseValidator.FAILURE, (err) => {
-            this.emittedErrors.set(err.message, err);
-        });
-    }
-    get errorCount() {
-        return this.emittedErrors.size;
-    }
-    /**
-     * Runs the configured validations, then resets internal state upon completion or rejection.
-     */
-    async validate() {
-        try {
-            this.emit(BaseValidator.BEGIN, [...this._validations]);
-            if (this._validations.has(constants_1.NAME_PYTHON)) {
-                await this.validatePythonVersion();
-                await this.validatePythonDeps();
-            }
-            if (this._validations.has(constants_1.NAME_MKDOCS)) {
-                // await this.validateMkDocs();
-                await this.validateMkDocsConfig();
-            }
-            if (this._validations.has(constants_1.NAME_NPM)) {
-                await this.validateNpmVersion();
-            }
-            if (this._validations.has(constants_1.NAME_TYPESCRIPT)) {
-                await this.validateTypeScript();
-                await this.validateTypeScriptConfig();
-            }
-            if (this._validations.has(constants_1.NAME_TYPEDOC)) {
-                await this.validateTypeDoc();
-                await this.validateTypeDocConfig();
-            }
-            this.emit(BaseValidator.END, this.emittedErrors.size);
-        }
-        finally {
-            this.reset();
-        }
-    }
-    /**
-     * If a thing like `err` has not already been emitted, emit
-     * {@linkcode BaseValidator.FAILURE}.
-     * @param err A validation error
-     * @returns
-     */
-    fail(err) {
-        const dErr = lodash_1.default.isString(err) ? new error_1.DocutilsError(err) : err;
-        if (!this.emittedErrors.has(dErr.message)) {
-            this.emit(BaseValidator.FAILURE, dErr);
-        }
-    }
-    /**
-     * Resolves with a the parent directory of `package.json`, if we can find it.
-     */
-    async findPkgDir() {
-        return (this.pkgDir ??
-            (this.pkgDir = this.packageJsonPath
-                ? node_path_1.default.dirname(this.packageJsonPath)
-                : await (0, fs_1.findPkgDir)(this.cwd)));
-    }
-    /**
-     * Emits a {@linkcode BaseValidator.SUCCESS} event
-     * @param message Success message
-     */
-    ok(message) {
-        this.emit(BaseValidator.SUCCESS, message);
-    }
-    /**
-     * Parses a `requirements.txt` file and returns an array of packages
-     *
-     * Caches the result.
-     * @returns List of package data w/ name and version
-     */
-    async parseRequirementsTxt() {
-        if (this.requirementsTxt) {
-            return this.requirementsTxt;
-        }
-        let requiredPackages = [];
-        try {
-            let requirementsTxt = await support_1.fs.readFile(constants_1.REQUIREMENTS_TXT_PATH, 'utf8');
-            requirementsTxt = requirementsTxt.trim();
-            log.debug('Raw %s: %s', constants_1.NAME_REQUIREMENTS_TXT, requirementsTxt);
-            for (const line of requirementsTxt.split(/\r?\n/)) {
-                const [name, version] = line.trim().split('==');
-                requiredPackages.push({ name, version });
-            }
-            log.debug('Parsed %s: %O', constants_1.NAME_REQUIREMENTS_TXT, requiredPackages);
-        }
-        catch {
-            throw new error_1.DocutilsError(`Could not find ${constants_1.REQUIREMENTS_TXT_PATH}. This is a bug`);
-        }
-        return (this.requirementsTxt = requiredPackages);
-    }
-    /**
-     * Resets the cache of emitted errors
-     */
-    reset() {
-        this.emittedErrors.clear();
-    }
-    /**
-     * 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.
-     */
-    async validateMkDocsConfig(mkDocsYmlPath) {
-        mkDocsYmlPath = mkDocsYmlPath ?? this.mkDocsYmlPath ?? (await (0, fs_1.findMkDocsYml)(this.cwd));
-        if (!mkDocsYmlPath) {
-            return this.fail(`Could not find ${constants_1.NAME_MKDOCS_YML} from ${this.cwd}. Run "${constants_1.NAME_BIN} init" to create it`);
-        }
-        let mkDocsYml;
-        try {
-            mkDocsYml = await (0, fs_1.readMkDocsYml)(mkDocsYmlPath);
-        }
-        catch (e) {
-            const err = e;
-            if (err.code === constants_1.NAME_ERR_ENOENT) {
-                return this.fail(`Could not find ${constants_1.NAME_MKDOCS_YML} at ${mkDocsYmlPath}. Use --mkdocs-yml to specify a different path.`);
-            }
-            return this.fail(`Could not parse ${mkDocsYmlPath}: ${err}`);
-        }
-        if (!mkDocsYml.site_name) {
-            return this.fail(`Could not find required property "site_name" in ${mkDocsYmlPath}`);
-        }
-        this.ok(`MkDocs config at ${mkDocsYmlPath} OK`);
-    }
-    /**
-     * 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+.
-     */
-    async validateNpmVersion() {
-        const npmEngineRange = constants_1.DOCUTILS_PKG.engines?.npm;
-        if (!npmEngineRange) {
-            throw new error_1.DocutilsError('Could not find property engines.npm in package.json. This is a bug');
-        }
-        try {
-            const npmPath = this.npmPath ?? (await (0, fs_1.whichNpm)());
-            if (!npmPath) {
-                throw new error_1.DocutilsError(`Could not find ${constants_1.NAME_NPM} in PATH. That seems weird, doesn't it?`);
-            }
-            const { stdout: npmVersion } = await (0, teen_process_1.exec)(npmPath, ['-v']);
-            if (!(0, semver_1.satisfies)(npmVersion.trim(), npmEngineRange)) {
-                this.fail(`${constants_1.NAME_NPM} is version ${npmVersion}, but ${npmEngineRange} is required`);
-                return;
-            }
-        }
-        catch {
-            return this.fail(`Could not find ${this.npmPath} in PATH. Is it installed?`);
-        }
-        this.ok(`${constants_1.NAME_NPM} version OK`);
-    }
-    /**
-     * 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.
-     */
-    async validatePythonDeps() {
-        let pipListOutput;
-        const pythonPath = this.pythonPath ?? (await (0, fs_1.whichPython)());
-        if (!pythonPath) {
-            return this.fail(`Could not find ${constants_1.NAME_PYTHON} in PATH. Is it installed?`);
-        }
-        try {
-            ({ stdout: pipListOutput } = await (0, teen_process_1.exec)(pythonPath, [
-                '-m',
-                constants_1.NAME_PIP,
-                'list',
-                '--format',
-                'json',
-            ]));
-        }
-        catch {
-            return this.fail(`Could not find ${constants_1.NAME_PIP} in PATH. Is it installed?`);
-        }
-        let installedPkgs;
-        try {
-            installedPkgs = JSON.parse(pipListOutput);
-        }
-        catch {
-            throw new error_1.DocutilsError(`Could not parse output of "${constants_1.NAME_PIP} list" as JSON: ${pipListOutput}`);
-        }
-        const pkgsByName = lodash_1.default.mapValues(lodash_1.default.keyBy(installedPkgs, 'name'), 'version');
-        log.debug('Installed Python packages: %O', pkgsByName);
-        const requiredPackages = await this.parseRequirementsTxt();
-        const missingPackages = [];
-        const invalidVersionPackages = [];
-        for (const reqdPkg of requiredPackages) {
-            const version = pkgsByName[reqdPkg.name];
-            if (!version) {
-                missingPackages.push(reqdPkg);
-            }
-            if (version !== reqdPkg.version) {
-                invalidVersionPackages.push([reqdPkg, { name: reqdPkg.name, version }]);
-            }
-        }
-        const msgParts = [];
-        if (missingPackages.length) {
-            msgParts.push(`The following required ${(0, pluralize_1.default)('package', missingPackages.length)} could not be found:\n${missingPackages
-                .map((p) => (0, chalk_1.default) `- {yellow ${p.name}} @ {yellow ${p.version}}`)
-                .join('\n')}`);
-        }
-        if (invalidVersionPackages.length) {
-            msgParts.push(`The following required ${(0, pluralize_1.default)('package', invalidVersionPackages.length)} are installed, but at the wrong version:\n${invalidVersionPackages
-                .map(([expected, actual]) => (0, chalk_1.default) `- {yellow ${expected.name}} @ {yellow ${expected.version}} (found {red ${actual.version}})`)
-                .join('\n')}`);
-        }
-        if (msgParts.length) {
-            return this.fail(`Required Python dependency validation failed:\n\n${msgParts.join('\n\n')}`);
-        }
-        this.ok('Python dependencies OK');
-    }
-    /**
-     * Asserts that the Python version is 3.x
-     */
-    async validatePythonVersion() {
-        const pythonPath = this.pythonPath ?? (await (0, fs_1.whichPython)());
-        if (!pythonPath) {
-            return this.fail(`Could not find ${constants_1.NAME_PYTHON} in PATH. Is it installed?`);
-        }
-        try {
-            const { stdout } = await (0, teen_process_1.exec)(pythonPath, ['--version']);
-            if (!stdout.includes(PYTHON_VER_STR)) {
-                return this.fail(`Could not find Python 3.x in PATH; found ${stdout}.  Please use --python-path`);
-            }
-        }
-        catch {
-            return this.fail(`Could not find Python 3.x in PATH.`);
-        }
-        this.ok('Python version OK');
-    }
-    /**
-     * Asserts TypeDoc is installed, runnable, the correct version, and that the config file is readable
-     * and constaints required options
-     */
-    async validateTypeDoc() {
-        const pkgDir = await this.findPkgDir();
-        let rawTypeDocVersion;
-        let typeDocVersion;
-        try {
-            ({ stdout: rawTypeDocVersion } = await (0, teen_process_1.exec)('npm', ['exec', constants_1.NAME_TYPEDOC, '--', '--version'], {
-                cwd: pkgDir,
-            }));
-        }
-        catch {
-            return this.fail(`Could not find ${constants_1.NAME_TYPEDOC} executable from ${pkgDir}`);
-        }
-        if (rawTypeDocVersion) {
-            let match = rawTypeDocVersion.match(TYPEDOC_VERSION_REGEX);
-            if (match) {
-                typeDocVersion = match[1];
-            }
-            else {
-                throw new error_1.DocutilsError(`Could not parse TypeDoc version from "typedoc --version"; output was:\n ${rawTypeDocVersion}`);
-            }
-            const reqdTypeDocVersion = constants_1.DOCUTILS_PKG.dependencies.typedoc;
-            if (!(0, semver_1.satisfies)(typeDocVersion, reqdTypeDocVersion)) {
-                return this.fail(`Found TypeDoc version ${typeDocVersion}, but ${reqdTypeDocVersion} is required`);
-            }
-            this.ok('TypeDoc install OK');
-        }
-    }
-    /**
-     * Validates the `typedoc.json` file
-     */
-    async validateTypeDocConfig() {
-        const pkgDir = await this.findPkgDir();
-        if (!pkgDir) {
-            return this.fail(new error_1.DocutilsError(`Could not find package.json in ${this.cwd}`));
-        }
-        const typeDocJsonPath = (this.typeDocJsonPath =
-            this.typeDocJsonPath ?? node_path_1.default.join(pkgDir, constants_1.NAME_TYPEDOC_JSON));
-        const relTypeDocJsonPath = (0, util_1.relative)(this.cwd, typeDocJsonPath);
-        let typeDocJson;
-        // handle the case where the user passes a JS file as the typedoc config
-        // (which is allowed by TypeDoc)
-        if (typeDocJsonPath.endsWith('.js')) {
-            try {
-                typeDocJson = require(typeDocJsonPath);
-            }
-            catch (err) {
-                throw new error_1.DocutilsError(`TypeDoc config at ${relTypeDocJsonPath} threw an exception: ${err}`);
-            }
-        }
-        else {
-            try {
-                typeDocJson = (0, fs_1.readTypedocJson)(typeDocJsonPath);
-            }
-            catch (e) {
-                if (e instanceof SyntaxError) {
-                    return this.fail(new error_1.DocutilsError(`Unparseable ${constants_1.NAME_TYPEDOC_JSON} at ${relTypeDocJsonPath}: ${e}`));
-                }
-                return this.fail(new error_1.DocutilsError(`Missing ${constants_1.NAME_TYPEDOC_JSON} at ${relTypeDocJsonPath}; "${constants_1.NAME_BIN} init" can help`));
-            }
-        }
-        if (!typeDocJson.out) {
-            return this.fail(new error_1.DocutilsError(`Missing "out" property in ${relTypeDocJsonPath}; path "${constants_1.DEFAULT_REL_TYPEDOC_OUT_PATH} is recommended`));
-        }
-        this.ok('TypeDoc config OK');
-    }
-    /**
-     * Asserts that TypeScript is installed, runnable, the correct version, and a parseable `tsconfig.json` exists.
-     */
-    async validateTypeScript() {
-        const pkgDir = await this.findPkgDir();
-        if (!pkgDir) {
-            return this.fail(`Could not find package.json in ${this.cwd}`);
-        }
-        let typeScriptVersion;
-        let rawTypeScriptVersion;
-        try {
-            ({ stdout: rawTypeScriptVersion } = await (0, teen_process_1.exec)(constants_1.NAME_NPM, ['exec', 'tsc', '--', '--version'], {
-                cwd: pkgDir,
-            }));
-        }
-        catch {
-            return this.fail(`Could not find TypeScript compiler ("tsc") from ${pkgDir}`);
-        }
-        let match = rawTypeScriptVersion.match(TYPESCRIPT_VERSION_REGEX);
-        if (match) {
-            typeScriptVersion = match[1];
-        }
-        else {
-            return this.fail(`Could not parse TypeScript version from "tsc --version"; output was:\n ${rawTypeScriptVersion}`);
-        }
-        const reqdTypeScriptVersion = constants_1.DOCUTILS_PKG.dependencies?.typescript;
-        if (!reqdTypeScriptVersion) {
-            throw new error_1.DocutilsError(`Could not find a dep for ${constants_1.NAME_TYPESCRIPT} in ${constants_1.NAME_PACKAGE_JSON}. This is a bug.`);
-        }
-        if (!(0, semver_1.satisfies)(typeScriptVersion, reqdTypeScriptVersion)) {
-            return this.fail(`Found TypeScript version ${typeScriptVersion}, but ${reqdTypeScriptVersion} is required`);
-        }
-        this.ok('TypeScript install OK');
-    }
-    /**
-     * Validates a `tsconfig.json` file
-     */
-    async validateTypeScriptConfig() {
-        const pkgDir = await this.findPkgDir();
-        if (!pkgDir) {
-            return this.fail(new error_1.DocutilsError(`Could not find package.json in ${this.cwd}`));
-        }
-        const tsconfigJsonPath = (this.tsconfigJsonPath =
-            this.tsconfigJsonPath ?? node_path_1.default.join(pkgDir, constants_1.NAME_TSCONFIG_JSON));
-        const relTsconfigJsonPath = (0, util_1.relative)(this.cwd, tsconfigJsonPath);
-        try {
-            await (0, fs_1.readJson5)(tsconfigJsonPath);
-        }
-        catch (e) {
-            if (e instanceof SyntaxError) {
-                return this.fail(new error_1.DocutilsError(`Unparseable ${constants_1.NAME_TSCONFIG_JSON} at ${relTsconfigJsonPath}: ${e}`));
-            }
-            return this.fail(new error_1.DocutilsError(`Missing ${constants_1.NAME_TSCONFIG_JSON} at ${relTsconfigJsonPath}; "${constants_1.NAME_BIN} init" can help`));
-        }
-        this.ok('TypeScript config OK');
-    }
-}
-exports.BaseValidator = BaseValidator;
-/**
- * Emitted when validation begins with a list of validation kinds to be performed
- * @event
- */
-BaseValidator.BEGIN = 'begin';
-/**
- * Emitted when validation ends with an error count
- * @event
- */
-BaseValidator.END = 'end';
-/**
- * Emitted when a validation fails, with the associated {@linkcode DocutilsError}
- * @event
- */
-BaseValidator.FAILURE = 'fail';
-/**
- * Emitted when a validation succeeds
- * @event
- */
-BaseValidator.SUCCESS = 'ok';
-//# sourceMappingURL=base-validator.js.map