Interface LoadedConfig

A fully loaded @tapjs/config!index.TapConfig object

interface LoadedConfig {
    configFile: string;
    jack: Jack<
        { plugin: { default: string[]; description: string; hint: string } } & {
            plugin: ConfigOption<"string", true, undefined | readonly string[]>;
        } & {
            reporter: { description: string; hint: string; short: string };
            "reporter-file": { description: string; hint: string; short: string };
        } & {
            reporter: ConfigOption<"string", false, undefined | readonly string[]>;
            "reporter-file": ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
        } & {
            "reporter-arg": { description: string; hint: string; short: string };
        } & {
            "reporter-arg": ConfigOption<
                "string",
                true,
                undefined
                | readonly string[],
            >;
        } & {
            "coverage-report": {
                default: string[];
                description: string;
                hint: string;
            };
        } & {
            "coverage-report": ConfigOption<
                "string",
                true,
                undefined
                | readonly string[],
            >;
        } & {
            browser: { default: true; description: string };
            "no-browser": { description: string };
            "show-full-coverage": { description: string };
        } & {
            browser: ConfigOption<"boolean", false, undefined>;
            "no-browser": ConfigOption<"boolean", false, undefined>;
            "show-full-coverage": ConfigOption<"boolean", false, undefined>;
        } & { "coverage-map": { description: string; hint: string } } & {
            "coverage-map": ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
        } & {
            "allow-empty-coverage": { description: string };
            "allow-incomplete-coverage": { description: string };
            "disable-coverage": { description: string };
        } & {
            "allow-empty-coverage": ConfigOption<"boolean", false, undefined>;
            "allow-incomplete-coverage": ConfigOption<"boolean", false, undefined>;
            "disable-coverage": ConfigOption<"boolean", false, undefined>;
        } & {
            bail: { description: string; short: string };
            changed: { description: string; short: string };
            color: { description: string; short: string };
            comments: { description: string };
            "fail-only": { description: string };
            "fail-skip": { description: string };
            "fail-todo": { description: string };
            "no-bail": { description: string; short: string };
            "no-color": { description: string; short: string };
            passes: { description: string };
        } & {
            bail: ConfigOption<"boolean", false, undefined>;
            changed: ConfigOption<"boolean", false, undefined>;
            color: ConfigOption<"boolean", false, undefined>;
            comments: ConfigOption<"boolean", false, undefined>;
            "fail-only": ConfigOption<"boolean", false, undefined>;
            "fail-skip": ConfigOption<"boolean", false, undefined>;
            "fail-todo": ConfigOption<"boolean", false, undefined>;
            "no-bail": ConfigOption<"boolean", false, undefined>;
            "no-color": ConfigOption<"boolean", false, undefined>;
            passes: ConfigOption<"boolean", false, undefined>;
        } & { save: { description: string; hint: string; short: string } } & {
            save: ConfigOption<"string", false, undefined | readonly string[]>;
        } & { diag: { description: string }; "no-diag": { description: string } } & {
            diag: ConfigOption<"boolean", false, undefined>;
            "no-diag": ConfigOption<"boolean", false, undefined>;
        } & {
            timeout: {
                default: number;
                description: string;
                hint: string;
                short: string;
            };
        } & {
            timeout: ConfigOption<"number", false, undefined | readonly number[]>;
        } & { files: { description: string; hint: string } } & {
            files: ConfigOption<"string", true, undefined | readonly string[]>;
        } & {
            jobs: {
                default: number;
                description: string;
                hint: string;
                short: string;
            };
        } & { jobs: ConfigOption<"number", false, undefined | readonly number[]> } & {
            after: { description: string; hint: string };
            before: { description: string; hint: string };
            "output-dir": { description: string; hint: string; short: string };
            "output-file": { description: string; hint: string; short: string };
        } & {
            after: ConfigOption<"string", false, undefined | readonly string[]>;
            before: ConfigOption<"string", false, undefined | readonly string[]>;
            "output-dir": ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
            "output-file": ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
        } & {
            exclude: { default: string[]; description: string; hint: string };
            include: { default: string[]; description: string; hint: string };
            "node-arg": { default: never[]; description: string; hint: string };
            serial: { description: string; hint: string };
            "test-arg": { default: never[]; description: string; hint: string };
            "test-env": { default: never[]; description: string; hint: string };
        } & {
            exclude: ConfigOption<"string", true, undefined | readonly string[]>;
            include: ConfigOption<"string", true, undefined | readonly string[]>;
            "node-arg": ConfigOption<"string", true, undefined | readonly string[]>;
            serial: ConfigOption<"string", true, undefined | readonly string[]>;
            "test-arg": ConfigOption<"string", true, undefined | readonly string[]>;
            "test-env": ConfigOption<"string", true, undefined | readonly string[]>;
        } & {
            debug: { description: string };
            help: { description: string; short: string; type: "boolean" };
            "no-omit-whitespace": { description: string };
            "omit-version": { description: string };
            "omit-whitespace": { description: string };
            version: { description: string; short: string };
            versions: { description: string; short: string };
        } & {
            debug: ConfigOption<"boolean", false, undefined>;
            help: ConfigOption<"boolean", false, undefined>;
            "no-omit-whitespace": ConfigOption<"boolean", false, undefined>;
            "omit-version": ConfigOption<"boolean", false, undefined>;
            "omit-whitespace": ConfigOption<"boolean", false, undefined>;
            version: ConfigOption<"boolean", false, undefined>;
            versions: ConfigOption<"boolean", false, undefined>;
        } & {
            only: {
                description: string;
                nodeArgs: (v: boolean) => string[];
                short: string;
                type: string;
            } & ConfigOption<"boolean", false, undefined>;
        } & { only: ConfigOption<"boolean", false, undefined> } & {
            grep: {
                description: string;
                hint: string;
                multiple: boolean;
                nodeArgs: (value: string[]) => string[];
                short: string;
                type: string;
            } & ConfigOption<"string", true, undefined | readonly string[]>;
        } & { grep: ConfigOption<"string", true, undefined | readonly string[]> } & {
            invert: { description: string; short: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { invert: ConfigOption<"boolean", false, undefined> } & {
            "no-invert": { description: string; short: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "no-invert": ConfigOption<"boolean", false, undefined> } & {
            "filter-quietly": { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "filter-quietly": ConfigOption<"boolean", false, undefined> } & {
            "no-filter-quietly": { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "no-filter-quietly": ConfigOption<"boolean", false, undefined> } & {
            "save-fixture": { description: string; short: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "save-fixture": ConfigOption<"boolean", false, undefined> } & {
            snapshot: { description: string; short: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { snapshot: ConfigOption<"boolean", false, undefined> } & {
            "snapshot-clean-cwd": {
                default: boolean;
                description: string;
                type: string;
            } & ConfigOption<"boolean", false, undefined>;
        } & { "snapshot-clean-cwd": ConfigOption<"boolean", false, undefined> } & {
            "no-snapshot-clean-cwd": { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "no-snapshot-clean-cwd": ConfigOption<"boolean", false, undefined> } & {
            typecheck: { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { typecheck: ConfigOption<"boolean", false, undefined> } & {
            tsconfig: { description: string; type: string } & ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
        } & {
            tsconfig: ConfigOption<"string", false, undefined | readonly string[]>;
        } & {
            "type-strip-only": { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "type-strip-only": ConfigOption<"boolean", false, undefined> },
    >;
    positionals: string[];
    projectRoot: string;
    testFileExtensions: Set<string>;
    values: OptionsResults<C>;
    valuesFromConfigFile: OptionsSubset<C>;
    get pluginList(): string[];
    get pluginSignature(): string;
    addFields<F extends ConfigSet>(
        fields: F,
    ): TapConfig<
        { plugin: { default: string[]; description: string; hint: string } } & {
            plugin: ConfigOption<"string", true, undefined | readonly string[]>;
        } & {
            reporter: { description: string; hint: string; short: string };
            "reporter-file": { description: string; hint: string; short: string };
        } & {
            reporter: ConfigOption<"string", false, undefined | readonly string[]>;
            "reporter-file": ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
        } & {
            "reporter-arg": { description: string; hint: string; short: string };
        } & {
            "reporter-arg": ConfigOption<
                "string",
                true,
                undefined
                | readonly string[],
            >;
        } & {
            "coverage-report": {
                default: string[];
                description: string;
                hint: string;
            };
        } & {
            "coverage-report": ConfigOption<
                "string",
                true,
                undefined
                | readonly string[],
            >;
        } & {
            browser: { default: true; description: string };
            "no-browser": { description: string };
            "show-full-coverage": { description: string };
        } & {
            browser: ConfigOption<"boolean", false, undefined>;
            "no-browser": ConfigOption<"boolean", false, undefined>;
            "show-full-coverage": ConfigOption<"boolean", false, undefined>;
        } & { "coverage-map": { description: string; hint: string } } & {
            "coverage-map": ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
        } & {
            "allow-empty-coverage": { description: string };
            "allow-incomplete-coverage": { description: string };
            "disable-coverage": { description: string };
        } & {
            "allow-empty-coverage": ConfigOption<"boolean", false, undefined>;
            "allow-incomplete-coverage": ConfigOption<"boolean", false, undefined>;
            "disable-coverage": ConfigOption<"boolean", false, undefined>;
        } & {
            bail: { description: string; short: string };
            changed: { description: string; short: string };
            color: { description: string; short: string };
            comments: { description: string };
            "fail-only": { description: string };
            "fail-skip": { description: string };
            "fail-todo": { description: string };
            "no-bail": { description: string; short: string };
            "no-color": { description: string; short: string };
            passes: { description: string };
        } & {
            bail: ConfigOption<"boolean", false, undefined>;
            changed: ConfigOption<"boolean", false, undefined>;
            color: ConfigOption<"boolean", false, undefined>;
            comments: ConfigOption<"boolean", false, undefined>;
            "fail-only": ConfigOption<"boolean", false, undefined>;
            "fail-skip": ConfigOption<"boolean", false, undefined>;
            "fail-todo": ConfigOption<"boolean", false, undefined>;
            "no-bail": ConfigOption<"boolean", false, undefined>;
            "no-color": ConfigOption<"boolean", false, undefined>;
            passes: ConfigOption<"boolean", false, undefined>;
        } & { save: { description: string; hint: string; short: string } } & {
            save: ConfigOption<"string", false, undefined | readonly string[]>;
        } & { diag: { description: string }; "no-diag": { description: string } } & {
            diag: ConfigOption<"boolean", false, undefined>;
            "no-diag": ConfigOption<"boolean", false, undefined>;
        } & {
            timeout: {
                default: number;
                description: string;
                hint: string;
                short: string;
            };
        } & {
            timeout: ConfigOption<"number", false, undefined | readonly number[]>;
        } & { files: { description: string; hint: string } } & {
            files: ConfigOption<"string", true, undefined | readonly string[]>;
        } & {
            jobs: {
                default: number;
                description: string;
                hint: string;
                short: string;
            };
        } & { jobs: ConfigOption<"number", false, undefined | readonly number[]> } & {
            after: { description: string; hint: string };
            before: { description: string; hint: string };
            "output-dir": { description: string; hint: string; short: string };
            "output-file": { description: string; hint: string; short: string };
        } & {
            after: ConfigOption<"string", false, undefined | readonly string[]>;
            before: ConfigOption<"string", false, undefined | readonly string[]>;
            "output-dir": ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
            "output-file": ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
        } & {
            exclude: { default: string[]; description: string; hint: string };
            include: { default: string[]; description: string; hint: string };
            "node-arg": { default: never[]; description: string; hint: string };
            serial: { description: string; hint: string };
            "test-arg": { default: never[]; description: string; hint: string };
            "test-env": { default: never[]; description: string; hint: string };
        } & {
            exclude: ConfigOption<"string", true, undefined | readonly string[]>;
            include: ConfigOption<"string", true, undefined | readonly string[]>;
            "node-arg": ConfigOption<"string", true, undefined | readonly string[]>;
            serial: ConfigOption<"string", true, undefined | readonly string[]>;
            "test-arg": ConfigOption<"string", true, undefined | readonly string[]>;
            "test-env": ConfigOption<"string", true, undefined | readonly string[]>;
        } & {
            debug: { description: string };
            help: { description: string; short: string; type: "boolean" };
            "no-omit-whitespace": { description: string };
            "omit-version": { description: string };
            "omit-whitespace": { description: string };
            version: { description: string; short: string };
            versions: { description: string; short: string };
        } & {
            debug: ConfigOption<"boolean", false, undefined>;
            help: ConfigOption<"boolean", false, undefined>;
            "no-omit-whitespace": ConfigOption<"boolean", false, undefined>;
            "omit-version": ConfigOption<"boolean", false, undefined>;
            "omit-whitespace": ConfigOption<"boolean", false, undefined>;
            version: ConfigOption<"boolean", false, undefined>;
            versions: ConfigOption<"boolean", false, undefined>;
        } & {
            only: {
                description: string;
                nodeArgs: (v: boolean) => string[];
                short: string;
                type: string;
            } & ConfigOption<"boolean", false, undefined>;
        } & { only: ConfigOption<"boolean", false, undefined> } & {
            grep: {
                description: string;
                hint: string;
                multiple: boolean;
                nodeArgs: (value: string[]) => string[];
                short: string;
                type: string;
            } & ConfigOption<"string", true, undefined | readonly string[]>;
        } & { grep: ConfigOption<"string", true, undefined | readonly string[]> } & {
            invert: { description: string; short: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { invert: ConfigOption<"boolean", false, undefined> } & {
            "no-invert": { description: string; short: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "no-invert": ConfigOption<"boolean", false, undefined> } & {
            "filter-quietly": { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "filter-quietly": ConfigOption<"boolean", false, undefined> } & {
            "no-filter-quietly": { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "no-filter-quietly": ConfigOption<"boolean", false, undefined> } & {
            "save-fixture": { description: string; short: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "save-fixture": ConfigOption<"boolean", false, undefined> } & {
            snapshot: { description: string; short: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { snapshot: ConfigOption<"boolean", false, undefined> } & {
            "snapshot-clean-cwd": {
                default: boolean;
                description: string;
                type: string;
            } & ConfigOption<"boolean", false, undefined>;
        } & { "snapshot-clean-cwd": ConfigOption<"boolean", false, undefined> } & {
            "no-snapshot-clean-cwd": { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "no-snapshot-clean-cwd": ConfigOption<"boolean", false, undefined> } & {
            typecheck: { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { typecheck: ConfigOption<"boolean", false, undefined> } & {
            tsconfig: { description: string; type: string } & ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
        } & {
            tsconfig: ConfigOption<"string", false, undefined | readonly string[]>;
        } & {
            "type-strip-only": { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "type-strip-only": ConfigOption<"boolean", false, undefined> } & F,
    >;
    editConfigFile(
        data: OptionsSubset<C>,
        configFile?: undefined | string,
        overwrite?: boolean,
    ): Promise<void>;
    editPackageJsonConfig(
        data: OptionsSubset<C>,
        configFile: string,
        overwrite?: boolean,
    ): Promise<void>;
    editYAMLConfig(
        data: OptionsSubset<C>,
        configFile: string,
        overwrite?: boolean,
    ): Promise<void>;
    expandInclude(inc: string): string;
    extendConfigData(data: Record<string, any>, file: string): Promise<void>;
    get<
        K extends
            | "plugin"
            | "reporter"
            | "reporter-file"
            | "reporter-arg"
            | "coverage-report"
            | "browser"
            | "no-browser"
            | "show-full-coverage"
            | "coverage-map"
            | "allow-empty-coverage"
            | "allow-incomplete-coverage"
            | "disable-coverage"
            | "bail"
            | "no-bail"
            | "comments"
            | "passes"
            | "fail-todo"
            | "fail-skip"
            | "fail-only"
            | "color"
            | "no-color"
            | "changed"
            | "save"
            | "diag"
            | "no-diag"
            | "timeout"
            | "files"
            | "jobs"
            | "before"
            | "after"
            | "output-file"
            | "output-dir"
            | "include"
            | "exclude"
            | "serial"
            | "test-arg"
            | "test-env"
            | "node-arg"
            | "debug"
            | "omit-version"
            | "omit-whitespace"
            | "no-omit-whitespace"
            | "versions"
            | "version"
            | "help"
            | "only"
            | "grep"
            | "invert"
            | "no-invert"
            | "filter-quietly"
            | "no-filter-quietly"
            | "save-fixture"
            | "snapshot"
            | "snapshot-clean-cwd"
            | "no-snapshot-clean-cwd"
            | "typecheck"
            | "tsconfig"
            | "type-strip-only",
    >(
        k: K,
    ): OptionsResults<
        { plugin: { default: string[]; description: string; hint: string } } & {
            plugin: ConfigOption<"string", true, undefined | readonly string[]>;
        } & {
            reporter: { description: string; hint: string; short: string };
            "reporter-file": { description: string; hint: string; short: string };
        } & {
            reporter: ConfigOption<"string", false, undefined | readonly string[]>;
            "reporter-file": ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
        } & {
            "reporter-arg": { description: string; hint: string; short: string };
        } & {
            "reporter-arg": ConfigOption<
                "string",
                true,
                undefined
                | readonly string[],
            >;
        } & {
            "coverage-report": {
                default: string[];
                description: string;
                hint: string;
            };
        } & {
            "coverage-report": ConfigOption<
                "string",
                true,
                undefined
                | readonly string[],
            >;
        } & {
            browser: { default: true; description: string };
            "no-browser": { description: string };
            "show-full-coverage": { description: string };
        } & {
            browser: ConfigOption<"boolean", false, undefined>;
            "no-browser": ConfigOption<"boolean", false, undefined>;
            "show-full-coverage": ConfigOption<"boolean", false, undefined>;
        } & { "coverage-map": { description: string; hint: string } } & {
            "coverage-map": ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
        } & {
            "allow-empty-coverage": { description: string };
            "allow-incomplete-coverage": { description: string };
            "disable-coverage": { description: string };
        } & {
            "allow-empty-coverage": ConfigOption<"boolean", false, undefined>;
            "allow-incomplete-coverage": ConfigOption<"boolean", false, undefined>;
            "disable-coverage": ConfigOption<"boolean", false, undefined>;
        } & {
            bail: { description: string; short: string };
            changed: { description: string; short: string };
            color: { description: string; short: string };
            comments: { description: string };
            "fail-only": { description: string };
            "fail-skip": { description: string };
            "fail-todo": { description: string };
            "no-bail": { description: string; short: string };
            "no-color": { description: string; short: string };
            passes: { description: string };
        } & {
            bail: ConfigOption<"boolean", false, undefined>;
            changed: ConfigOption<"boolean", false, undefined>;
            color: ConfigOption<"boolean", false, undefined>;
            comments: ConfigOption<"boolean", false, undefined>;
            "fail-only": ConfigOption<"boolean", false, undefined>;
            "fail-skip": ConfigOption<"boolean", false, undefined>;
            "fail-todo": ConfigOption<"boolean", false, undefined>;
            "no-bail": ConfigOption<"boolean", false, undefined>;
            "no-color": ConfigOption<"boolean", false, undefined>;
            passes: ConfigOption<"boolean", false, undefined>;
        } & { save: { description: string; hint: string; short: string } } & {
            save: ConfigOption<"string", false, undefined | readonly string[]>;
        } & { diag: { description: string }; "no-diag": { description: string } } & {
            diag: ConfigOption<"boolean", false, undefined>;
            "no-diag": ConfigOption<"boolean", false, undefined>;
        } & {
            timeout: {
                default: number;
                description: string;
                hint: string;
                short: string;
            };
        } & {
            timeout: ConfigOption<"number", false, undefined | readonly number[]>;
        } & { files: { description: string; hint: string } } & {
            files: ConfigOption<"string", true, undefined | readonly string[]>;
        } & {
            jobs: {
                default: number;
                description: string;
                hint: string;
                short: string;
            };
        } & { jobs: ConfigOption<"number", false, undefined | readonly number[]> } & {
            after: { description: string; hint: string };
            before: { description: string; hint: string };
            "output-dir": { description: string; hint: string; short: string };
            "output-file": { description: string; hint: string; short: string };
        } & {
            after: ConfigOption<"string", false, undefined | readonly string[]>;
            before: ConfigOption<"string", false, undefined | readonly string[]>;
            "output-dir": ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
            "output-file": ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
        } & {
            exclude: { default: string[]; description: string; hint: string };
            include: { default: string[]; description: string; hint: string };
            "node-arg": { default: never[]; description: string; hint: string };
            serial: { description: string; hint: string };
            "test-arg": { default: never[]; description: string; hint: string };
            "test-env": { default: never[]; description: string; hint: string };
        } & {
            exclude: ConfigOption<"string", true, undefined | readonly string[]>;
            include: ConfigOption<"string", true, undefined | readonly string[]>;
            "node-arg": ConfigOption<"string", true, undefined | readonly string[]>;
            serial: ConfigOption<"string", true, undefined | readonly string[]>;
            "test-arg": ConfigOption<"string", true, undefined | readonly string[]>;
            "test-env": ConfigOption<"string", true, undefined | readonly string[]>;
        } & {
            debug: { description: string };
            help: { description: string; short: string; type: "boolean" };
            "no-omit-whitespace": { description: string };
            "omit-version": { description: string };
            "omit-whitespace": { description: string };
            version: { description: string; short: string };
            versions: { description: string; short: string };
        } & {
            debug: ConfigOption<"boolean", false, undefined>;
            help: ConfigOption<"boolean", false, undefined>;
            "no-omit-whitespace": ConfigOption<"boolean", false, undefined>;
            "omit-version": ConfigOption<"boolean", false, undefined>;
            "omit-whitespace": ConfigOption<"boolean", false, undefined>;
            version: ConfigOption<"boolean", false, undefined>;
            versions: ConfigOption<"boolean", false, undefined>;
        } & {
            only: {
                description: string;
                nodeArgs: (v: boolean) => string[];
                short: string;
                type: string;
            } & ConfigOption<"boolean", false, undefined>;
        } & { only: ConfigOption<"boolean", false, undefined> } & {
            grep: {
                description: string;
                hint: string;
                multiple: boolean;
                nodeArgs: (value: string[]) => string[];
                short: string;
                type: string;
            } & ConfigOption<"string", true, undefined | readonly string[]>;
        } & { grep: ConfigOption<"string", true, undefined | readonly string[]> } & {
            invert: { description: string; short: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { invert: ConfigOption<"boolean", false, undefined> } & {
            "no-invert": { description: string; short: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "no-invert": ConfigOption<"boolean", false, undefined> } & {
            "filter-quietly": { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "filter-quietly": ConfigOption<"boolean", false, undefined> } & {
            "no-filter-quietly": { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "no-filter-quietly": ConfigOption<"boolean", false, undefined> } & {
            "save-fixture": { description: string; short: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "save-fixture": ConfigOption<"boolean", false, undefined> } & {
            snapshot: { description: string; short: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { snapshot: ConfigOption<"boolean", false, undefined> } & {
            "snapshot-clean-cwd": {
                default: boolean;
                description: string;
                type: string;
            } & ConfigOption<"boolean", false, undefined>;
        } & { "snapshot-clean-cwd": ConfigOption<"boolean", false, undefined> } & {
            "no-snapshot-clean-cwd": { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "no-snapshot-clean-cwd": ConfigOption<"boolean", false, undefined> } & {
            typecheck: { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { typecheck: ConfigOption<"boolean", false, undefined> } & {
            tsconfig: { description: string; type: string } & ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
        } & {
            tsconfig: ConfigOption<"string", false, undefined | readonly string[]>;
        } & {
            "type-strip-only": { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "type-strip-only": ConfigOption<"boolean", false, undefined> },
    >[K];
    loadColor(): Promise<LoadedConfig>;
    loadConfigData(
        data: any,
        configFile: string,
    ): Promise<
        LoadedConfig & {
            configFile: string;
            valuesFromConfigFile: OptionsResults<C>;
        },
    >;
    loadConfigFile(): Promise<
        LoadedConfig & {
            configFile: string;
            valuesFromConfigFile: OptionsSubset<C>;
        },
    >;
    loadPluginConfigFields(): TapConfig<
        { plugin: { default: string[]; description: string; hint: string } } & {
            plugin: ConfigOption<"string", true, undefined | readonly string[]>;
        } & {
            reporter: { description: string; hint: string; short: string };
            "reporter-file": { description: string; hint: string; short: string };
        } & {
            reporter: ConfigOption<"string", false, undefined | readonly string[]>;
            "reporter-file": ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
        } & {
            "reporter-arg": { description: string; hint: string; short: string };
        } & {
            "reporter-arg": ConfigOption<
                "string",
                true,
                undefined
                | readonly string[],
            >;
        } & {
            "coverage-report": {
                default: string[];
                description: string;
                hint: string;
            };
        } & {
            "coverage-report": ConfigOption<
                "string",
                true,
                undefined
                | readonly string[],
            >;
        } & {
            browser: { default: true; description: string };
            "no-browser": { description: string };
            "show-full-coverage": { description: string };
        } & {
            browser: ConfigOption<"boolean", false, undefined>;
            "no-browser": ConfigOption<"boolean", false, undefined>;
            "show-full-coverage": ConfigOption<"boolean", false, undefined>;
        } & { "coverage-map": { description: string; hint: string } } & {
            "coverage-map": ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
        } & {
            "allow-empty-coverage": { description: string };
            "allow-incomplete-coverage": { description: string };
            "disable-coverage": { description: string };
        } & {
            "allow-empty-coverage": ConfigOption<"boolean", false, undefined>;
            "allow-incomplete-coverage": ConfigOption<"boolean", false, undefined>;
            "disable-coverage": ConfigOption<"boolean", false, undefined>;
        } & {
            bail: { description: string; short: string };
            changed: { description: string; short: string };
            color: { description: string; short: string };
            comments: { description: string };
            "fail-only": { description: string };
            "fail-skip": { description: string };
            "fail-todo": { description: string };
            "no-bail": { description: string; short: string };
            "no-color": { description: string; short: string };
            passes: { description: string };
        } & {
            bail: ConfigOption<"boolean", false, undefined>;
            changed: ConfigOption<"boolean", false, undefined>;
            color: ConfigOption<"boolean", false, undefined>;
            comments: ConfigOption<"boolean", false, undefined>;
            "fail-only": ConfigOption<"boolean", false, undefined>;
            "fail-skip": ConfigOption<"boolean", false, undefined>;
            "fail-todo": ConfigOption<"boolean", false, undefined>;
            "no-bail": ConfigOption<"boolean", false, undefined>;
            "no-color": ConfigOption<"boolean", false, undefined>;
            passes: ConfigOption<"boolean", false, undefined>;
        } & { save: { description: string; hint: string; short: string } } & {
            save: ConfigOption<"string", false, undefined | readonly string[]>;
        } & { diag: { description: string }; "no-diag": { description: string } } & {
            diag: ConfigOption<"boolean", false, undefined>;
            "no-diag": ConfigOption<"boolean", false, undefined>;
        } & {
            timeout: {
                default: number;
                description: string;
                hint: string;
                short: string;
            };
        } & {
            timeout: ConfigOption<"number", false, undefined | readonly number[]>;
        } & { files: { description: string; hint: string } } & {
            files: ConfigOption<"string", true, undefined | readonly string[]>;
        } & {
            jobs: {
                default: number;
                description: string;
                hint: string;
                short: string;
            };
        } & { jobs: ConfigOption<"number", false, undefined | readonly number[]> } & {
            after: { description: string; hint: string };
            before: { description: string; hint: string };
            "output-dir": { description: string; hint: string; short: string };
            "output-file": { description: string; hint: string; short: string };
        } & {
            after: ConfigOption<"string", false, undefined | readonly string[]>;
            before: ConfigOption<"string", false, undefined | readonly string[]>;
            "output-dir": ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
            "output-file": ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
        } & {
            exclude: { default: string[]; description: string; hint: string };
            include: { default: string[]; description: string; hint: string };
            "node-arg": { default: never[]; description: string; hint: string };
            serial: { description: string; hint: string };
            "test-arg": { default: never[]; description: string; hint: string };
            "test-env": { default: never[]; description: string; hint: string };
        } & {
            exclude: ConfigOption<"string", true, undefined | readonly string[]>;
            include: ConfigOption<"string", true, undefined | readonly string[]>;
            "node-arg": ConfigOption<"string", true, undefined | readonly string[]>;
            serial: ConfigOption<"string", true, undefined | readonly string[]>;
            "test-arg": ConfigOption<"string", true, undefined | readonly string[]>;
            "test-env": ConfigOption<"string", true, undefined | readonly string[]>;
        } & {
            debug: { description: string };
            help: { description: string; short: string; type: "boolean" };
            "no-omit-whitespace": { description: string };
            "omit-version": { description: string };
            "omit-whitespace": { description: string };
            version: { description: string; short: string };
            versions: { description: string; short: string };
        } & {
            debug: ConfigOption<"boolean", false, undefined>;
            help: ConfigOption<"boolean", false, undefined>;
            "no-omit-whitespace": ConfigOption<"boolean", false, undefined>;
            "omit-version": ConfigOption<"boolean", false, undefined>;
            "omit-whitespace": ConfigOption<"boolean", false, undefined>;
            version: ConfigOption<"boolean", false, undefined>;
            versions: ConfigOption<"boolean", false, undefined>;
        } & {
            only: {
                description: string;
                nodeArgs: (v: boolean) => string[];
                short: string;
                type: string;
            } & ConfigOption<"boolean", false, undefined>;
        } & { only: ConfigOption<"boolean", false, undefined> } & {
            grep: {
                description: string;
                hint: string;
                multiple: boolean;
                nodeArgs: (value: string[]) => string[];
                short: string;
                type: string;
            } & ConfigOption<"string", true, undefined | readonly string[]>;
        } & { grep: ConfigOption<"string", true, undefined | readonly string[]> } & {
            invert: { description: string; short: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { invert: ConfigOption<"boolean", false, undefined> } & {
            "no-invert": { description: string; short: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "no-invert": ConfigOption<"boolean", false, undefined> } & {
            "filter-quietly": { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "filter-quietly": ConfigOption<"boolean", false, undefined> } & {
            "no-filter-quietly": { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "no-filter-quietly": ConfigOption<"boolean", false, undefined> } & {
            "save-fixture": { description: string; short: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "save-fixture": ConfigOption<"boolean", false, undefined> } & {
            snapshot: { description: string; short: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { snapshot: ConfigOption<"boolean", false, undefined> } & {
            "snapshot-clean-cwd": {
                default: boolean;
                description: string;
                type: string;
            } & ConfigOption<"boolean", false, undefined>;
        } & { "snapshot-clean-cwd": ConfigOption<"boolean", false, undefined> } & {
            "no-snapshot-clean-cwd": { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "no-snapshot-clean-cwd": ConfigOption<"boolean", false, undefined> } & {
            typecheck: { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { typecheck: ConfigOption<"boolean", false, undefined> } & {
            tsconfig: { description: string; type: string } & ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
        } & {
            tsconfig: ConfigOption<"string", false, undefined | readonly string[]>;
        } & {
            "type-strip-only": { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "type-strip-only": ConfigOption<"boolean", false, undefined> },
    >;
    loadReporter(): LoadedConfig;
    parse(
        args?: string[],
    ): LoadedConfig & { positionals: string[]; values: OptionsResults<C> };
    readDepConfig(
        file: string,
    ): Promise<
        | undefined
        | OptionsSubset<
            { plugin: { default: string[]; description: string; hint: string } } & {
                plugin: ConfigOption<"string", true, undefined | readonly string[]>;
            } & {
                reporter: { description: string; hint: string; short: string };
                "reporter-file": { description: string; hint: string; short: string };
            } & {
                reporter: ConfigOption<
                    "string",
                    false,
                    undefined
                    | readonly string[],
                >;
                "reporter-file": ConfigOption<
                    "string",
                    false,
                    undefined
                    | readonly string[],
                >;
            } & {
                "reporter-arg": { description: string; hint: string; short: string };
            } & {
                "reporter-arg": ConfigOption<
                    "string",
                    true,
                    undefined
                    | readonly string[],
                >;
            } & {
                "coverage-report": {
                    default: string[];
                    description: string;
                    hint: string;
                };
            } & {
                "coverage-report": ConfigOption<
                    "string",
                    true,
                    undefined
                    | readonly string[],
                >;
            } & {
                browser: { default: true; description: string };
                "no-browser": { description: string };
                "show-full-coverage": { description: string };
            } & {
                browser: ConfigOption<"boolean", false, undefined>;
                "no-browser": ConfigOption<"boolean", false, undefined>;
                "show-full-coverage": ConfigOption<"boolean", false, undefined>;
            } & { "coverage-map": { description: string; hint: string } } & {
                "coverage-map": ConfigOption<
                    "string",
                    false,
                    undefined
                    | readonly string[],
                >;
            } & {
                "allow-empty-coverage": { description: string };
                "allow-incomplete-coverage": { description: string };
                "disable-coverage": { description: string };
            } & {
                "allow-empty-coverage": ConfigOption<"boolean", false, undefined>;
                "allow-incomplete-coverage": ConfigOption<"boolean", false, undefined>;
                "disable-coverage": ConfigOption<"boolean", false, undefined>;
            } & {
                bail: { description: string; short: string };
                changed: { description: string; short: string };
                color: { description: string; short: string };
                comments: { description: string };
                "fail-only": { description: string };
                "fail-skip": { description: string };
                "fail-todo": { description: string };
                "no-bail": { description: string; short: string };
                "no-color": { description: string; short: string };
                passes: { description: string };
            } & {
                bail: ConfigOption<"boolean", false, undefined>;
                changed: ConfigOption<"boolean", false, undefined>;
                color: ConfigOption<"boolean", false, undefined>;
                comments: ConfigOption<"boolean", false, undefined>;
                "fail-only": ConfigOption<"boolean", false, undefined>;
                "fail-skip": ConfigOption<"boolean", false, undefined>;
                "fail-todo": ConfigOption<"boolean", false, undefined>;
                "no-bail": ConfigOption<"boolean", false, undefined>;
                "no-color": ConfigOption<"boolean", false, undefined>;
                passes: ConfigOption<"boolean", false, undefined>;
            } & { save: { description: string; hint: string; short: string } } & {
                save: ConfigOption<"string", false, undefined | readonly string[]>;
            } & { diag: { description: string }; "no-diag": { description: string } } & {
                diag: ConfigOption<"boolean", false, undefined>;
                "no-diag": ConfigOption<"boolean", false, undefined>;
            } & {
                timeout: {
                    default: number;
                    description: string;
                    hint: string;
                    short: string;
                };
            } & {
                timeout: ConfigOption<"number", false, undefined | readonly number[]>;
            } & { files: { description: string; hint: string } } & {
                files: ConfigOption<"string", true, undefined | readonly string[]>;
            } & {
                jobs: {
                    default: number;
                    description: string;
                    hint: string;
                    short: string;
                };
            } & {
                jobs: ConfigOption<"number", false, undefined | readonly number[]>;
            } & {
                after: { description: string; hint: string };
                before: { description: string; hint: string };
                "output-dir": { description: string; hint: string; short: string };
                "output-file": { description: string; hint: string; short: string };
            } & {
                after: ConfigOption<"string", false, undefined | readonly string[]>;
                before: ConfigOption<"string", false, undefined | readonly string[]>;
                "output-dir": ConfigOption<
                    "string",
                    false,
                    undefined
                    | readonly string[],
                >;
                "output-file": ConfigOption<
                    "string",
                    false,
                    undefined
                    | readonly string[],
                >;
            } & {
                exclude: { default: string[]; description: string; hint: string };
                include: { default: string[]; description: string; hint: string };
                "node-arg": { default: never[]; description: string; hint: string };
                serial: { description: string; hint: string };
                "test-arg": { default: never[]; description: string; hint: string };
                "test-env": { default: never[]; description: string; hint: string };
            } & {
                exclude: ConfigOption<"string", true, undefined | readonly string[]>;
                include: ConfigOption<"string", true, undefined | readonly string[]>;
                "node-arg": ConfigOption<"string", true, undefined | readonly string[]>;
                serial: ConfigOption<"string", true, undefined | readonly string[]>;
                "test-arg": ConfigOption<"string", true, undefined | readonly string[]>;
                "test-env": ConfigOption<"string", true, undefined | readonly string[]>;
            } & {
                debug: { description: string };
                help: { description: string; short: string; type: "boolean" };
                "no-omit-whitespace": { description: string };
                "omit-version": { description: string };
                "omit-whitespace": { description: string };
                version: { description: string; short: string };
                versions: { description: string; short: string };
            } & {
                debug: ConfigOption<"boolean", false, undefined>;
                help: ConfigOption<"boolean", false, undefined>;
                "no-omit-whitespace": ConfigOption<"boolean", false, undefined>;
                "omit-version": ConfigOption<"boolean", false, undefined>;
                "omit-whitespace": ConfigOption<"boolean", false, undefined>;
                version: ConfigOption<"boolean", false, undefined>;
                versions: ConfigOption<"boolean", false, undefined>;
            } & {
                only: {
                    description: string;
                    nodeArgs: (v: boolean) => string[];
                    short: string;
                    type: string;
                } & ConfigOption<"boolean", false, undefined>;
            } & { only: ConfigOption<"boolean", false, undefined> } & {
                grep: {
                    description: string;
                    hint: string;
                    multiple: boolean;
                    nodeArgs: (value: string[]) => string[];
                    short: string;
                    type: string;
                } & ConfigOption<"string", true, undefined | readonly string[]>;
            } & { grep: ConfigOption<"string", true, undefined | readonly string[]> } & {
                invert: { description: string; short: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { invert: ConfigOption<"boolean", false, undefined> } & {
                "no-invert": { description: string; short: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { "no-invert": ConfigOption<"boolean", false, undefined> } & {
                "filter-quietly": { description: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { "filter-quietly": ConfigOption<"boolean", false, undefined> } & {
                "no-filter-quietly": { description: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { "no-filter-quietly": ConfigOption<"boolean", false, undefined> } & {
                "save-fixture": { description: string; short: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { "save-fixture": ConfigOption<"boolean", false, undefined> } & {
                snapshot: { description: string; short: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { snapshot: ConfigOption<"boolean", false, undefined> } & {
                "snapshot-clean-cwd": {
                    default: boolean;
                    description: string;
                    type: string;
                } & ConfigOption<"boolean", false, undefined>;
            } & { "snapshot-clean-cwd": ConfigOption<"boolean", false, undefined> } & {
                "no-snapshot-clean-cwd": { description: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & {
                "no-snapshot-clean-cwd": ConfigOption<"boolean", false, undefined>;
            } & {
                typecheck: { description: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { typecheck: ConfigOption<"boolean", false, undefined> } & {
                tsconfig: { description: string; type: string } & ConfigOption<
                    "string",
                    false,
                    undefined
                    | readonly string[],
                >;
            } & {
                tsconfig: ConfigOption<
                    "string",
                    false,
                    undefined
                    | readonly string[],
                >;
            } & {
                "type-strip-only": { description: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { "type-strip-only": ConfigOption<"boolean", false, undefined> },
        >,
    >;
    readPackageJson(
        pj: string,
        silent?: boolean,
    ): Promise<
        | undefined
        | {
            tap?: OptionsResults<
                { plugin: { default: string[]; description: string; hint: string } } & {
                    plugin: ConfigOption<"string", true, undefined | readonly string[]>;
                } & {
                    reporter: { description: string; hint: string; short: string };
                    "reporter-file": { description: string; hint: string; short: string };
                } & {
                    reporter: ConfigOption<
                        "string",
                        false,
                        undefined
                        | readonly string[],
                    >;
                    "reporter-file": ConfigOption<
                        "string",
                        false,
                        undefined
                        | readonly string[],
                    >;
                } & {
                    "reporter-arg": { description: string; hint: string; short: string };
                } & {
                    "reporter-arg": ConfigOption<
                        "string",
                        true,
                        undefined
                        | readonly string[],
                    >;
                } & {
                    "coverage-report": {
                        default: string[];
                        description: string;
                        hint: string;
                    };
                } & {
                    "coverage-report": ConfigOption<
                        "string",
                        true,
                        undefined
                        | readonly string[],
                    >;
                } & {
                    browser: { default: true; description: string };
                    "no-browser": { description: string };
                    "show-full-coverage": { description: string };
                } & {
                    browser: ConfigOption<"boolean", false, undefined>;
                    "no-browser": ConfigOption<"boolean", false, undefined>;
                    "show-full-coverage": ConfigOption<"boolean", false, undefined>;
                } & { "coverage-map": { description: string; hint: string } } & {
                    "coverage-map": ConfigOption<
                        "string",
                        false,
                        undefined
                        | readonly string[],
                    >;
                } & {
                    "allow-empty-coverage": { description: string };
                    "allow-incomplete-coverage": { description: string };
                    "disable-coverage": { description: string };
                } & {
                    "allow-empty-coverage": ConfigOption<"boolean", false, undefined>;
                    "allow-incomplete-coverage": ConfigOption<"boolean", false, undefined>;
                    "disable-coverage": ConfigOption<"boolean", false, undefined>;
                } & {
                    bail: { description: string; short: string };
                    changed: { description: string; short: string };
                    color: { description: string; short: string };
                    comments: { description: string };
                    "fail-only": { description: string };
                    "fail-skip": { description: string };
                    "fail-todo": { description: string };
                    "no-bail": { description: string; short: string };
                    "no-color": { description: string; short: string };
                    passes: { description: string };
                } & {
                    bail: ConfigOption<"boolean", false, undefined>;
                    changed: ConfigOption<"boolean", false, undefined>;
                    color: ConfigOption<"boolean", false, undefined>;
                    comments: ConfigOption<"boolean", false, undefined>;
                    "fail-only": ConfigOption<"boolean", false, undefined>;
                    "fail-skip": ConfigOption<"boolean", false, undefined>;
                    "fail-todo": ConfigOption<"boolean", false, undefined>;
                    "no-bail": ConfigOption<"boolean", false, undefined>;
                    "no-color": ConfigOption<"boolean", false, undefined>;
                    passes: ConfigOption<"boolean", false, undefined>;
                } & { save: { description: string; hint: string; short: string } } & {
                    save: ConfigOption<"string", false, undefined | readonly string[]>;
                } & {
                    diag: { description: string };
                    "no-diag": { description: string };
                } & {
                    diag: ConfigOption<"boolean", false, undefined>;
                    "no-diag": ConfigOption<"boolean", false, undefined>;
                } & {
                    timeout: {
                        default: number;
                        description: string;
                        hint: string;
                        short: string;
                    };
                } & {
                    timeout: ConfigOption<
                        "number",
                        false,
                        undefined
                        | readonly number[],
                    >;
                } & { files: { description: string; hint: string } } & {
                    files: ConfigOption<"string", true, undefined | readonly string[]>;
                } & {
                    jobs: {
                        default: number;
                        description: string;
                        hint: string;
                        short: string;
                    };
                } & {
                    jobs: ConfigOption<"number", false, undefined | readonly number[]>;
                } & {
                    after: { description: string; hint: string };
                    before: { description: string; hint: string };
                    "output-dir": { description: string; hint: string; short: string };
                    "output-file": { description: string; hint: string; short: string };
                } & {
                    after: ConfigOption<"string", false, undefined | readonly string[]>;
                    before: ConfigOption<"string", false, undefined | readonly string[]>;
                    "output-dir": ConfigOption<
                        "string",
                        false,
                        undefined
                        | readonly string[],
                    >;
                    "output-file": ConfigOption<
                        "string",
                        false,
                        undefined
                        | readonly string[],
                    >;
                } & {
                    exclude: { default: string[]; description: string; hint: string };
                    include: { default: string[]; description: string; hint: string };
                    "node-arg": { default: never[]; description: string; hint: string };
                    serial: { description: string; hint: string };
                    "test-arg": { default: never[]; description: string; hint: string };
                    "test-env": { default: never[]; description: string; hint: string };
                } & {
                    exclude: ConfigOption<"string", true, undefined | readonly string[]>;
                    include: ConfigOption<"string", true, undefined | readonly string[]>;
                    "node-arg": ConfigOption<"string", true, undefined | readonly string[]>;
                    serial: ConfigOption<"string", true, undefined | readonly string[]>;
                    "test-arg": ConfigOption<"string", true, undefined | readonly string[]>;
                    "test-env": ConfigOption<"string", true, undefined | readonly string[]>;
                } & {
                    debug: { description: string };
                    help: { description: string; short: string; type: "boolean" };
                    "no-omit-whitespace": { description: string };
                    "omit-version": { description: string };
                    "omit-whitespace": { description: string };
                    version: { description: string; short: string };
                    versions: { description: string; short: string };
                } & {
                    debug: ConfigOption<"boolean", false, undefined>;
                    help: ConfigOption<"boolean", false, undefined>;
                    "no-omit-whitespace": ConfigOption<"boolean", false, undefined>;
                    "omit-version": ConfigOption<"boolean", false, undefined>;
                    "omit-whitespace": ConfigOption<"boolean", false, undefined>;
                    version: ConfigOption<"boolean", false, undefined>;
                    versions: ConfigOption<"boolean", false, undefined>;
                } & {
                    only: {
                        description: string;
                        nodeArgs: (v: boolean) => (...)[];
                        short: string;
                        type: string;
                    } & ConfigOption<"boolean", false, undefined>;
                } & { only: ConfigOption<"boolean", false, undefined> } & {
                    grep: {
                        description: string;
                        hint: string;
                        multiple: boolean;
                        nodeArgs: (value: (...)[]) => (...)[];
                        short: string;
                        type: string;
                    } & ConfigOption<"string", true, undefined | readonly (...)[]>;
                } & {
                    grep: ConfigOption<"string", true, undefined | readonly string[]>;
                } & {
                    invert: { description: string; short: string; type: string } & ConfigOption<
                        "boolean",
                        false,
                        undefined,
                    >;
                } & { invert: ConfigOption<"boolean", false, undefined> } & {
                    "no-invert": { description: string; short: string; type: string } & ConfigOption<
                        "boolean",
                        false,
                        undefined,
                    >;
                } & { "no-invert": ConfigOption<"boolean", false, undefined> } & {
                    "filter-quietly": { description: string; type: string } & ConfigOption<
                        "boolean",
                        false,
                        undefined,
                    >;
                } & { "filter-quietly": ConfigOption<"boolean", false, undefined> } & {
                    "no-filter-quietly": { description: string; type: string } & ConfigOption<
                        "boolean",
                        false,
                        undefined,
                    >;
                } & { "no-filter-quietly": ConfigOption<"boolean", false, undefined> } & {
                    "save-fixture": { description: string; short: string; type: string } & ConfigOption<
                        "boolean",
                        false,
                        undefined,
                    >;
                } & { "save-fixture": ConfigOption<"boolean", false, undefined> } & {
                    snapshot: { description: string; short: string; type: string } & ConfigOption<
                        "boolean",
                        false,
                        undefined,
                    >;
                } & { snapshot: ConfigOption<"boolean", false, undefined> } & {
                    "snapshot-clean-cwd": {
                        default: boolean;
                        description: string;
                        type: string;
                    } & ConfigOption<"boolean", false, undefined>;
                } & { "snapshot-clean-cwd": ConfigOption<"boolean", false, undefined> } & {
                    "no-snapshot-clean-cwd": { description: string; type: string } & ConfigOption<
                        "boolean",
                        false,
                        undefined,
                    >;
                } & {
                    "no-snapshot-clean-cwd": ConfigOption<"boolean", false, undefined>;
                } & {
                    typecheck: { description: string; type: string } & ConfigOption<
                        "boolean",
                        false,
                        undefined,
                    >;
                } & { typecheck: ConfigOption<"boolean", false, undefined> } & {
                    tsconfig: { description: string; type: string } & ConfigOption<
                        "string",
                        false,
                        undefined
                        | readonly (...)[],
                    >;
                } & {
                    tsconfig: ConfigOption<
                        "string",
                        false,
                        undefined
                        | readonly string[],
                    >;
                } & {
                    "type-strip-only": { description: string; type: string } & ConfigOption<
                        "boolean",
                        false,
                        undefined,
                    >;
                } & { "type-strip-only": ConfigOption<"boolean", false, undefined> },
            >;
        },
    >;
    readPackageJsonConfig(
        pj: string,
    ): Promise<
        | undefined
        | OptionsSubset<
            { plugin: { default: string[]; description: string; hint: string } } & {
                plugin: ConfigOption<"string", true, undefined | readonly string[]>;
            } & {
                reporter: { description: string; hint: string; short: string };
                "reporter-file": { description: string; hint: string; short: string };
            } & {
                reporter: ConfigOption<
                    "string",
                    false,
                    undefined
                    | readonly string[],
                >;
                "reporter-file": ConfigOption<
                    "string",
                    false,
                    undefined
                    | readonly string[],
                >;
            } & {
                "reporter-arg": { description: string; hint: string; short: string };
            } & {
                "reporter-arg": ConfigOption<
                    "string",
                    true,
                    undefined
                    | readonly string[],
                >;
            } & {
                "coverage-report": {
                    default: string[];
                    description: string;
                    hint: string;
                };
            } & {
                "coverage-report": ConfigOption<
                    "string",
                    true,
                    undefined
                    | readonly string[],
                >;
            } & {
                browser: { default: true; description: string };
                "no-browser": { description: string };
                "show-full-coverage": { description: string };
            } & {
                browser: ConfigOption<"boolean", false, undefined>;
                "no-browser": ConfigOption<"boolean", false, undefined>;
                "show-full-coverage": ConfigOption<"boolean", false, undefined>;
            } & { "coverage-map": { description: string; hint: string } } & {
                "coverage-map": ConfigOption<
                    "string",
                    false,
                    undefined
                    | readonly string[],
                >;
            } & {
                "allow-empty-coverage": { description: string };
                "allow-incomplete-coverage": { description: string };
                "disable-coverage": { description: string };
            } & {
                "allow-empty-coverage": ConfigOption<"boolean", false, undefined>;
                "allow-incomplete-coverage": ConfigOption<"boolean", false, undefined>;
                "disable-coverage": ConfigOption<"boolean", false, undefined>;
            } & {
                bail: { description: string; short: string };
                changed: { description: string; short: string };
                color: { description: string; short: string };
                comments: { description: string };
                "fail-only": { description: string };
                "fail-skip": { description: string };
                "fail-todo": { description: string };
                "no-bail": { description: string; short: string };
                "no-color": { description: string; short: string };
                passes: { description: string };
            } & {
                bail: ConfigOption<"boolean", false, undefined>;
                changed: ConfigOption<"boolean", false, undefined>;
                color: ConfigOption<"boolean", false, undefined>;
                comments: ConfigOption<"boolean", false, undefined>;
                "fail-only": ConfigOption<"boolean", false, undefined>;
                "fail-skip": ConfigOption<"boolean", false, undefined>;
                "fail-todo": ConfigOption<"boolean", false, undefined>;
                "no-bail": ConfigOption<"boolean", false, undefined>;
                "no-color": ConfigOption<"boolean", false, undefined>;
                passes: ConfigOption<"boolean", false, undefined>;
            } & { save: { description: string; hint: string; short: string } } & {
                save: ConfigOption<"string", false, undefined | readonly string[]>;
            } & { diag: { description: string }; "no-diag": { description: string } } & {
                diag: ConfigOption<"boolean", false, undefined>;
                "no-diag": ConfigOption<"boolean", false, undefined>;
            } & {
                timeout: {
                    default: number;
                    description: string;
                    hint: string;
                    short: string;
                };
            } & {
                timeout: ConfigOption<"number", false, undefined | readonly number[]>;
            } & { files: { description: string; hint: string } } & {
                files: ConfigOption<"string", true, undefined | readonly string[]>;
            } & {
                jobs: {
                    default: number;
                    description: string;
                    hint: string;
                    short: string;
                };
            } & {
                jobs: ConfigOption<"number", false, undefined | readonly number[]>;
            } & {
                after: { description: string; hint: string };
                before: { description: string; hint: string };
                "output-dir": { description: string; hint: string; short: string };
                "output-file": { description: string; hint: string; short: string };
            } & {
                after: ConfigOption<"string", false, undefined | readonly string[]>;
                before: ConfigOption<"string", false, undefined | readonly string[]>;
                "output-dir": ConfigOption<
                    "string",
                    false,
                    undefined
                    | readonly string[],
                >;
                "output-file": ConfigOption<
                    "string",
                    false,
                    undefined
                    | readonly string[],
                >;
            } & {
                exclude: { default: string[]; description: string; hint: string };
                include: { default: string[]; description: string; hint: string };
                "node-arg": { default: never[]; description: string; hint: string };
                serial: { description: string; hint: string };
                "test-arg": { default: never[]; description: string; hint: string };
                "test-env": { default: never[]; description: string; hint: string };
            } & {
                exclude: ConfigOption<"string", true, undefined | readonly string[]>;
                include: ConfigOption<"string", true, undefined | readonly string[]>;
                "node-arg": ConfigOption<"string", true, undefined | readonly string[]>;
                serial: ConfigOption<"string", true, undefined | readonly string[]>;
                "test-arg": ConfigOption<"string", true, undefined | readonly string[]>;
                "test-env": ConfigOption<"string", true, undefined | readonly string[]>;
            } & {
                debug: { description: string };
                help: { description: string; short: string; type: "boolean" };
                "no-omit-whitespace": { description: string };
                "omit-version": { description: string };
                "omit-whitespace": { description: string };
                version: { description: string; short: string };
                versions: { description: string; short: string };
            } & {
                debug: ConfigOption<"boolean", false, undefined>;
                help: ConfigOption<"boolean", false, undefined>;
                "no-omit-whitespace": ConfigOption<"boolean", false, undefined>;
                "omit-version": ConfigOption<"boolean", false, undefined>;
                "omit-whitespace": ConfigOption<"boolean", false, undefined>;
                version: ConfigOption<"boolean", false, undefined>;
                versions: ConfigOption<"boolean", false, undefined>;
            } & {
                only: {
                    description: string;
                    nodeArgs: (v: boolean) => string[];
                    short: string;
                    type: string;
                } & ConfigOption<"boolean", false, undefined>;
            } & { only: ConfigOption<"boolean", false, undefined> } & {
                grep: {
                    description: string;
                    hint: string;
                    multiple: boolean;
                    nodeArgs: (value: string[]) => string[];
                    short: string;
                    type: string;
                } & ConfigOption<"string", true, undefined | readonly string[]>;
            } & { grep: ConfigOption<"string", true, undefined | readonly string[]> } & {
                invert: { description: string; short: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { invert: ConfigOption<"boolean", false, undefined> } & {
                "no-invert": { description: string; short: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { "no-invert": ConfigOption<"boolean", false, undefined> } & {
                "filter-quietly": { description: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { "filter-quietly": ConfigOption<"boolean", false, undefined> } & {
                "no-filter-quietly": { description: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { "no-filter-quietly": ConfigOption<"boolean", false, undefined> } & {
                "save-fixture": { description: string; short: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { "save-fixture": ConfigOption<"boolean", false, undefined> } & {
                snapshot: { description: string; short: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { snapshot: ConfigOption<"boolean", false, undefined> } & {
                "snapshot-clean-cwd": {
                    default: boolean;
                    description: string;
                    type: string;
                } & ConfigOption<"boolean", false, undefined>;
            } & { "snapshot-clean-cwd": ConfigOption<"boolean", false, undefined> } & {
                "no-snapshot-clean-cwd": { description: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & {
                "no-snapshot-clean-cwd": ConfigOption<"boolean", false, undefined>;
            } & {
                typecheck: { description: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { typecheck: ConfigOption<"boolean", false, undefined> } & {
                tsconfig: { description: string; type: string } & ConfigOption<
                    "string",
                    false,
                    undefined
                    | readonly string[],
                >;
            } & {
                tsconfig: ConfigOption<
                    "string",
                    false,
                    undefined
                    | readonly string[],
                >;
            } & {
                "type-strip-only": { description: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { "type-strip-only": ConfigOption<"boolean", false, undefined> },
        >,
    >;
    readYAMLConfig(
        rc: string,
        silent?: boolean,
    ): Promise<
        | undefined
        | ConfigFileData<
            { plugin: { default: string[]; description: string; hint: string } } & {
                plugin: ConfigOption<"string", true, undefined | readonly string[]>;
            } & {
                reporter: { description: string; hint: string; short: string };
                "reporter-file": { description: string; hint: string; short: string };
            } & {
                reporter: ConfigOption<
                    "string",
                    false,
                    undefined
                    | readonly string[],
                >;
                "reporter-file": ConfigOption<
                    "string",
                    false,
                    undefined
                    | readonly string[],
                >;
            } & {
                "reporter-arg": { description: string; hint: string; short: string };
            } & {
                "reporter-arg": ConfigOption<
                    "string",
                    true,
                    undefined
                    | readonly string[],
                >;
            } & {
                "coverage-report": {
                    default: string[];
                    description: string;
                    hint: string;
                };
            } & {
                "coverage-report": ConfigOption<
                    "string",
                    true,
                    undefined
                    | readonly string[],
                >;
            } & {
                browser: { default: true; description: string };
                "no-browser": { description: string };
                "show-full-coverage": { description: string };
            } & {
                browser: ConfigOption<"boolean", false, undefined>;
                "no-browser": ConfigOption<"boolean", false, undefined>;
                "show-full-coverage": ConfigOption<"boolean", false, undefined>;
            } & { "coverage-map": { description: string; hint: string } } & {
                "coverage-map": ConfigOption<
                    "string",
                    false,
                    undefined
                    | readonly string[],
                >;
            } & {
                "allow-empty-coverage": { description: string };
                "allow-incomplete-coverage": { description: string };
                "disable-coverage": { description: string };
            } & {
                "allow-empty-coverage": ConfigOption<"boolean", false, undefined>;
                "allow-incomplete-coverage": ConfigOption<"boolean", false, undefined>;
                "disable-coverage": ConfigOption<"boolean", false, undefined>;
            } & {
                bail: { description: string; short: string };
                changed: { description: string; short: string };
                color: { description: string; short: string };
                comments: { description: string };
                "fail-only": { description: string };
                "fail-skip": { description: string };
                "fail-todo": { description: string };
                "no-bail": { description: string; short: string };
                "no-color": { description: string; short: string };
                passes: { description: string };
            } & {
                bail: ConfigOption<"boolean", false, undefined>;
                changed: ConfigOption<"boolean", false, undefined>;
                color: ConfigOption<"boolean", false, undefined>;
                comments: ConfigOption<"boolean", false, undefined>;
                "fail-only": ConfigOption<"boolean", false, undefined>;
                "fail-skip": ConfigOption<"boolean", false, undefined>;
                "fail-todo": ConfigOption<"boolean", false, undefined>;
                "no-bail": ConfigOption<"boolean", false, undefined>;
                "no-color": ConfigOption<"boolean", false, undefined>;
                passes: ConfigOption<"boolean", false, undefined>;
            } & { save: { description: string; hint: string; short: string } } & {
                save: ConfigOption<"string", false, undefined | readonly string[]>;
            } & { diag: { description: string }; "no-diag": { description: string } } & {
                diag: ConfigOption<"boolean", false, undefined>;
                "no-diag": ConfigOption<"boolean", false, undefined>;
            } & {
                timeout: {
                    default: number;
                    description: string;
                    hint: string;
                    short: string;
                };
            } & {
                timeout: ConfigOption<"number", false, undefined | readonly number[]>;
            } & { files: { description: string; hint: string } } & {
                files: ConfigOption<"string", true, undefined | readonly string[]>;
            } & {
                jobs: {
                    default: number;
                    description: string;
                    hint: string;
                    short: string;
                };
            } & {
                jobs: ConfigOption<"number", false, undefined | readonly number[]>;
            } & {
                after: { description: string; hint: string };
                before: { description: string; hint: string };
                "output-dir": { description: string; hint: string; short: string };
                "output-file": { description: string; hint: string; short: string };
            } & {
                after: ConfigOption<"string", false, undefined | readonly string[]>;
                before: ConfigOption<"string", false, undefined | readonly string[]>;
                "output-dir": ConfigOption<
                    "string",
                    false,
                    undefined
                    | readonly string[],
                >;
                "output-file": ConfigOption<
                    "string",
                    false,
                    undefined
                    | readonly string[],
                >;
            } & {
                exclude: { default: string[]; description: string; hint: string };
                include: { default: string[]; description: string; hint: string };
                "node-arg": { default: never[]; description: string; hint: string };
                serial: { description: string; hint: string };
                "test-arg": { default: never[]; description: string; hint: string };
                "test-env": { default: never[]; description: string; hint: string };
            } & {
                exclude: ConfigOption<"string", true, undefined | readonly string[]>;
                include: ConfigOption<"string", true, undefined | readonly string[]>;
                "node-arg": ConfigOption<"string", true, undefined | readonly string[]>;
                serial: ConfigOption<"string", true, undefined | readonly string[]>;
                "test-arg": ConfigOption<"string", true, undefined | readonly string[]>;
                "test-env": ConfigOption<"string", true, undefined | readonly string[]>;
            } & {
                debug: { description: string };
                help: { description: string; short: string; type: "boolean" };
                "no-omit-whitespace": { description: string };
                "omit-version": { description: string };
                "omit-whitespace": { description: string };
                version: { description: string; short: string };
                versions: { description: string; short: string };
            } & {
                debug: ConfigOption<"boolean", false, undefined>;
                help: ConfigOption<"boolean", false, undefined>;
                "no-omit-whitespace": ConfigOption<"boolean", false, undefined>;
                "omit-version": ConfigOption<"boolean", false, undefined>;
                "omit-whitespace": ConfigOption<"boolean", false, undefined>;
                version: ConfigOption<"boolean", false, undefined>;
                versions: ConfigOption<"boolean", false, undefined>;
            } & {
                only: {
                    description: string;
                    nodeArgs: (v: boolean) => string[];
                    short: string;
                    type: string;
                } & ConfigOption<"boolean", false, undefined>;
            } & { only: ConfigOption<"boolean", false, undefined> } & {
                grep: {
                    description: string;
                    hint: string;
                    multiple: boolean;
                    nodeArgs: (value: string[]) => string[];
                    short: string;
                    type: string;
                } & ConfigOption<"string", true, undefined | readonly string[]>;
            } & { grep: ConfigOption<"string", true, undefined | readonly string[]> } & {
                invert: { description: string; short: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { invert: ConfigOption<"boolean", false, undefined> } & {
                "no-invert": { description: string; short: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { "no-invert": ConfigOption<"boolean", false, undefined> } & {
                "filter-quietly": { description: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { "filter-quietly": ConfigOption<"boolean", false, undefined> } & {
                "no-filter-quietly": { description: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { "no-filter-quietly": ConfigOption<"boolean", false, undefined> } & {
                "save-fixture": { description: string; short: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { "save-fixture": ConfigOption<"boolean", false, undefined> } & {
                snapshot: { description: string; short: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { snapshot: ConfigOption<"boolean", false, undefined> } & {
                "snapshot-clean-cwd": {
                    default: boolean;
                    description: string;
                    type: string;
                } & ConfigOption<"boolean", false, undefined>;
            } & { "snapshot-clean-cwd": ConfigOption<"boolean", false, undefined> } & {
                "no-snapshot-clean-cwd": { description: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & {
                "no-snapshot-clean-cwd": ConfigOption<"boolean", false, undefined>;
            } & {
                typecheck: { description: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { typecheck: ConfigOption<"boolean", false, undefined> } & {
                tsconfig: { description: string; type: string } & ConfigOption<
                    "string",
                    false,
                    undefined
                    | readonly string[],
                >;
            } & {
                tsconfig: ConfigOption<
                    "string",
                    false,
                    undefined
                    | readonly string[],
                >;
            } & {
                "type-strip-only": { description: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { "type-strip-only": ConfigOption<"boolean", false, undefined> },
        >,
    >;
    resolveExtension(ext: string, file: string): Promise<string>;
    resolvePathOptions(
        conf:
            | undefined
            | ConfigFileData<
                { plugin: { default: string[]; description: string; hint: string } } & {
                    plugin: ConfigOption<"string", true, undefined | readonly string[]>;
                } & {
                    reporter: { description: string; hint: string; short: string };
                    "reporter-file": { description: string; hint: string; short: string };
                } & {
                    reporter: ConfigOption<
                        "string",
                        false,
                        undefined
                        | readonly string[],
                    >;
                    "reporter-file": ConfigOption<
                        "string",
                        false,
                        undefined
                        | readonly string[],
                    >;
                } & {
                    "reporter-arg": { description: string; hint: string; short: string };
                } & {
                    "reporter-arg": ConfigOption<
                        "string",
                        true,
                        undefined
                        | readonly string[],
                    >;
                } & {
                    "coverage-report": {
                        default: string[];
                        description: string;
                        hint: string;
                    };
                } & {
                    "coverage-report": ConfigOption<
                        "string",
                        true,
                        undefined
                        | readonly string[],
                    >;
                } & {
                    browser: { default: true; description: string };
                    "no-browser": { description: string };
                    "show-full-coverage": { description: string };
                } & {
                    browser: ConfigOption<"boolean", false, undefined>;
                    "no-browser": ConfigOption<"boolean", false, undefined>;
                    "show-full-coverage": ConfigOption<"boolean", false, undefined>;
                } & { "coverage-map": { description: string; hint: string } } & {
                    "coverage-map": ConfigOption<
                        "string",
                        false,
                        undefined
                        | readonly string[],
                    >;
                } & {
                    "allow-empty-coverage": { description: string };
                    "allow-incomplete-coverage": { description: string };
                    "disable-coverage": { description: string };
                } & {
                    "allow-empty-coverage": ConfigOption<"boolean", false, undefined>;
                    "allow-incomplete-coverage": ConfigOption<"boolean", false, undefined>;
                    "disable-coverage": ConfigOption<"boolean", false, undefined>;
                } & {
                    bail: { description: string; short: string };
                    changed: { description: string; short: string };
                    color: { description: string; short: string };
                    comments: { description: string };
                    "fail-only": { description: string };
                    "fail-skip": { description: string };
                    "fail-todo": { description: string };
                    "no-bail": { description: string; short: string };
                    "no-color": { description: string; short: string };
                    passes: { description: string };
                } & {
                    bail: ConfigOption<"boolean", false, undefined>;
                    changed: ConfigOption<"boolean", false, undefined>;
                    color: ConfigOption<"boolean", false, undefined>;
                    comments: ConfigOption<"boolean", false, undefined>;
                    "fail-only": ConfigOption<"boolean", false, undefined>;
                    "fail-skip": ConfigOption<"boolean", false, undefined>;
                    "fail-todo": ConfigOption<"boolean", false, undefined>;
                    "no-bail": ConfigOption<"boolean", false, undefined>;
                    "no-color": ConfigOption<"boolean", false, undefined>;
                    passes: ConfigOption<"boolean", false, undefined>;
                } & { save: { description: string; hint: string; short: string } } & {
                    save: ConfigOption<"string", false, undefined | readonly string[]>;
                } & {
                    diag: { description: string };
                    "no-diag": { description: string };
                } & {
                    diag: ConfigOption<"boolean", false, undefined>;
                    "no-diag": ConfigOption<"boolean", false, undefined>;
                } & {
                    timeout: {
                        default: number;
                        description: string;
                        hint: string;
                        short: string;
                    };
                } & {
                    timeout: ConfigOption<
                        "number",
                        false,
                        undefined
                        | readonly number[],
                    >;
                } & { files: { description: string; hint: string } } & {
                    files: ConfigOption<"string", true, undefined | readonly string[]>;
                } & {
                    jobs: {
                        default: number;
                        description: string;
                        hint: string;
                        short: string;
                    };
                } & {
                    jobs: ConfigOption<"number", false, undefined | readonly number[]>;
                } & {
                    after: { description: string; hint: string };
                    before: { description: string; hint: string };
                    "output-dir": { description: string; hint: string; short: string };
                    "output-file": { description: string; hint: string; short: string };
                } & {
                    after: ConfigOption<"string", false, undefined | readonly string[]>;
                    before: ConfigOption<"string", false, undefined | readonly string[]>;
                    "output-dir": ConfigOption<
                        "string",
                        false,
                        undefined
                        | readonly string[],
                    >;
                    "output-file": ConfigOption<
                        "string",
                        false,
                        undefined
                        | readonly string[],
                    >;
                } & {
                    exclude: { default: string[]; description: string; hint: string };
                    include: { default: string[]; description: string; hint: string };
                    "node-arg": { default: never[]; description: string; hint: string };
                    serial: { description: string; hint: string };
                    "test-arg": { default: never[]; description: string; hint: string };
                    "test-env": { default: never[]; description: string; hint: string };
                } & {
                    exclude: ConfigOption<"string", true, undefined | readonly string[]>;
                    include: ConfigOption<"string", true, undefined | readonly string[]>;
                    "node-arg": ConfigOption<"string", true, undefined | readonly string[]>;
                    serial: ConfigOption<"string", true, undefined | readonly string[]>;
                    "test-arg": ConfigOption<"string", true, undefined | readonly string[]>;
                    "test-env": ConfigOption<"string", true, undefined | readonly string[]>;
                } & {
                    debug: { description: string };
                    help: { description: string; short: string; type: "boolean" };
                    "no-omit-whitespace": { description: string };
                    "omit-version": { description: string };
                    "omit-whitespace": { description: string };
                    version: { description: string; short: string };
                    versions: { description: string; short: string };
                } & {
                    debug: ConfigOption<"boolean", false, undefined>;
                    help: ConfigOption<"boolean", false, undefined>;
                    "no-omit-whitespace": ConfigOption<"boolean", false, undefined>;
                    "omit-version": ConfigOption<"boolean", false, undefined>;
                    "omit-whitespace": ConfigOption<"boolean", false, undefined>;
                    version: ConfigOption<"boolean", false, undefined>;
                    versions: ConfigOption<"boolean", false, undefined>;
                } & {
                    only: {
                        description: string;
                        nodeArgs: (v: boolean) => string[];
                        short: string;
                        type: string;
                    } & ConfigOption<"boolean", false, undefined>;
                } & { only: ConfigOption<"boolean", false, undefined> } & {
                    grep: {
                        description: string;
                        hint: string;
                        multiple: boolean;
                        nodeArgs: (value: string[]) => string[];
                        short: string;
                        type: string;
                    } & ConfigOption<"string", true, undefined | readonly string[]>;
                } & {
                    grep: ConfigOption<"string", true, undefined | readonly string[]>;
                } & {
                    invert: { description: string; short: string; type: string } & ConfigOption<
                        "boolean",
                        false,
                        undefined,
                    >;
                } & { invert: ConfigOption<"boolean", false, undefined> } & {
                    "no-invert": { description: string; short: string; type: string } & ConfigOption<
                        "boolean",
                        false,
                        undefined,
                    >;
                } & { "no-invert": ConfigOption<"boolean", false, undefined> } & {
                    "filter-quietly": { description: string; type: string } & ConfigOption<
                        "boolean",
                        false,
                        undefined,
                    >;
                } & { "filter-quietly": ConfigOption<"boolean", false, undefined> } & {
                    "no-filter-quietly": { description: string; type: string } & ConfigOption<
                        "boolean",
                        false,
                        undefined,
                    >;
                } & { "no-filter-quietly": ConfigOption<"boolean", false, undefined> } & {
                    "save-fixture": { description: string; short: string; type: string } & ConfigOption<
                        "boolean",
                        false,
                        undefined,
                    >;
                } & { "save-fixture": ConfigOption<"boolean", false, undefined> } & {
                    snapshot: { description: string; short: string; type: string } & ConfigOption<
                        "boolean",
                        false,
                        undefined,
                    >;
                } & { snapshot: ConfigOption<"boolean", false, undefined> } & {
                    "snapshot-clean-cwd": {
                        default: boolean;
                        description: string;
                        type: string;
                    } & ConfigOption<"boolean", false, undefined>;
                } & { "snapshot-clean-cwd": ConfigOption<"boolean", false, undefined> } & {
                    "no-snapshot-clean-cwd": { description: string; type: string } & ConfigOption<
                        "boolean",
                        false,
                        undefined,
                    >;
                } & {
                    "no-snapshot-clean-cwd": ConfigOption<"boolean", false, undefined>;
                } & {
                    typecheck: { description: string; type: string } & ConfigOption<
                        "boolean",
                        false,
                        undefined,
                    >;
                } & { typecheck: ConfigOption<"boolean", false, undefined> } & {
                    tsconfig: { description: string; type: string } & ConfigOption<
                        "string",
                        false,
                        undefined
                        | readonly string[],
                    >;
                } & {
                    tsconfig: ConfigOption<
                        "string",
                        false,
                        undefined
                        | readonly string[],
                    >;
                } & {
                    "type-strip-only": { description: string; type: string } & ConfigOption<
                        "boolean",
                        false,
                        undefined,
                    >;
                } & { "type-strip-only": ConfigOption<"boolean", false, undefined> },
            >,
        file: string,
    ):
        | undefined
        | OptionsSubset<
            { plugin: { default: string[]; description: string; hint: string } } & {
                plugin: ConfigOption<"string", true, undefined | readonly string[]>;
            } & {
                reporter: { description: string; hint: string; short: string };
                "reporter-file": { description: string; hint: string; short: string };
            } & {
                reporter: ConfigOption<
                    "string",
                    false,
                    undefined
                    | readonly string[],
                >;
                "reporter-file": ConfigOption<
                    "string",
                    false,
                    undefined
                    | readonly string[],
                >;
            } & {
                "reporter-arg": { description: string; hint: string; short: string };
            } & {
                "reporter-arg": ConfigOption<
                    "string",
                    true,
                    undefined
                    | readonly string[],
                >;
            } & {
                "coverage-report": {
                    default: string[];
                    description: string;
                    hint: string;
                };
            } & {
                "coverage-report": ConfigOption<
                    "string",
                    true,
                    undefined
                    | readonly string[],
                >;
            } & {
                browser: { default: true; description: string };
                "no-browser": { description: string };
                "show-full-coverage": { description: string };
            } & {
                browser: ConfigOption<"boolean", false, undefined>;
                "no-browser": ConfigOption<"boolean", false, undefined>;
                "show-full-coverage": ConfigOption<"boolean", false, undefined>;
            } & { "coverage-map": { description: string; hint: string } } & {
                "coverage-map": ConfigOption<
                    "string",
                    false,
                    undefined
                    | readonly string[],
                >;
            } & {
                "allow-empty-coverage": { description: string };
                "allow-incomplete-coverage": { description: string };
                "disable-coverage": { description: string };
            } & {
                "allow-empty-coverage": ConfigOption<"boolean", false, undefined>;
                "allow-incomplete-coverage": ConfigOption<"boolean", false, undefined>;
                "disable-coverage": ConfigOption<"boolean", false, undefined>;
            } & {
                bail: { description: string; short: string };
                changed: { description: string; short: string };
                color: { description: string; short: string };
                comments: { description: string };
                "fail-only": { description: string };
                "fail-skip": { description: string };
                "fail-todo": { description: string };
                "no-bail": { description: string; short: string };
                "no-color": { description: string; short: string };
                passes: { description: string };
            } & {
                bail: ConfigOption<"boolean", false, undefined>;
                changed: ConfigOption<"boolean", false, undefined>;
                color: ConfigOption<"boolean", false, undefined>;
                comments: ConfigOption<"boolean", false, undefined>;
                "fail-only": ConfigOption<"boolean", false, undefined>;
                "fail-skip": ConfigOption<"boolean", false, undefined>;
                "fail-todo": ConfigOption<"boolean", false, undefined>;
                "no-bail": ConfigOption<"boolean", false, undefined>;
                "no-color": ConfigOption<"boolean", false, undefined>;
                passes: ConfigOption<"boolean", false, undefined>;
            } & { save: { description: string; hint: string; short: string } } & {
                save: ConfigOption<"string", false, undefined | readonly string[]>;
            } & { diag: { description: string }; "no-diag": { description: string } } & {
                diag: ConfigOption<"boolean", false, undefined>;
                "no-diag": ConfigOption<"boolean", false, undefined>;
            } & {
                timeout: {
                    default: number;
                    description: string;
                    hint: string;
                    short: string;
                };
            } & {
                timeout: ConfigOption<"number", false, undefined | readonly number[]>;
            } & { files: { description: string; hint: string } } & {
                files: ConfigOption<"string", true, undefined | readonly string[]>;
            } & {
                jobs: {
                    default: number;
                    description: string;
                    hint: string;
                    short: string;
                };
            } & {
                jobs: ConfigOption<"number", false, undefined | readonly number[]>;
            } & {
                after: { description: string; hint: string };
                before: { description: string; hint: string };
                "output-dir": { description: string; hint: string; short: string };
                "output-file": { description: string; hint: string; short: string };
            } & {
                after: ConfigOption<"string", false, undefined | readonly string[]>;
                before: ConfigOption<"string", false, undefined | readonly string[]>;
                "output-dir": ConfigOption<
                    "string",
                    false,
                    undefined
                    | readonly string[],
                >;
                "output-file": ConfigOption<
                    "string",
                    false,
                    undefined
                    | readonly string[],
                >;
            } & {
                exclude: { default: string[]; description: string; hint: string };
                include: { default: string[]; description: string; hint: string };
                "node-arg": { default: never[]; description: string; hint: string };
                serial: { description: string; hint: string };
                "test-arg": { default: never[]; description: string; hint: string };
                "test-env": { default: never[]; description: string; hint: string };
            } & {
                exclude: ConfigOption<"string", true, undefined | readonly string[]>;
                include: ConfigOption<"string", true, undefined | readonly string[]>;
                "node-arg": ConfigOption<"string", true, undefined | readonly string[]>;
                serial: ConfigOption<"string", true, undefined | readonly string[]>;
                "test-arg": ConfigOption<"string", true, undefined | readonly string[]>;
                "test-env": ConfigOption<"string", true, undefined | readonly string[]>;
            } & {
                debug: { description: string };
                help: { description: string; short: string; type: "boolean" };
                "no-omit-whitespace": { description: string };
                "omit-version": { description: string };
                "omit-whitespace": { description: string };
                version: { description: string; short: string };
                versions: { description: string; short: string };
            } & {
                debug: ConfigOption<"boolean", false, undefined>;
                help: ConfigOption<"boolean", false, undefined>;
                "no-omit-whitespace": ConfigOption<"boolean", false, undefined>;
                "omit-version": ConfigOption<"boolean", false, undefined>;
                "omit-whitespace": ConfigOption<"boolean", false, undefined>;
                version: ConfigOption<"boolean", false, undefined>;
                versions: ConfigOption<"boolean", false, undefined>;
            } & {
                only: {
                    description: string;
                    nodeArgs: (v: boolean) => string[];
                    short: string;
                    type: string;
                } & ConfigOption<"boolean", false, undefined>;
            } & { only: ConfigOption<"boolean", false, undefined> } & {
                grep: {
                    description: string;
                    hint: string;
                    multiple: boolean;
                    nodeArgs: (value: string[]) => string[];
                    short: string;
                    type: string;
                } & ConfigOption<"string", true, undefined | readonly string[]>;
            } & { grep: ConfigOption<"string", true, undefined | readonly string[]> } & {
                invert: { description: string; short: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { invert: ConfigOption<"boolean", false, undefined> } & {
                "no-invert": { description: string; short: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { "no-invert": ConfigOption<"boolean", false, undefined> } & {
                "filter-quietly": { description: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { "filter-quietly": ConfigOption<"boolean", false, undefined> } & {
                "no-filter-quietly": { description: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { "no-filter-quietly": ConfigOption<"boolean", false, undefined> } & {
                "save-fixture": { description: string; short: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { "save-fixture": ConfigOption<"boolean", false, undefined> } & {
                snapshot: { description: string; short: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { snapshot: ConfigOption<"boolean", false, undefined> } & {
                "snapshot-clean-cwd": {
                    default: boolean;
                    description: string;
                    type: string;
                } & ConfigOption<"boolean", false, undefined>;
            } & { "snapshot-clean-cwd": ConfigOption<"boolean", false, undefined> } & {
                "no-snapshot-clean-cwd": { description: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & {
                "no-snapshot-clean-cwd": ConfigOption<"boolean", false, undefined>;
            } & {
                typecheck: { description: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { typecheck: ConfigOption<"boolean", false, undefined> } & {
                tsconfig: { description: string; type: string } & ConfigOption<
                    "string",
                    false,
                    undefined
                    | readonly string[],
                >;
            } & {
                tsconfig: ConfigOption<
                    "string",
                    false,
                    undefined
                    | readonly string[],
                >;
            } & {
                "type-strip-only": { description: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { "type-strip-only": ConfigOption<"boolean", false, undefined> },
        >;
}

Hierarchy

ReturnType<
    ReturnType<
        Awaited<
            ReturnType<
                Awaited<ReturnType<ReturnType<(...)>["loadConfigFile"]>>["loadColor"],
            >,
        >["loadReporter"],
    >["parse"],
>
- LoadedConfig

Properties

configFile

configFile: string

The file providing configuration, either a package.json or .taprc. If undefined, it means that we don't have a config file.

jack

jack: Jack<
    { plugin: { default: string[]; description: string; hint: string } } & {
        plugin: ConfigOption<"string", true, undefined | readonly string[]>;
    } & {
        reporter: { description: string; hint: string; short: string };
        "reporter-file": { description: string; hint: string; short: string };
    } & {
        reporter: ConfigOption<"string", false, undefined | readonly string[]>;
        "reporter-file": ConfigOption<
            "string",
            false,
            undefined
            | readonly string[],
        >;
    } & {
        "reporter-arg": { description: string; hint: string; short: string };
    } & {
        "reporter-arg": ConfigOption<
            "string",
            true,
            undefined
            | readonly string[],
        >;
    } & {
        "coverage-report": {
            default: string[];
            description: string;
            hint: string;
        };
    } & {
        "coverage-report": ConfigOption<
            "string",
            true,
            undefined
            | readonly string[],
        >;
    } & {
        browser: { default: true; description: string };
        "no-browser": { description: string };
        "show-full-coverage": { description: string };
    } & {
        browser: ConfigOption<"boolean", false, undefined>;
        "no-browser": ConfigOption<"boolean", false, undefined>;
        "show-full-coverage": ConfigOption<"boolean", false, undefined>;
    } & { "coverage-map": { description: string; hint: string } } & {
        "coverage-map": ConfigOption<
            "string",
            false,
            undefined
            | readonly string[],
        >;
    } & {
        "allow-empty-coverage": { description: string };
        "allow-incomplete-coverage": { description: string };
        "disable-coverage": { description: string };
    } & {
        "allow-empty-coverage": ConfigOption<"boolean", false, undefined>;
        "allow-incomplete-coverage": ConfigOption<"boolean", false, undefined>;
        "disable-coverage": ConfigOption<"boolean", false, undefined>;
    } & {
        bail: { description: string; short: string };
        changed: { description: string; short: string };
        color: { description: string; short: string };
        comments: { description: string };
        "fail-only": { description: string };
        "fail-skip": { description: string };
        "fail-todo": { description: string };
        "no-bail": { description: string; short: string };
        "no-color": { description: string; short: string };
        passes: { description: string };
    } & {
        bail: ConfigOption<"boolean", false, undefined>;
        changed: ConfigOption<"boolean", false, undefined>;
        color: ConfigOption<"boolean", false, undefined>;
        comments: ConfigOption<"boolean", false, undefined>;
        "fail-only": ConfigOption<"boolean", false, undefined>;
        "fail-skip": ConfigOption<"boolean", false, undefined>;
        "fail-todo": ConfigOption<"boolean", false, undefined>;
        "no-bail": ConfigOption<"boolean", false, undefined>;
        "no-color": ConfigOption<"boolean", false, undefined>;
        passes: ConfigOption<"boolean", false, undefined>;
    } & { save: { description: string; hint: string; short: string } } & {
        save: ConfigOption<"string", false, undefined | readonly string[]>;
    } & { diag: { description: string }; "no-diag": { description: string } } & {
        diag: ConfigOption<"boolean", false, undefined>;
        "no-diag": ConfigOption<"boolean", false, undefined>;
    } & {
        timeout: {
            default: number;
            description: string;
            hint: string;
            short: string;
        };
    } & {
        timeout: ConfigOption<"number", false, undefined | readonly number[]>;
    } & { files: { description: string; hint: string } } & {
        files: ConfigOption<"string", true, undefined | readonly string[]>;
    } & {
        jobs: {
            default: number;
            description: string;
            hint: string;
            short: string;
        };
    } & { jobs: ConfigOption<"number", false, undefined | readonly number[]> } & {
        after: { description: string; hint: string };
        before: { description: string; hint: string };
        "output-dir": { description: string; hint: string; short: string };
        "output-file": { description: string; hint: string; short: string };
    } & {
        after: ConfigOption<"string", false, undefined | readonly string[]>;
        before: ConfigOption<"string", false, undefined | readonly string[]>;
        "output-dir": ConfigOption<"string", false, undefined | readonly string[]>;
        "output-file": ConfigOption<
            "string",
            false,
            undefined
            | readonly string[],
        >;
    } & {
        exclude: { default: string[]; description: string; hint: string };
        include: { default: string[]; description: string; hint: string };
        "node-arg": { default: never[]; description: string; hint: string };
        serial: { description: string; hint: string };
        "test-arg": { default: never[]; description: string; hint: string };
        "test-env": { default: never[]; description: string; hint: string };
    } & {
        exclude: ConfigOption<"string", true, undefined | readonly string[]>;
        include: ConfigOption<"string", true, undefined | readonly string[]>;
        "node-arg": ConfigOption<"string", true, undefined | readonly string[]>;
        serial: ConfigOption<"string", true, undefined | readonly string[]>;
        "test-arg": ConfigOption<"string", true, undefined | readonly string[]>;
        "test-env": ConfigOption<"string", true, undefined | readonly string[]>;
    } & {
        debug: { description: string };
        help: { description: string; short: string; type: "boolean" };
        "no-omit-whitespace": { description: string };
        "omit-version": { description: string };
        "omit-whitespace": { description: string };
        version: { description: string; short: string };
        versions: { description: string; short: string };
    } & {
        debug: ConfigOption<"boolean", false, undefined>;
        help: ConfigOption<"boolean", false, undefined>;
        "no-omit-whitespace": ConfigOption<"boolean", false, undefined>;
        "omit-version": ConfigOption<"boolean", false, undefined>;
        "omit-whitespace": ConfigOption<"boolean", false, undefined>;
        version: ConfigOption<"boolean", false, undefined>;
        versions: ConfigOption<"boolean", false, undefined>;
    } & {
        only: {
            description: string;
            nodeArgs: (v: boolean) => string[];
            short: string;
            type: string;
        } & ConfigOption<"boolean", false, undefined>;
    } & { only: ConfigOption<"boolean", false, undefined> } & {
        grep: {
            description: string;
            hint: string;
            multiple: boolean;
            nodeArgs: (value: string[]) => string[];
            short: string;
            type: string;
        } & ConfigOption<"string", true, undefined | readonly string[]>;
    } & { grep: ConfigOption<"string", true, undefined | readonly string[]> } & {
        invert: { description: string; short: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { invert: ConfigOption<"boolean", false, undefined> } & {
        "no-invert": { description: string; short: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { "no-invert": ConfigOption<"boolean", false, undefined> } & {
        "filter-quietly": { description: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { "filter-quietly": ConfigOption<"boolean", false, undefined> } & {
        "no-filter-quietly": { description: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { "no-filter-quietly": ConfigOption<"boolean", false, undefined> } & {
        "save-fixture": { description: string; short: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { "save-fixture": ConfigOption<"boolean", false, undefined> } & {
        snapshot: { description: string; short: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { snapshot: ConfigOption<"boolean", false, undefined> } & {
        "snapshot-clean-cwd": {
            default: boolean;
            description: string;
            type: string;
        } & ConfigOption<"boolean", false, undefined>;
    } & { "snapshot-clean-cwd": ConfigOption<"boolean", false, undefined> } & {
        "no-snapshot-clean-cwd": { description: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { "no-snapshot-clean-cwd": ConfigOption<"boolean", false, undefined> } & {
        typecheck: { description: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { typecheck: ConfigOption<"boolean", false, undefined> } & {
        tsconfig: { description: string; type: string } & ConfigOption<
            "string",
            false,
            undefined
            | readonly string[],
        >;
    } & {
        tsconfig: ConfigOption<"string", false, undefined | readonly string[]>;
    } & {
        "type-strip-only": { description: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { "type-strip-only": ConfigOption<"boolean", false, undefined> },
>

The JackSpeak object representing TAP's configuration

positionals

positionals: string[]

positional arguments to the TAP process

projectRoot

projectRoot: string = cwd

The effective current working directory for various globbing actions. The root of the project where a .taprc, package.json, or .git was found.

testFileExtensions

testFileExtensions: Set<string> = testFileExtensions

The file extensions that tap knows how to load, updated by plugins

values

values: OptionsResults<C>

Parsed values in effect

valuesFromConfigFile

valuesFromConfigFile: OptionsSubset<C>

values read from the config file, if loaded

Accessors

pluginList

get pluginList(): string[]
The list of all plugins that ought to be loaded.

Returns string[]
Inherited from ReturnType.pluginList
- Defined in src/config/src/index.ts:497

pluginSignature

get pluginSignature(): string
The signature of all plugin modules that ought to be loaded.

Returns string
Inherited from ReturnType.pluginSignature
- Defined in src/config/src/index.ts:487

Methods

addFields

addFields<F extends ConfigSet>(
    fields: F,
): TapConfig<
    { plugin: { default: string[]; description: string; hint: string } } & {
        plugin: ConfigOption<"string", true, undefined | readonly string[]>;
    } & {
        reporter: { description: string; hint: string; short: string };
        "reporter-file": { description: string; hint: string; short: string };
    } & {
        reporter: ConfigOption<"string", false, undefined | readonly string[]>;
        "reporter-file": ConfigOption<
            "string",
            false,
            undefined
            | readonly string[],
        >;
    } & {
        "reporter-arg": { description: string; hint: string; short: string };
    } & {
        "reporter-arg": ConfigOption<
            "string",
            true,
            undefined
            | readonly string[],
        >;
    } & {
        "coverage-report": {
            default: string[];
            description: string;
            hint: string;
        };
    } & {
        "coverage-report": ConfigOption<
            "string",
            true,
            undefined
            | readonly string[],
        >;
    } & {
        browser: { default: true; description: string };
        "no-browser": { description: string };
        "show-full-coverage": { description: string };
    } & {
        browser: ConfigOption<"boolean", false, undefined>;
        "no-browser": ConfigOption<"boolean", false, undefined>;
        "show-full-coverage": ConfigOption<"boolean", false, undefined>;
    } & { "coverage-map": { description: string; hint: string } } & {
        "coverage-map": ConfigOption<
            "string",
            false,
            undefined
            | readonly string[],
        >;
    } & {
        "allow-empty-coverage": { description: string };
        "allow-incomplete-coverage": { description: string };
        "disable-coverage": { description: string };
    } & {
        "allow-empty-coverage": ConfigOption<"boolean", false, undefined>;
        "allow-incomplete-coverage": ConfigOption<"boolean", false, undefined>;
        "disable-coverage": ConfigOption<"boolean", false, undefined>;
    } & {
        bail: { description: string; short: string };
        changed: { description: string; short: string };
        color: { description: string; short: string };
        comments: { description: string };
        "fail-only": { description: string };
        "fail-skip": { description: string };
        "fail-todo": { description: string };
        "no-bail": { description: string; short: string };
        "no-color": { description: string; short: string };
        passes: { description: string };
    } & {
        bail: ConfigOption<"boolean", false, undefined>;
        changed: ConfigOption<"boolean", false, undefined>;
        color: ConfigOption<"boolean", false, undefined>;
        comments: ConfigOption<"boolean", false, undefined>;
        "fail-only": ConfigOption<"boolean", false, undefined>;
        "fail-skip": ConfigOption<"boolean", false, undefined>;
        "fail-todo": ConfigOption<"boolean", false, undefined>;
        "no-bail": ConfigOption<"boolean", false, undefined>;
        "no-color": ConfigOption<"boolean", false, undefined>;
        passes: ConfigOption<"boolean", false, undefined>;
    } & { save: { description: string; hint: string; short: string } } & {
        save: ConfigOption<"string", false, undefined | readonly string[]>;
    } & { diag: { description: string }; "no-diag": { description: string } } & {
        diag: ConfigOption<"boolean", false, undefined>;
        "no-diag": ConfigOption<"boolean", false, undefined>;
    } & {
        timeout: {
            default: number;
            description: string;
            hint: string;
            short: string;
        };
    } & {
        timeout: ConfigOption<"number", false, undefined | readonly number[]>;
    } & { files: { description: string; hint: string } } & {
        files: ConfigOption<"string", true, undefined | readonly string[]>;
    } & {
        jobs: {
            default: number;
            description: string;
            hint: string;
            short: string;
        };
    } & { jobs: ConfigOption<"number", false, undefined | readonly number[]> } & {
        after: { description: string; hint: string };
        before: { description: string; hint: string };
        "output-dir": { description: string; hint: string; short: string };
        "output-file": { description: string; hint: string; short: string };
    } & {
        after: ConfigOption<"string", false, undefined | readonly string[]>;
        before: ConfigOption<"string", false, undefined | readonly string[]>;
        "output-dir": ConfigOption<"string", false, undefined | readonly string[]>;
        "output-file": ConfigOption<
            "string",
            false,
            undefined
            | readonly string[],
        >;
    } & {
        exclude: { default: string[]; description: string; hint: string };
        include: { default: string[]; description: string; hint: string };
        "node-arg": { default: never[]; description: string; hint: string };
        serial: { description: string; hint: string };
        "test-arg": { default: never[]; description: string; hint: string };
        "test-env": { default: never[]; description: string; hint: string };
    } & {
        exclude: ConfigOption<"string", true, undefined | readonly string[]>;
        include: ConfigOption<"string", true, undefined | readonly string[]>;
        "node-arg": ConfigOption<"string", true, undefined | readonly string[]>;
        serial: ConfigOption<"string", true, undefined | readonly string[]>;
        "test-arg": ConfigOption<"string", true, undefined | readonly string[]>;
        "test-env": ConfigOption<"string", true, undefined | readonly string[]>;
    } & {
        debug: { description: string };
        help: { description: string; short: string; type: "boolean" };
        "no-omit-whitespace": { description: string };
        "omit-version": { description: string };
        "omit-whitespace": { description: string };
        version: { description: string; short: string };
        versions: { description: string; short: string };
    } & {
        debug: ConfigOption<"boolean", false, undefined>;
        help: ConfigOption<"boolean", false, undefined>;
        "no-omit-whitespace": ConfigOption<"boolean", false, undefined>;
        "omit-version": ConfigOption<"boolean", false, undefined>;
        "omit-whitespace": ConfigOption<"boolean", false, undefined>;
        version: ConfigOption<"boolean", false, undefined>;
        versions: ConfigOption<"boolean", false, undefined>;
    } & {
        only: {
            description: string;
            nodeArgs: (v: boolean) => string[];
            short: string;
            type: string;
        } & ConfigOption<"boolean", false, undefined>;
    } & { only: ConfigOption<"boolean", false, undefined> } & {
        grep: {
            description: string;
            hint: string;
            multiple: boolean;
            nodeArgs: (value: string[]) => string[];
            short: string;
            type: string;
        } & ConfigOption<"string", true, undefined | readonly string[]>;
    } & { grep: ConfigOption<"string", true, undefined | readonly string[]> } & {
        invert: { description: string; short: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { invert: ConfigOption<"boolean", false, undefined> } & {
        "no-invert": { description: string; short: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { "no-invert": ConfigOption<"boolean", false, undefined> } & {
        "filter-quietly": { description: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { "filter-quietly": ConfigOption<"boolean", false, undefined> } & {
        "no-filter-quietly": { description: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { "no-filter-quietly": ConfigOption<"boolean", false, undefined> } & {
        "save-fixture": { description: string; short: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { "save-fixture": ConfigOption<"boolean", false, undefined> } & {
        snapshot: { description: string; short: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { snapshot: ConfigOption<"boolean", false, undefined> } & {
        "snapshot-clean-cwd": {
            default: boolean;
            description: string;
            type: string;
        } & ConfigOption<"boolean", false, undefined>;
    } & { "snapshot-clean-cwd": ConfigOption<"boolean", false, undefined> } & {
        "no-snapshot-clean-cwd": { description: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { "no-snapshot-clean-cwd": ConfigOption<"boolean", false, undefined> } & {
        typecheck: { description: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { typecheck: ConfigOption<"boolean", false, undefined> } & {
        tsconfig: { description: string; type: string } & ConfigOption<
            "string",
            false,
            undefined
            | readonly string[],
        >;
    } & {
        tsconfig: ConfigOption<"string", false, undefined | readonly string[]>;
    } & {
        "type-strip-only": { description: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { "type-strip-only": ConfigOption<"boolean", false, undefined> } & F,
>
Add fields to the config set. Used when loading plugins that export a config object.
Type Parameters
- F extends ConfigSet
Parameters
- fields: F
Returns TapConfig<
    { plugin: { default: string[]; description: string; hint: string } } & {
        plugin: ConfigOption<"string", true, undefined | readonly string[]>;
    } & {
        reporter: { description: string; hint: string; short: string };
        "reporter-file": { description: string; hint: string; short: string };
    } & {
        reporter: ConfigOption<"string", false, undefined | readonly string[]>;
        "reporter-file": ConfigOption<
            "string",
            false,
            undefined
            | readonly string[],
        >;
    } & {
        "reporter-arg": { description: string; hint: string; short: string };
    } & {
        "reporter-arg": ConfigOption<
            "string",
            true,
            undefined
            | readonly string[],
        >;
    } & {
        "coverage-report": {
            default: string[];
            description: string;
            hint: string;
        };
    } & {
        "coverage-report": ConfigOption<
            "string",
            true,
            undefined
            | readonly string[],
        >;
    } & {
        browser: { default: true; description: string };
        "no-browser": { description: string };
        "show-full-coverage": { description: string };
    } & {
        browser: ConfigOption<"boolean", false, undefined>;
        "no-browser": ConfigOption<"boolean", false, undefined>;
        "show-full-coverage": ConfigOption<"boolean", false, undefined>;
    } & { "coverage-map": { description: string; hint: string } } & {
        "coverage-map": ConfigOption<
            "string",
            false,
            undefined
            | readonly string[],
        >;
    } & {
        "allow-empty-coverage": { description: string };
        "allow-incomplete-coverage": { description: string };
        "disable-coverage": { description: string };
    } & {
        "allow-empty-coverage": ConfigOption<"boolean", false, undefined>;
        "allow-incomplete-coverage": ConfigOption<"boolean", false, undefined>;
        "disable-coverage": ConfigOption<"boolean", false, undefined>;
    } & {
        bail: { description: string; short: string };
        changed: { description: string; short: string };
        color: { description: string; short: string };
        comments: { description: string };
        "fail-only": { description: string };
        "fail-skip": { description: string };
        "fail-todo": { description: string };
        "no-bail": { description: string; short: string };
        "no-color": { description: string; short: string };
        passes: { description: string };
    } & {
        bail: ConfigOption<"boolean", false, undefined>;
        changed: ConfigOption<"boolean", false, undefined>;
        color: ConfigOption<"boolean", false, undefined>;
        comments: ConfigOption<"boolean", false, undefined>;
        "fail-only": ConfigOption<"boolean", false, undefined>;
        "fail-skip": ConfigOption<"boolean", false, undefined>;
        "fail-todo": ConfigOption<"boolean", false, undefined>;
        "no-bail": ConfigOption<"boolean", false, undefined>;
        "no-color": ConfigOption<"boolean", false, undefined>;
        passes: ConfigOption<"boolean", false, undefined>;
    } & { save: { description: string; hint: string; short: string } } & {
        save: ConfigOption<"string", false, undefined | readonly string[]>;
    } & { diag: { description: string }; "no-diag": { description: string } } & {
        diag: ConfigOption<"boolean", false, undefined>;
        "no-diag": ConfigOption<"boolean", false, undefined>;
    } & {
        timeout: {
            default: number;
            description: string;
            hint: string;
            short: string;
        };
    } & {
        timeout: ConfigOption<"number", false, undefined | readonly number[]>;
    } & { files: { description: string; hint: string } } & {
        files: ConfigOption<"string", true, undefined | readonly string[]>;
    } & {
        jobs: {
            default: number;
            description: string;
            hint: string;
            short: string;
        };
    } & { jobs: ConfigOption<"number", false, undefined | readonly number[]> } & {
        after: { description: string; hint: string };
        before: { description: string; hint: string };
        "output-dir": { description: string; hint: string; short: string };
        "output-file": { description: string; hint: string; short: string };
    } & {
        after: ConfigOption<"string", false, undefined | readonly string[]>;
        before: ConfigOption<"string", false, undefined | readonly string[]>;
        "output-dir": ConfigOption<"string", false, undefined | readonly string[]>;
        "output-file": ConfigOption<
            "string",
            false,
            undefined
            | readonly string[],
        >;
    } & {
        exclude: { default: string[]; description: string; hint: string };
        include: { default: string[]; description: string; hint: string };
        "node-arg": { default: never[]; description: string; hint: string };
        serial: { description: string; hint: string };
        "test-arg": { default: never[]; description: string; hint: string };
        "test-env": { default: never[]; description: string; hint: string };
    } & {
        exclude: ConfigOption<"string", true, undefined | readonly string[]>;
        include: ConfigOption<"string", true, undefined | readonly string[]>;
        "node-arg": ConfigOption<"string", true, undefined | readonly string[]>;
        serial: ConfigOption<"string", true, undefined | readonly string[]>;
        "test-arg": ConfigOption<"string", true, undefined | readonly string[]>;
        "test-env": ConfigOption<"string", true, undefined | readonly string[]>;
    } & {
        debug: { description: string };
        help: { description: string; short: string; type: "boolean" };
        "no-omit-whitespace": { description: string };
        "omit-version": { description: string };
        "omit-whitespace": { description: string };
        version: { description: string; short: string };
        versions: { description: string; short: string };
    } & {
        debug: ConfigOption<"boolean", false, undefined>;
        help: ConfigOption<"boolean", false, undefined>;
        "no-omit-whitespace": ConfigOption<"boolean", false, undefined>;
        "omit-version": ConfigOption<"boolean", false, undefined>;
        "omit-whitespace": ConfigOption<"boolean", false, undefined>;
        version: ConfigOption<"boolean", false, undefined>;
        versions: ConfigOption<"boolean", false, undefined>;
    } & {
        only: {
            description: string;
            nodeArgs: (v: boolean) => string[];
            short: string;
            type: string;
        } & ConfigOption<"boolean", false, undefined>;
    } & { only: ConfigOption<"boolean", false, undefined> } & {
        grep: {
            description: string;
            hint: string;
            multiple: boolean;
            nodeArgs: (value: string[]) => string[];
            short: string;
            type: string;
        } & ConfigOption<"string", true, undefined | readonly string[]>;
    } & { grep: ConfigOption<"string", true, undefined | readonly string[]> } & {
        invert: { description: string; short: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { invert: ConfigOption<"boolean", false, undefined> } & {
        "no-invert": { description: string; short: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { "no-invert": ConfigOption<"boolean", false, undefined> } & {
        "filter-quietly": { description: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { "filter-quietly": ConfigOption<"boolean", false, undefined> } & {
        "no-filter-quietly": { description: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { "no-filter-quietly": ConfigOption<"boolean", false, undefined> } & {
        "save-fixture": { description: string; short: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { "save-fixture": ConfigOption<"boolean", false, undefined> } & {
        snapshot: { description: string; short: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { snapshot: ConfigOption<"boolean", false, undefined> } & {
        "snapshot-clean-cwd": {
            default: boolean;
            description: string;
            type: string;
        } & ConfigOption<"boolean", false, undefined>;
    } & { "snapshot-clean-cwd": ConfigOption<"boolean", false, undefined> } & {
        "no-snapshot-clean-cwd": { description: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { "no-snapshot-clean-cwd": ConfigOption<"boolean", false, undefined> } & {
        typecheck: { description: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { typecheck: ConfigOption<"boolean", false, undefined> } & {
        tsconfig: { description: string; type: string } & ConfigOption<
            "string",
            false,
            undefined
            | readonly string[],
        >;
    } & {
        tsconfig: ConfigOption<"string", false, undefined | readonly string[]>;
    } & {
        "type-strip-only": { description: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { "type-strip-only": ConfigOption<"boolean", false, undefined> } & F,
>
Inherited from ReturnType.addFields
- Defined in src/config/src/index.ts:157

editConfigFile

editConfigFile(
    data: OptionsSubset<C>,
    configFile?: undefined | string,
    overwrite?: boolean,
): Promise<void>
load the file, and write the fields in data. If the file is not present, create it.
Parameters
- data: OptionsSubset<C>
- configFile: undefined | string = ...
- overwrite: boolean = false
Returns Promise<void>
Inherited from ReturnType.editConfigFile
- Defined in src/config/src/index.ts:172

editPackageJsonConfig

editPackageJsonConfig(
    data: OptionsSubset<C>,
    configFile: string,
    overwrite?: boolean,
): Promise<void>
Edit the "tap" section of a package.json file
Parameters
- data: OptionsSubset<C>
- configFile: string
- overwrite: boolean = false
Returns Promise<void>
Inherited from ReturnType.editPackageJsonConfig
- Defined in src/config/src/index.ts:221

editYAMLConfig

editYAMLConfig(
    data: OptionsSubset<C>,
    configFile: string,
    overwrite?: boolean,
): Promise<void>
Edit a yaml .taprc file
Parameters
- data: OptionsSubset<C>
- configFile: string
- overwrite: boolean = false
Returns Promise<void>
Inherited from ReturnType.editYAMLConfig
- Defined in src/config/src/index.ts:202

expandInclude

expandInclude(inc: string): string
replace __EXTENSIONS__ in a glob with the actual testFileExtensions
Parameters
- inc: string
Returns string
Inherited from ReturnType.expandInclude
- Defined in src/config/src/index.ts:132

extendConfigData

extendConfigData(data: Record<string, any>, file: string): Promise<void>
Apply the extension from a resolved extends field in the config.
Parameters
- data: Record<string, any>
- file: string
Returns Promise<void>
Inherited from ReturnType.extendConfigData
- Defined in src/config/src/index.ts:373

get

get<
    K extends
        | "plugin"
        | "reporter"
        | "reporter-file"
        | "reporter-arg"
        | "coverage-report"
        | "browser"
        | "no-browser"
        | "show-full-coverage"
        | "coverage-map"
        | "allow-empty-coverage"
        | "allow-incomplete-coverage"
        | "disable-coverage"
        | "bail"
        | "no-bail"
        | "comments"
        | "passes"
        | "fail-todo"
        | "fail-skip"
        | "fail-only"
        | "color"
        | "no-color"
        | "changed"
        | "save"
        | "diag"
        | "no-diag"
        | "timeout"
        | "files"
        | "jobs"
        | "before"
        | "after"
        | "output-file"
        | "output-dir"
        | "include"
        | "exclude"
        | "serial"
        | "test-arg"
        | "test-env"
        | "node-arg"
        | "debug"
        | "omit-version"
        | "omit-whitespace"
        | "no-omit-whitespace"
        | "versions"
        | "version"
        | "help"
        | "only"
        | "grep"
        | "invert"
        | "no-invert"
        | "filter-quietly"
        | "no-filter-quietly"
        | "save-fixture"
        | "snapshot"
        | "snapshot-clean-cwd"
        | "no-snapshot-clean-cwd"
        | "typecheck"
        | "tsconfig"
        | "type-strip-only",
>(
    k: K,
): OptionsResults<
    { plugin: { default: string[]; description: string; hint: string } } & {
        plugin: ConfigOption<"string", true, undefined | readonly string[]>;
    } & {
        reporter: { description: string; hint: string; short: string };
        "reporter-file": { description: string; hint: string; short: string };
    } & {
        reporter: ConfigOption<"string", false, undefined | readonly string[]>;
        "reporter-file": ConfigOption<
            "string",
            false,
            undefined
            | readonly string[],
        >;
    } & {
        "reporter-arg": { description: string; hint: string; short: string };
    } & {
        "reporter-arg": ConfigOption<
            "string",
            true,
            undefined
            | readonly string[],
        >;
    } & {
        "coverage-report": {
            default: string[];
            description: string;
            hint: string;
        };
    } & {
        "coverage-report": ConfigOption<
            "string",
            true,
            undefined
            | readonly string[],
        >;
    } & {
        browser: { default: true; description: string };
        "no-browser": { description: string };
        "show-full-coverage": { description: string };
    } & {
        browser: ConfigOption<"boolean", false, undefined>;
        "no-browser": ConfigOption<"boolean", false, undefined>;
        "show-full-coverage": ConfigOption<"boolean", false, undefined>;
    } & { "coverage-map": { description: string; hint: string } } & {
        "coverage-map": ConfigOption<
            "string",
            false,
            undefined
            | readonly string[],
        >;
    } & {
        "allow-empty-coverage": { description: string };
        "allow-incomplete-coverage": { description: string };
        "disable-coverage": { description: string };
    } & {
        "allow-empty-coverage": ConfigOption<"boolean", false, undefined>;
        "allow-incomplete-coverage": ConfigOption<"boolean", false, undefined>;
        "disable-coverage": ConfigOption<"boolean", false, undefined>;
    } & {
        bail: { description: string; short: string };
        changed: { description: string; short: string };
        color: { description: string; short: string };
        comments: { description: string };
        "fail-only": { description: string };
        "fail-skip": { description: string };
        "fail-todo": { description: string };
        "no-bail": { description: string; short: string };
        "no-color": { description: string; short: string };
        passes: { description: string };
    } & {
        bail: ConfigOption<"boolean", false, undefined>;
        changed: ConfigOption<"boolean", false, undefined>;
        color: ConfigOption<"boolean", false, undefined>;
        comments: ConfigOption<"boolean", false, undefined>;
        "fail-only": ConfigOption<"boolean", false, undefined>;
        "fail-skip": ConfigOption<"boolean", false, undefined>;
        "fail-todo": ConfigOption<"boolean", false, undefined>;
        "no-bail": ConfigOption<"boolean", false, undefined>;
        "no-color": ConfigOption<"boolean", false, undefined>;
        passes: ConfigOption<"boolean", false, undefined>;
    } & { save: { description: string; hint: string; short: string } } & {
        save: ConfigOption<"string", false, undefined | readonly string[]>;
    } & { diag: { description: string }; "no-diag": { description: string } } & {
        diag: ConfigOption<"boolean", false, undefined>;
        "no-diag": ConfigOption<"boolean", false, undefined>;
    } & {
        timeout: {
            default: number;
            description: string;
            hint: string;
            short: string;
        };
    } & {
        timeout: ConfigOption<"number", false, undefined | readonly number[]>;
    } & { files: { description: string; hint: string } } & {
        files: ConfigOption<"string", true, undefined | readonly string[]>;
    } & {
        jobs: {
            default: number;
            description: string;
            hint: string;
            short: string;
        };
    } & { jobs: ConfigOption<"number", false, undefined | readonly number[]> } & {
        after: { description: string; hint: string };
        before: { description: string; hint: string };
        "output-dir": { description: string; hint: string; short: string };
        "output-file": { description: string; hint: string; short: string };
    } & {
        after: ConfigOption<"string", false, undefined | readonly string[]>;
        before: ConfigOption<"string", false, undefined | readonly string[]>;
        "output-dir": ConfigOption<"string", false, undefined | readonly string[]>;
        "output-file": ConfigOption<
            "string",
            false,
            undefined
            | readonly string[],
        >;
    } & {
        exclude: { default: string[]; description: string; hint: string };
        include: { default: string[]; description: string; hint: string };
        "node-arg": { default: never[]; description: string; hint: string };
        serial: { description: string; hint: string };
        "test-arg": { default: never[]; description: string; hint: string };
        "test-env": { default: never[]; description: string; hint: string };
    } & {
        exclude: ConfigOption<"string", true, undefined | readonly string[]>;
        include: ConfigOption<"string", true, undefined | readonly string[]>;
        "node-arg": ConfigOption<"string", true, undefined | readonly string[]>;
        serial: ConfigOption<"string", true, undefined | readonly string[]>;
        "test-arg": ConfigOption<"string", true, undefined | readonly string[]>;
        "test-env": ConfigOption<"string", true, undefined | readonly string[]>;
    } & {
        debug: { description: string };
        help: { description: string; short: string; type: "boolean" };
        "no-omit-whitespace": { description: string };
        "omit-version": { description: string };
        "omit-whitespace": { description: string };
        version: { description: string; short: string };
        versions: { description: string; short: string };
    } & {
        debug: ConfigOption<"boolean", false, undefined>;
        help: ConfigOption<"boolean", false, undefined>;
        "no-omit-whitespace": ConfigOption<"boolean", false, undefined>;
        "omit-version": ConfigOption<"boolean", false, undefined>;
        "omit-whitespace": ConfigOption<"boolean", false, undefined>;
        version: ConfigOption<"boolean", false, undefined>;
        versions: ConfigOption<"boolean", false, undefined>;
    } & {
        only: {
            description: string;
            nodeArgs: (v: boolean) => string[];
            short: string;
            type: string;
        } & ConfigOption<"boolean", false, undefined>;
    } & { only: ConfigOption<"boolean", false, undefined> } & {
        grep: {
            description: string;
            hint: string;
            multiple: boolean;
            nodeArgs: (value: string[]) => string[];
            short: string;
            type: string;
        } & ConfigOption<"string", true, undefined | readonly string[]>;
    } & { grep: ConfigOption<"string", true, undefined | readonly string[]> } & {
        invert: { description: string; short: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { invert: ConfigOption<"boolean", false, undefined> } & {
        "no-invert": { description: string; short: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { "no-invert": ConfigOption<"boolean", false, undefined> } & {
        "filter-quietly": { description: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { "filter-quietly": ConfigOption<"boolean", false, undefined> } & {
        "no-filter-quietly": { description: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { "no-filter-quietly": ConfigOption<"boolean", false, undefined> } & {
        "save-fixture": { description: string; short: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { "save-fixture": ConfigOption<"boolean", false, undefined> } & {
        snapshot: { description: string; short: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { snapshot: ConfigOption<"boolean", false, undefined> } & {
        "snapshot-clean-cwd": {
            default: boolean;
            description: string;
            type: string;
        } & ConfigOption<"boolean", false, undefined>;
    } & { "snapshot-clean-cwd": ConfigOption<"boolean", false, undefined> } & {
        "no-snapshot-clean-cwd": { description: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { "no-snapshot-clean-cwd": ConfigOption<"boolean", false, undefined> } & {
        typecheck: { description: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { typecheck: ConfigOption<"boolean", false, undefined> } & {
        tsconfig: { description: string; type: string } & ConfigOption<
            "string",
            false,
            undefined
            | readonly string[],
        >;
    } & {
        tsconfig: ConfigOption<"string", false, undefined | readonly string[]>;
    } & {
        "type-strip-only": { description: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { "type-strip-only": ConfigOption<"boolean", false, undefined> },
>[K]
Get a configuration value, as we currently know it
Type Parameters
- K extends
      | "plugin"
      | "reporter"
      | "reporter-file"
      | "reporter-arg"
      | "coverage-report"
      | "browser"
      | "no-browser"
      | "show-full-coverage"
      | "coverage-map"
      | "allow-empty-coverage"
      | "allow-incomplete-coverage"
      | "disable-coverage"
      | "bail"
      | "no-bail"
      | "comments"
      | "passes"
      | "fail-todo"
      | "fail-skip"
      | "fail-only"
      | "color"
      | "no-color"
      | "changed"
      | "save"
      | "diag"
      | "no-diag"
      | "timeout"
      | "files"
      | "jobs"
      | "before"
      | "after"
      | "output-file"
      | "output-dir"
      | "include"
      | "exclude"
      | "serial"
      | "test-arg"
      | "test-env"
      | "node-arg"
      | "debug"
      | "omit-version"
      | "omit-whitespace"
      | "no-omit-whitespace"
      | "versions"
      | "version"
      | "help"
      | "only"
      | "grep"
      | "invert"
      | "no-invert"
      | "filter-quietly"
      | "no-filter-quietly"
      | "save-fixture"
      | "snapshot"
      | "snapshot-clean-cwd"
      | "no-snapshot-clean-cwd"
      | "typecheck"
      | "tsconfig"
      | "type-strip-only"
Parameters
- k: K
Returns OptionsResults<
    { plugin: { default: string[]; description: string; hint: string } } & {
        plugin: ConfigOption<"string", true, undefined | readonly string[]>;
    } & {
        reporter: { description: string; hint: string; short: string };
        "reporter-file": { description: string; hint: string; short: string };
    } & {
        reporter: ConfigOption<"string", false, undefined | readonly string[]>;
        "reporter-file": ConfigOption<
            "string",
            false,
            undefined
            | readonly string[],
        >;
    } & {
        "reporter-arg": { description: string; hint: string; short: string };
    } & {
        "reporter-arg": ConfigOption<
            "string",
            true,
            undefined
            | readonly string[],
        >;
    } & {
        "coverage-report": {
            default: string[];
            description: string;
            hint: string;
        };
    } & {
        "coverage-report": ConfigOption<
            "string",
            true,
            undefined
            | readonly string[],
        >;
    } & {
        browser: { default: true; description: string };
        "no-browser": { description: string };
        "show-full-coverage": { description: string };
    } & {
        browser: ConfigOption<"boolean", false, undefined>;
        "no-browser": ConfigOption<"boolean", false, undefined>;
        "show-full-coverage": ConfigOption<"boolean", false, undefined>;
    } & { "coverage-map": { description: string; hint: string } } & {
        "coverage-map": ConfigOption<
            "string",
            false,
            undefined
            | readonly string[],
        >;
    } & {
        "allow-empty-coverage": { description: string };
        "allow-incomplete-coverage": { description: string };
        "disable-coverage": { description: string };
    } & {
        "allow-empty-coverage": ConfigOption<"boolean", false, undefined>;
        "allow-incomplete-coverage": ConfigOption<"boolean", false, undefined>;
        "disable-coverage": ConfigOption<"boolean", false, undefined>;
    } & {
        bail: { description: string; short: string };
        changed: { description: string; short: string };
        color: { description: string; short: string };
        comments: { description: string };
        "fail-only": { description: string };
        "fail-skip": { description: string };
        "fail-todo": { description: string };
        "no-bail": { description: string; short: string };
        "no-color": { description: string; short: string };
        passes: { description: string };
    } & {
        bail: ConfigOption<"boolean", false, undefined>;
        changed: ConfigOption<"boolean", false, undefined>;
        color: ConfigOption<"boolean", false, undefined>;
        comments: ConfigOption<"boolean", false, undefined>;
        "fail-only": ConfigOption<"boolean", false, undefined>;
        "fail-skip": ConfigOption<"boolean", false, undefined>;
        "fail-todo": ConfigOption<"boolean", false, undefined>;
        "no-bail": ConfigOption<"boolean", false, undefined>;
        "no-color": ConfigOption<"boolean", false, undefined>;
        passes: ConfigOption<"boolean", false, undefined>;
    } & { save: { description: string; hint: string; short: string } } & {
        save: ConfigOption<"string", false, undefined | readonly string[]>;
    } & { diag: { description: string }; "no-diag": { description: string } } & {
        diag: ConfigOption<"boolean", false, undefined>;
        "no-diag": ConfigOption<"boolean", false, undefined>;
    } & {
        timeout: {
            default: number;
            description: string;
            hint: string;
            short: string;
        };
    } & {
        timeout: ConfigOption<"number", false, undefined | readonly number[]>;
    } & { files: { description: string; hint: string } } & {
        files: ConfigOption<"string", true, undefined | readonly string[]>;
    } & {
        jobs: {
            default: number;
            description: string;
            hint: string;
            short: string;
        };
    } & { jobs: ConfigOption<"number", false, undefined | readonly number[]> } & {
        after: { description: string; hint: string };
        before: { description: string; hint: string };
        "output-dir": { description: string; hint: string; short: string };
        "output-file": { description: string; hint: string; short: string };
    } & {
        after: ConfigOption<"string", false, undefined | readonly string[]>;
        before: ConfigOption<"string", false, undefined | readonly string[]>;
        "output-dir": ConfigOption<"string", false, undefined | readonly string[]>;
        "output-file": ConfigOption<
            "string",
            false,
            undefined
            | readonly string[],
        >;
    } & {
        exclude: { default: string[]; description: string; hint: string };
        include: { default: string[]; description: string; hint: string };
        "node-arg": { default: never[]; description: string; hint: string };
        serial: { description: string; hint: string };
        "test-arg": { default: never[]; description: string; hint: string };
        "test-env": { default: never[]; description: string; hint: string };
    } & {
        exclude: ConfigOption<"string", true, undefined | readonly string[]>;
        include: ConfigOption<"string", true, undefined | readonly string[]>;
        "node-arg": ConfigOption<"string", true, undefined | readonly string[]>;
        serial: ConfigOption<"string", true, undefined | readonly string[]>;
        "test-arg": ConfigOption<"string", true, undefined | readonly string[]>;
        "test-env": ConfigOption<"string", true, undefined | readonly string[]>;
    } & {
        debug: { description: string };
        help: { description: string; short: string; type: "boolean" };
        "no-omit-whitespace": { description: string };
        "omit-version": { description: string };
        "omit-whitespace": { description: string };
        version: { description: string; short: string };
        versions: { description: string; short: string };
    } & {
        debug: ConfigOption<"boolean", false, undefined>;
        help: ConfigOption<"boolean", false, undefined>;
        "no-omit-whitespace": ConfigOption<"boolean", false, undefined>;
        "omit-version": ConfigOption<"boolean", false, undefined>;
        "omit-whitespace": ConfigOption<"boolean", false, undefined>;
        version: ConfigOption<"boolean", false, undefined>;
        versions: ConfigOption<"boolean", false, undefined>;
    } & {
        only: {
            description: string;
            nodeArgs: (v: boolean) => string[];
            short: string;
            type: string;
        } & ConfigOption<"boolean", false, undefined>;
    } & { only: ConfigOption<"boolean", false, undefined> } & {
        grep: {
            description: string;
            hint: string;
            multiple: boolean;
            nodeArgs: (value: string[]) => string[];
            short: string;
            type: string;
        } & ConfigOption<"string", true, undefined | readonly string[]>;
    } & { grep: ConfigOption<"string", true, undefined | readonly string[]> } & {
        invert: { description: string; short: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { invert: ConfigOption<"boolean", false, undefined> } & {
        "no-invert": { description: string; short: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { "no-invert": ConfigOption<"boolean", false, undefined> } & {
        "filter-quietly": { description: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { "filter-quietly": ConfigOption<"boolean", false, undefined> } & {
        "no-filter-quietly": { description: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { "no-filter-quietly": ConfigOption<"boolean", false, undefined> } & {
        "save-fixture": { description: string; short: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { "save-fixture": ConfigOption<"boolean", false, undefined> } & {
        snapshot: { description: string; short: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { snapshot: ConfigOption<"boolean", false, undefined> } & {
        "snapshot-clean-cwd": {
            default: boolean;
            description: string;
            type: string;
        } & ConfigOption<"boolean", false, undefined>;
    } & { "snapshot-clean-cwd": ConfigOption<"boolean", false, undefined> } & {
        "no-snapshot-clean-cwd": { description: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { "no-snapshot-clean-cwd": ConfigOption<"boolean", false, undefined> } & {
        typecheck: { description: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { typecheck: ConfigOption<"boolean", false, undefined> } & {
        tsconfig: { description: string; type: string } & ConfigOption<
            "string",
            false,
            undefined
            | readonly string[],
        >;
    } & {
        tsconfig: ConfigOption<"string", false, undefined | readonly string[]>;
    } & {
        "type-strip-only": { description: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { "type-strip-only": ConfigOption<"boolean", false, undefined> },
>[K]
Inherited from ReturnType.get
- Defined in src/config/src/index.ts:142

loadColor

loadColor(): Promise<LoadedConfig>
Determine whether the TAP process should show colors. Update chalk accordingly.

Returns Promise<LoadedConfig>
Inherited from ReturnType.loadColor
- Defined in src/config/src/index.ts:516

loadConfigData

loadConfigData(
    data: any,
    configFile: string,
): Promise<
    LoadedConfig & {
        configFile: string;
        valuesFromConfigFile: OptionsResults<C>;
    },
>
Load some configuration fields from a config file
Parameters
- data: any
- configFile: string
Returns Promise<
    LoadedConfig & {
        configFile: string;
        valuesFromConfigFile: OptionsResults<C>;
    },
>
Inherited from ReturnType.loadConfigData
- Defined in src/config/src/index.ts:351

loadConfigFile

loadConfigFile(): Promise<
    LoadedConfig & {
        configFile: string;
        valuesFromConfigFile: OptionsSubset<C>;
    },
>
Load configuration from a file

Returns Promise<
    LoadedConfig & {
        configFile: string;
        valuesFromConfigFile: OptionsSubset<C>;
    },
>
Inherited from ReturnType.loadConfigFile
- Defined in src/config/src/index.ts:419

loadPluginConfigFields

loadPluginConfigFields(): TapConfig<
    { plugin: { default: string[]; description: string; hint: string } } & {
        plugin: ConfigOption<"string", true, undefined | readonly string[]>;
    } & {
        reporter: { description: string; hint: string; short: string };
        "reporter-file": { description: string; hint: string; short: string };
    } & {
        reporter: ConfigOption<"string", false, undefined | readonly string[]>;
        "reporter-file": ConfigOption<
            "string",
            false,
            undefined
            | readonly string[],
        >;
    } & {
        "reporter-arg": { description: string; hint: string; short: string };
    } & {
        "reporter-arg": ConfigOption<
            "string",
            true,
            undefined
            | readonly string[],
        >;
    } & {
        "coverage-report": {
            default: string[];
            description: string;
            hint: string;
        };
    } & {
        "coverage-report": ConfigOption<
            "string",
            true,
            undefined
            | readonly string[],
        >;
    } & {
        browser: { default: true; description: string };
        "no-browser": { description: string };
        "show-full-coverage": { description: string };
    } & {
        browser: ConfigOption<"boolean", false, undefined>;
        "no-browser": ConfigOption<"boolean", false, undefined>;
        "show-full-coverage": ConfigOption<"boolean", false, undefined>;
    } & { "coverage-map": { description: string; hint: string } } & {
        "coverage-map": ConfigOption<
            "string",
            false,
            undefined
            | readonly string[],
        >;
    } & {
        "allow-empty-coverage": { description: string };
        "allow-incomplete-coverage": { description: string };
        "disable-coverage": { description: string };
    } & {
        "allow-empty-coverage": ConfigOption<"boolean", false, undefined>;
        "allow-incomplete-coverage": ConfigOption<"boolean", false, undefined>;
        "disable-coverage": ConfigOption<"boolean", false, undefined>;
    } & {
        bail: { description: string; short: string };
        changed: { description: string; short: string };
        color: { description: string; short: string };
        comments: { description: string };
        "fail-only": { description: string };
        "fail-skip": { description: string };
        "fail-todo": { description: string };
        "no-bail": { description: string; short: string };
        "no-color": { description: string; short: string };
        passes: { description: string };
    } & {
        bail: ConfigOption<"boolean", false, undefined>;
        changed: ConfigOption<"boolean", false, undefined>;
        color: ConfigOption<"boolean", false, undefined>;
        comments: ConfigOption<"boolean", false, undefined>;
        "fail-only": ConfigOption<"boolean", false, undefined>;
        "fail-skip": ConfigOption<"boolean", false, undefined>;
        "fail-todo": ConfigOption<"boolean", false, undefined>;
        "no-bail": ConfigOption<"boolean", false, undefined>;
        "no-color": ConfigOption<"boolean", false, undefined>;
        passes: ConfigOption<"boolean", false, undefined>;
    } & { save: { description: string; hint: string; short: string } } & {
        save: ConfigOption<"string", false, undefined | readonly string[]>;
    } & { diag: { description: string }; "no-diag": { description: string } } & {
        diag: ConfigOption<"boolean", false, undefined>;
        "no-diag": ConfigOption<"boolean", false, undefined>;
    } & {
        timeout: {
            default: number;
            description: string;
            hint: string;
            short: string;
        };
    } & {
        timeout: ConfigOption<"number", false, undefined | readonly number[]>;
    } & { files: { description: string; hint: string } } & {
        files: ConfigOption<"string", true, undefined | readonly string[]>;
    } & {
        jobs: {
            default: number;
            description: string;
            hint: string;
            short: string;
        };
    } & { jobs: ConfigOption<"number", false, undefined | readonly number[]> } & {
        after: { description: string; hint: string };
        before: { description: string; hint: string };
        "output-dir": { description: string; hint: string; short: string };
        "output-file": { description: string; hint: string; short: string };
    } & {
        after: ConfigOption<"string", false, undefined | readonly string[]>;
        before: ConfigOption<"string", false, undefined | readonly string[]>;
        "output-dir": ConfigOption<"string", false, undefined | readonly string[]>;
        "output-file": ConfigOption<
            "string",
            false,
            undefined
            | readonly string[],
        >;
    } & {
        exclude: { default: string[]; description: string; hint: string };
        include: { default: string[]; description: string; hint: string };
        "node-arg": { default: never[]; description: string; hint: string };
        serial: { description: string; hint: string };
        "test-arg": { default: never[]; description: string; hint: string };
        "test-env": { default: never[]; description: string; hint: string };
    } & {
        exclude: ConfigOption<"string", true, undefined | readonly string[]>;
        include: ConfigOption<"string", true, undefined | readonly string[]>;
        "node-arg": ConfigOption<"string", true, undefined | readonly string[]>;
        serial: ConfigOption<"string", true, undefined | readonly string[]>;
        "test-arg": ConfigOption<"string", true, undefined | readonly string[]>;
        "test-env": ConfigOption<"string", true, undefined | readonly string[]>;
    } & {
        debug: { description: string };
        help: { description: string; short: string; type: "boolean" };
        "no-omit-whitespace": { description: string };
        "omit-version": { description: string };
        "omit-whitespace": { description: string };
        version: { description: string; short: string };
        versions: { description: string; short: string };
    } & {
        debug: ConfigOption<"boolean", false, undefined>;
        help: ConfigOption<"boolean", false, undefined>;
        "no-omit-whitespace": ConfigOption<"boolean", false, undefined>;
        "omit-version": ConfigOption<"boolean", false, undefined>;
        "omit-whitespace": ConfigOption<"boolean", false, undefined>;
        version: ConfigOption<"boolean", false, undefined>;
        versions: ConfigOption<"boolean", false, undefined>;
    } & {
        only: {
            description: string;
            nodeArgs: (v: boolean) => string[];
            short: string;
            type: string;
        } & ConfigOption<"boolean", false, undefined>;
    } & { only: ConfigOption<"boolean", false, undefined> } & {
        grep: {
            description: string;
            hint: string;
            multiple: boolean;
            nodeArgs: (value: string[]) => string[];
            short: string;
            type: string;
        } & ConfigOption<"string", true, undefined | readonly string[]>;
    } & { grep: ConfigOption<"string", true, undefined | readonly string[]> } & {
        invert: { description: string; short: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { invert: ConfigOption<"boolean", false, undefined> } & {
        "no-invert": { description: string; short: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { "no-invert": ConfigOption<"boolean", false, undefined> } & {
        "filter-quietly": { description: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { "filter-quietly": ConfigOption<"boolean", false, undefined> } & {
        "no-filter-quietly": { description: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { "no-filter-quietly": ConfigOption<"boolean", false, undefined> } & {
        "save-fixture": { description: string; short: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { "save-fixture": ConfigOption<"boolean", false, undefined> } & {
        snapshot: { description: string; short: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { snapshot: ConfigOption<"boolean", false, undefined> } & {
        "snapshot-clean-cwd": {
            default: boolean;
            description: string;
            type: string;
        } & ConfigOption<"boolean", false, undefined>;
    } & { "snapshot-clean-cwd": ConfigOption<"boolean", false, undefined> } & {
        "no-snapshot-clean-cwd": { description: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { "no-snapshot-clean-cwd": ConfigOption<"boolean", false, undefined> } & {
        typecheck: { description: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { typecheck: ConfigOption<"boolean", false, undefined> } & {
        tsconfig: { description: string; type: string } & ConfigOption<
            "string",
            false,
            undefined
            | readonly string[],
        >;
    } & {
        tsconfig: ConfigOption<"string", false, undefined | readonly string[]>;
    } & {
        "type-strip-only": { description: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { "type-strip-only": ConfigOption<"boolean", false, undefined> },
>
Load configuration fields exported by active plugins

Returns TapConfig<
    { plugin: { default: string[]; description: string; hint: string } } & {
        plugin: ConfigOption<"string", true, undefined | readonly string[]>;
    } & {
        reporter: { description: string; hint: string; short: string };
        "reporter-file": { description: string; hint: string; short: string };
    } & {
        reporter: ConfigOption<"string", false, undefined | readonly string[]>;
        "reporter-file": ConfigOption<
            "string",
            false,
            undefined
            | readonly string[],
        >;
    } & {
        "reporter-arg": { description: string; hint: string; short: string };
    } & {
        "reporter-arg": ConfigOption<
            "string",
            true,
            undefined
            | readonly string[],
        >;
    } & {
        "coverage-report": {
            default: string[];
            description: string;
            hint: string;
        };
    } & {
        "coverage-report": ConfigOption<
            "string",
            true,
            undefined
            | readonly string[],
        >;
    } & {
        browser: { default: true; description: string };
        "no-browser": { description: string };
        "show-full-coverage": { description: string };
    } & {
        browser: ConfigOption<"boolean", false, undefined>;
        "no-browser": ConfigOption<"boolean", false, undefined>;
        "show-full-coverage": ConfigOption<"boolean", false, undefined>;
    } & { "coverage-map": { description: string; hint: string } } & {
        "coverage-map": ConfigOption<
            "string",
            false,
            undefined
            | readonly string[],
        >;
    } & {
        "allow-empty-coverage": { description: string };
        "allow-incomplete-coverage": { description: string };
        "disable-coverage": { description: string };
    } & {
        "allow-empty-coverage": ConfigOption<"boolean", false, undefined>;
        "allow-incomplete-coverage": ConfigOption<"boolean", false, undefined>;
        "disable-coverage": ConfigOption<"boolean", false, undefined>;
    } & {
        bail: { description: string; short: string };
        changed: { description: string; short: string };
        color: { description: string; short: string };
        comments: { description: string };
        "fail-only": { description: string };
        "fail-skip": { description: string };
        "fail-todo": { description: string };
        "no-bail": { description: string; short: string };
        "no-color": { description: string; short: string };
        passes: { description: string };
    } & {
        bail: ConfigOption<"boolean", false, undefined>;
        changed: ConfigOption<"boolean", false, undefined>;
        color: ConfigOption<"boolean", false, undefined>;
        comments: ConfigOption<"boolean", false, undefined>;
        "fail-only": ConfigOption<"boolean", false, undefined>;
        "fail-skip": ConfigOption<"boolean", false, undefined>;
        "fail-todo": ConfigOption<"boolean", false, undefined>;
        "no-bail": ConfigOption<"boolean", false, undefined>;
        "no-color": ConfigOption<"boolean", false, undefined>;
        passes: ConfigOption<"boolean", false, undefined>;
    } & { save: { description: string; hint: string; short: string } } & {
        save: ConfigOption<"string", false, undefined | readonly string[]>;
    } & { diag: { description: string }; "no-diag": { description: string } } & {
        diag: ConfigOption<"boolean", false, undefined>;
        "no-diag": ConfigOption<"boolean", false, undefined>;
    } & {
        timeout: {
            default: number;
            description: string;
            hint: string;
            short: string;
        };
    } & {
        timeout: ConfigOption<"number", false, undefined | readonly number[]>;
    } & { files: { description: string; hint: string } } & {
        files: ConfigOption<"string", true, undefined | readonly string[]>;
    } & {
        jobs: {
            default: number;
            description: string;
            hint: string;
            short: string;
        };
    } & { jobs: ConfigOption<"number", false, undefined | readonly number[]> } & {
        after: { description: string; hint: string };
        before: { description: string; hint: string };
        "output-dir": { description: string; hint: string; short: string };
        "output-file": { description: string; hint: string; short: string };
    } & {
        after: ConfigOption<"string", false, undefined | readonly string[]>;
        before: ConfigOption<"string", false, undefined | readonly string[]>;
        "output-dir": ConfigOption<"string", false, undefined | readonly string[]>;
        "output-file": ConfigOption<
            "string",
            false,
            undefined
            | readonly string[],
        >;
    } & {
        exclude: { default: string[]; description: string; hint: string };
        include: { default: string[]; description: string; hint: string };
        "node-arg": { default: never[]; description: string; hint: string };
        serial: { description: string; hint: string };
        "test-arg": { default: never[]; description: string; hint: string };
        "test-env": { default: never[]; description: string; hint: string };
    } & {
        exclude: ConfigOption<"string", true, undefined | readonly string[]>;
        include: ConfigOption<"string", true, undefined | readonly string[]>;
        "node-arg": ConfigOption<"string", true, undefined | readonly string[]>;
        serial: ConfigOption<"string", true, undefined | readonly string[]>;
        "test-arg": ConfigOption<"string", true, undefined | readonly string[]>;
        "test-env": ConfigOption<"string", true, undefined | readonly string[]>;
    } & {
        debug: { description: string };
        help: { description: string; short: string; type: "boolean" };
        "no-omit-whitespace": { description: string };
        "omit-version": { description: string };
        "omit-whitespace": { description: string };
        version: { description: string; short: string };
        versions: { description: string; short: string };
    } & {
        debug: ConfigOption<"boolean", false, undefined>;
        help: ConfigOption<"boolean", false, undefined>;
        "no-omit-whitespace": ConfigOption<"boolean", false, undefined>;
        "omit-version": ConfigOption<"boolean", false, undefined>;
        "omit-whitespace": ConfigOption<"boolean", false, undefined>;
        version: ConfigOption<"boolean", false, undefined>;
        versions: ConfigOption<"boolean", false, undefined>;
    } & {
        only: {
            description: string;
            nodeArgs: (v: boolean) => string[];
            short: string;
            type: string;
        } & ConfigOption<"boolean", false, undefined>;
    } & { only: ConfigOption<"boolean", false, undefined> } & {
        grep: {
            description: string;
            hint: string;
            multiple: boolean;
            nodeArgs: (value: string[]) => string[];
            short: string;
            type: string;
        } & ConfigOption<"string", true, undefined | readonly string[]>;
    } & { grep: ConfigOption<"string", true, undefined | readonly string[]> } & {
        invert: { description: string; short: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { invert: ConfigOption<"boolean", false, undefined> } & {
        "no-invert": { description: string; short: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { "no-invert": ConfigOption<"boolean", false, undefined> } & {
        "filter-quietly": { description: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { "filter-quietly": ConfigOption<"boolean", false, undefined> } & {
        "no-filter-quietly": { description: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { "no-filter-quietly": ConfigOption<"boolean", false, undefined> } & {
        "save-fixture": { description: string; short: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { "save-fixture": ConfigOption<"boolean", false, undefined> } & {
        snapshot: { description: string; short: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { snapshot: ConfigOption<"boolean", false, undefined> } & {
        "snapshot-clean-cwd": {
            default: boolean;
            description: string;
            type: string;
        } & ConfigOption<"boolean", false, undefined>;
    } & { "snapshot-clean-cwd": ConfigOption<"boolean", false, undefined> } & {
        "no-snapshot-clean-cwd": { description: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { "no-snapshot-clean-cwd": ConfigOption<"boolean", false, undefined> } & {
        typecheck: { description: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { typecheck: ConfigOption<"boolean", false, undefined> } & {
        tsconfig: { description: string; type: string } & ConfigOption<
            "string",
            false,
            undefined
            | readonly string[],
        >;
    } & {
        tsconfig: ConfigOption<"string", false, undefined | readonly string[]>;
    } & {
        "type-strip-only": { description: string; type: string } & ConfigOption<
            "boolean",
            false,
            undefined,
        >;
    } & { "type-strip-only": ConfigOption<"boolean", false, undefined> },
>
Inherited from ReturnType.loadPluginConfigFields
- Defined in src/config/src/index.ts:164

loadReporter

loadReporter(): LoadedConfig
Load the reporter that ought to be used, based on the configured value, the TAP environment variable, and whether or not we have colors enabled.

Returns LoadedConfig
Inherited from ReturnType.loadReporter
- Defined in src/config/src/index.ts:545

parse

parse(
args?: string[],
): LoadedConfig & { positionals: string[]; values: OptionsResults<C> }
Parse the arguments and set configuration and positionals accordingly.
Parameters
- args: string[] = argv
Returns LoadedConfig & { positionals: string[]; values: OptionsResults<C> }
Inherited from ReturnType.parse
- Defined in src/config/src/index.ts:105

readDepConfig

readDepConfig(
    file: string,
): Promise<
    | undefined
    | OptionsSubset<
        { plugin: { default: string[]; description: string; hint: string } } & {
            plugin: ConfigOption<"string", true, undefined | readonly string[]>;
        } & {
            reporter: { description: string; hint: string; short: string };
            "reporter-file": { description: string; hint: string; short: string };
        } & {
            reporter: ConfigOption<"string", false, undefined | readonly string[]>;
            "reporter-file": ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
        } & {
            "reporter-arg": { description: string; hint: string; short: string };
        } & {
            "reporter-arg": ConfigOption<
                "string",
                true,
                undefined
                | readonly string[],
            >;
        } & {
            "coverage-report": {
                default: string[];
                description: string;
                hint: string;
            };
        } & {
            "coverage-report": ConfigOption<
                "string",
                true,
                undefined
                | readonly string[],
            >;
        } & {
            browser: { default: true; description: string };
            "no-browser": { description: string };
            "show-full-coverage": { description: string };
        } & {
            browser: ConfigOption<"boolean", false, undefined>;
            "no-browser": ConfigOption<"boolean", false, undefined>;
            "show-full-coverage": ConfigOption<"boolean", false, undefined>;
        } & { "coverage-map": { description: string; hint: string } } & {
            "coverage-map": ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
        } & {
            "allow-empty-coverage": { description: string };
            "allow-incomplete-coverage": { description: string };
            "disable-coverage": { description: string };
        } & {
            "allow-empty-coverage": ConfigOption<"boolean", false, undefined>;
            "allow-incomplete-coverage": ConfigOption<"boolean", false, undefined>;
            "disable-coverage": ConfigOption<"boolean", false, undefined>;
        } & {
            bail: { description: string; short: string };
            changed: { description: string; short: string };
            color: { description: string; short: string };
            comments: { description: string };
            "fail-only": { description: string };
            "fail-skip": { description: string };
            "fail-todo": { description: string };
            "no-bail": { description: string; short: string };
            "no-color": { description: string; short: string };
            passes: { description: string };
        } & {
            bail: ConfigOption<"boolean", false, undefined>;
            changed: ConfigOption<"boolean", false, undefined>;
            color: ConfigOption<"boolean", false, undefined>;
            comments: ConfigOption<"boolean", false, undefined>;
            "fail-only": ConfigOption<"boolean", false, undefined>;
            "fail-skip": ConfigOption<"boolean", false, undefined>;
            "fail-todo": ConfigOption<"boolean", false, undefined>;
            "no-bail": ConfigOption<"boolean", false, undefined>;
            "no-color": ConfigOption<"boolean", false, undefined>;
            passes: ConfigOption<"boolean", false, undefined>;
        } & { save: { description: string; hint: string; short: string } } & {
            save: ConfigOption<"string", false, undefined | readonly string[]>;
        } & { diag: { description: string }; "no-diag": { description: string } } & {
            diag: ConfigOption<"boolean", false, undefined>;
            "no-diag": ConfigOption<"boolean", false, undefined>;
        } & {
            timeout: {
                default: number;
                description: string;
                hint: string;
                short: string;
            };
        } & {
            timeout: ConfigOption<"number", false, undefined | readonly number[]>;
        } & { files: { description: string; hint: string } } & {
            files: ConfigOption<"string", true, undefined | readonly string[]>;
        } & {
            jobs: {
                default: number;
                description: string;
                hint: string;
                short: string;
            };
        } & { jobs: ConfigOption<"number", false, undefined | readonly number[]> } & {
            after: { description: string; hint: string };
            before: { description: string; hint: string };
            "output-dir": { description: string; hint: string; short: string };
            "output-file": { description: string; hint: string; short: string };
        } & {
            after: ConfigOption<"string", false, undefined | readonly string[]>;
            before: ConfigOption<"string", false, undefined | readonly string[]>;
            "output-dir": ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
            "output-file": ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
        } & {
            exclude: { default: string[]; description: string; hint: string };
            include: { default: string[]; description: string; hint: string };
            "node-arg": { default: never[]; description: string; hint: string };
            serial: { description: string; hint: string };
            "test-arg": { default: never[]; description: string; hint: string };
            "test-env": { default: never[]; description: string; hint: string };
        } & {
            exclude: ConfigOption<"string", true, undefined | readonly string[]>;
            include: ConfigOption<"string", true, undefined | readonly string[]>;
            "node-arg": ConfigOption<"string", true, undefined | readonly string[]>;
            serial: ConfigOption<"string", true, undefined | readonly string[]>;
            "test-arg": ConfigOption<"string", true, undefined | readonly string[]>;
            "test-env": ConfigOption<"string", true, undefined | readonly string[]>;
        } & {
            debug: { description: string };
            help: { description: string; short: string; type: "boolean" };
            "no-omit-whitespace": { description: string };
            "omit-version": { description: string };
            "omit-whitespace": { description: string };
            version: { description: string; short: string };
            versions: { description: string; short: string };
        } & {
            debug: ConfigOption<"boolean", false, undefined>;
            help: ConfigOption<"boolean", false, undefined>;
            "no-omit-whitespace": ConfigOption<"boolean", false, undefined>;
            "omit-version": ConfigOption<"boolean", false, undefined>;
            "omit-whitespace": ConfigOption<"boolean", false, undefined>;
            version: ConfigOption<"boolean", false, undefined>;
            versions: ConfigOption<"boolean", false, undefined>;
        } & {
            only: {
                description: string;
                nodeArgs: (v: boolean) => string[];
                short: string;
                type: string;
            } & ConfigOption<"boolean", false, undefined>;
        } & { only: ConfigOption<"boolean", false, undefined> } & {
            grep: {
                description: string;
                hint: string;
                multiple: boolean;
                nodeArgs: (value: string[]) => string[];
                short: string;
                type: string;
            } & ConfigOption<"string", true, undefined | readonly string[]>;
        } & { grep: ConfigOption<"string", true, undefined | readonly string[]> } & {
            invert: { description: string; short: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { invert: ConfigOption<"boolean", false, undefined> } & {
            "no-invert": { description: string; short: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "no-invert": ConfigOption<"boolean", false, undefined> } & {
            "filter-quietly": { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "filter-quietly": ConfigOption<"boolean", false, undefined> } & {
            "no-filter-quietly": { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "no-filter-quietly": ConfigOption<"boolean", false, undefined> } & {
            "save-fixture": { description: string; short: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "save-fixture": ConfigOption<"boolean", false, undefined> } & {
            snapshot: { description: string; short: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { snapshot: ConfigOption<"boolean", false, undefined> } & {
            "snapshot-clean-cwd": {
                default: boolean;
                description: string;
                type: string;
            } & ConfigOption<"boolean", false, undefined>;
        } & { "snapshot-clean-cwd": ConfigOption<"boolean", false, undefined> } & {
            "no-snapshot-clean-cwd": { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "no-snapshot-clean-cwd": ConfigOption<"boolean", false, undefined> } & {
            typecheck: { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { typecheck: ConfigOption<"boolean", false, undefined> } & {
            tsconfig: { description: string; type: string } & ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
        } & {
            tsconfig: ConfigOption<"string", false, undefined | readonly string[]>;
        } & {
            "type-strip-only": { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "type-strip-only": ConfigOption<"boolean", false, undefined> },
    >,
>
Read the configuration from a dependency
Parameters
- file: string
Returns Promise<
    | undefined
    | OptionsSubset<
        { plugin: { default: string[]; description: string; hint: string } } & {
            plugin: ConfigOption<"string", true, undefined | readonly string[]>;
        } & {
            reporter: { description: string; hint: string; short: string };
            "reporter-file": { description: string; hint: string; short: string };
        } & {
            reporter: ConfigOption<"string", false, undefined | readonly string[]>;
            "reporter-file": ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
        } & {
            "reporter-arg": { description: string; hint: string; short: string };
        } & {
            "reporter-arg": ConfigOption<
                "string",
                true,
                undefined
                | readonly string[],
            >;
        } & {
            "coverage-report": {
                default: string[];
                description: string;
                hint: string;
            };
        } & {
            "coverage-report": ConfigOption<
                "string",
                true,
                undefined
                | readonly string[],
            >;
        } & {
            browser: { default: true; description: string };
            "no-browser": { description: string };
            "show-full-coverage": { description: string };
        } & {
            browser: ConfigOption<"boolean", false, undefined>;
            "no-browser": ConfigOption<"boolean", false, undefined>;
            "show-full-coverage": ConfigOption<"boolean", false, undefined>;
        } & { "coverage-map": { description: string; hint: string } } & {
            "coverage-map": ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
        } & {
            "allow-empty-coverage": { description: string };
            "allow-incomplete-coverage": { description: string };
            "disable-coverage": { description: string };
        } & {
            "allow-empty-coverage": ConfigOption<"boolean", false, undefined>;
            "allow-incomplete-coverage": ConfigOption<"boolean", false, undefined>;
            "disable-coverage": ConfigOption<"boolean", false, undefined>;
        } & {
            bail: { description: string; short: string };
            changed: { description: string; short: string };
            color: { description: string; short: string };
            comments: { description: string };
            "fail-only": { description: string };
            "fail-skip": { description: string };
            "fail-todo": { description: string };
            "no-bail": { description: string; short: string };
            "no-color": { description: string; short: string };
            passes: { description: string };
        } & {
            bail: ConfigOption<"boolean", false, undefined>;
            changed: ConfigOption<"boolean", false, undefined>;
            color: ConfigOption<"boolean", false, undefined>;
            comments: ConfigOption<"boolean", false, undefined>;
            "fail-only": ConfigOption<"boolean", false, undefined>;
            "fail-skip": ConfigOption<"boolean", false, undefined>;
            "fail-todo": ConfigOption<"boolean", false, undefined>;
            "no-bail": ConfigOption<"boolean", false, undefined>;
            "no-color": ConfigOption<"boolean", false, undefined>;
            passes: ConfigOption<"boolean", false, undefined>;
        } & { save: { description: string; hint: string; short: string } } & {
            save: ConfigOption<"string", false, undefined | readonly string[]>;
        } & { diag: { description: string }; "no-diag": { description: string } } & {
            diag: ConfigOption<"boolean", false, undefined>;
            "no-diag": ConfigOption<"boolean", false, undefined>;
        } & {
            timeout: {
                default: number;
                description: string;
                hint: string;
                short: string;
            };
        } & {
            timeout: ConfigOption<"number", false, undefined | readonly number[]>;
        } & { files: { description: string; hint: string } } & {
            files: ConfigOption<"string", true, undefined | readonly string[]>;
        } & {
            jobs: {
                default: number;
                description: string;
                hint: string;
                short: string;
            };
        } & { jobs: ConfigOption<"number", false, undefined | readonly number[]> } & {
            after: { description: string; hint: string };
            before: { description: string; hint: string };
            "output-dir": { description: string; hint: string; short: string };
            "output-file": { description: string; hint: string; short: string };
        } & {
            after: ConfigOption<"string", false, undefined | readonly string[]>;
            before: ConfigOption<"string", false, undefined | readonly string[]>;
            "output-dir": ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
            "output-file": ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
        } & {
            exclude: { default: string[]; description: string; hint: string };
            include: { default: string[]; description: string; hint: string };
            "node-arg": { default: never[]; description: string; hint: string };
            serial: { description: string; hint: string };
            "test-arg": { default: never[]; description: string; hint: string };
            "test-env": { default: never[]; description: string; hint: string };
        } & {
            exclude: ConfigOption<"string", true, undefined | readonly string[]>;
            include: ConfigOption<"string", true, undefined | readonly string[]>;
            "node-arg": ConfigOption<"string", true, undefined | readonly string[]>;
            serial: ConfigOption<"string", true, undefined | readonly string[]>;
            "test-arg": ConfigOption<"string", true, undefined | readonly string[]>;
            "test-env": ConfigOption<"string", true, undefined | readonly string[]>;
        } & {
            debug: { description: string };
            help: { description: string; short: string; type: "boolean" };
            "no-omit-whitespace": { description: string };
            "omit-version": { description: string };
            "omit-whitespace": { description: string };
            version: { description: string; short: string };
            versions: { description: string; short: string };
        } & {
            debug: ConfigOption<"boolean", false, undefined>;
            help: ConfigOption<"boolean", false, undefined>;
            "no-omit-whitespace": ConfigOption<"boolean", false, undefined>;
            "omit-version": ConfigOption<"boolean", false, undefined>;
            "omit-whitespace": ConfigOption<"boolean", false, undefined>;
            version: ConfigOption<"boolean", false, undefined>;
            versions: ConfigOption<"boolean", false, undefined>;
        } & {
            only: {
                description: string;
                nodeArgs: (v: boolean) => string[];
                short: string;
                type: string;
            } & ConfigOption<"boolean", false, undefined>;
        } & { only: ConfigOption<"boolean", false, undefined> } & {
            grep: {
                description: string;
                hint: string;
                multiple: boolean;
                nodeArgs: (value: string[]) => string[];
                short: string;
                type: string;
            } & ConfigOption<"string", true, undefined | readonly string[]>;
        } & { grep: ConfigOption<"string", true, undefined | readonly string[]> } & {
            invert: { description: string; short: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { invert: ConfigOption<"boolean", false, undefined> } & {
            "no-invert": { description: string; short: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "no-invert": ConfigOption<"boolean", false, undefined> } & {
            "filter-quietly": { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "filter-quietly": ConfigOption<"boolean", false, undefined> } & {
            "no-filter-quietly": { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "no-filter-quietly": ConfigOption<"boolean", false, undefined> } & {
            "save-fixture": { description: string; short: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "save-fixture": ConfigOption<"boolean", false, undefined> } & {
            snapshot: { description: string; short: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { snapshot: ConfigOption<"boolean", false, undefined> } & {
            "snapshot-clean-cwd": {
                default: boolean;
                description: string;
                type: string;
            } & ConfigOption<"boolean", false, undefined>;
        } & { "snapshot-clean-cwd": ConfigOption<"boolean", false, undefined> } & {
            "no-snapshot-clean-cwd": { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "no-snapshot-clean-cwd": ConfigOption<"boolean", false, undefined> } & {
            typecheck: { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { typecheck: ConfigOption<"boolean", false, undefined> } & {
            tsconfig: { description: string; type: string } & ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
        } & {
            tsconfig: ConfigOption<"string", false, undefined | readonly string[]>;
        } & {
            "type-strip-only": { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "type-strip-only": ConfigOption<"boolean", false, undefined> },
    >,
>
Inherited from ReturnType.readDepConfig
- Defined in src/config/src/index.ts:314

readPackageJson

readPackageJson(
    pj: string,
    silent?: boolean,
): Promise<
    | undefined
    | {
        tap?: OptionsResults<
            { plugin: { default: string[]; description: string; hint: string } } & {
                plugin: ConfigOption<"string", true, undefined | readonly string[]>;
            } & {
                reporter: { description: string; hint: string; short: string };
                "reporter-file": { description: string; hint: string; short: string };
            } & {
                reporter: ConfigOption<
                    "string",
                    false,
                    undefined
                    | readonly string[],
                >;
                "reporter-file": ConfigOption<
                    "string",
                    false,
                    undefined
                    | readonly string[],
                >;
            } & {
                "reporter-arg": { description: string; hint: string; short: string };
            } & {
                "reporter-arg": ConfigOption<
                    "string",
                    true,
                    undefined
                    | readonly string[],
                >;
            } & {
                "coverage-report": {
                    default: string[];
                    description: string;
                    hint: string;
                };
            } & {
                "coverage-report": ConfigOption<
                    "string",
                    true,
                    undefined
                    | readonly string[],
                >;
            } & {
                browser: { default: true; description: string };
                "no-browser": { description: string };
                "show-full-coverage": { description: string };
            } & {
                browser: ConfigOption<"boolean", false, undefined>;
                "no-browser": ConfigOption<"boolean", false, undefined>;
                "show-full-coverage": ConfigOption<"boolean", false, undefined>;
            } & { "coverage-map": { description: string; hint: string } } & {
                "coverage-map": ConfigOption<
                    "string",
                    false,
                    undefined
                    | readonly string[],
                >;
            } & {
                "allow-empty-coverage": { description: string };
                "allow-incomplete-coverage": { description: string };
                "disable-coverage": { description: string };
            } & {
                "allow-empty-coverage": ConfigOption<"boolean", false, undefined>;
                "allow-incomplete-coverage": ConfigOption<"boolean", false, undefined>;
                "disable-coverage": ConfigOption<"boolean", false, undefined>;
            } & {
                bail: { description: string; short: string };
                changed: { description: string; short: string };
                color: { description: string; short: string };
                comments: { description: string };
                "fail-only": { description: string };
                "fail-skip": { description: string };
                "fail-todo": { description: string };
                "no-bail": { description: string; short: string };
                "no-color": { description: string; short: string };
                passes: { description: string };
            } & {
                bail: ConfigOption<"boolean", false, undefined>;
                changed: ConfigOption<"boolean", false, undefined>;
                color: ConfigOption<"boolean", false, undefined>;
                comments: ConfigOption<"boolean", false, undefined>;
                "fail-only": ConfigOption<"boolean", false, undefined>;
                "fail-skip": ConfigOption<"boolean", false, undefined>;
                "fail-todo": ConfigOption<"boolean", false, undefined>;
                "no-bail": ConfigOption<"boolean", false, undefined>;
                "no-color": ConfigOption<"boolean", false, undefined>;
                passes: ConfigOption<"boolean", false, undefined>;
            } & { save: { description: string; hint: string; short: string } } & {
                save: ConfigOption<"string", false, undefined | readonly string[]>;
            } & { diag: { description: string }; "no-diag": { description: string } } & {
                diag: ConfigOption<"boolean", false, undefined>;
                "no-diag": ConfigOption<"boolean", false, undefined>;
            } & {
                timeout: {
                    default: number;
                    description: string;
                    hint: string;
                    short: string;
                };
            } & {
                timeout: ConfigOption<"number", false, undefined | readonly number[]>;
            } & { files: { description: string; hint: string } } & {
                files: ConfigOption<"string", true, undefined | readonly string[]>;
            } & {
                jobs: {
                    default: number;
                    description: string;
                    hint: string;
                    short: string;
                };
            } & {
                jobs: ConfigOption<"number", false, undefined | readonly number[]>;
            } & {
                after: { description: string; hint: string };
                before: { description: string; hint: string };
                "output-dir": { description: string; hint: string; short: string };
                "output-file": { description: string; hint: string; short: string };
            } & {
                after: ConfigOption<"string", false, undefined | readonly string[]>;
                before: ConfigOption<"string", false, undefined | readonly string[]>;
                "output-dir": ConfigOption<
                    "string",
                    false,
                    undefined
                    | readonly string[],
                >;
                "output-file": ConfigOption<
                    "string",
                    false,
                    undefined
                    | readonly string[],
                >;
            } & {
                exclude: { default: string[]; description: string; hint: string };
                include: { default: string[]; description: string; hint: string };
                "node-arg": { default: never[]; description: string; hint: string };
                serial: { description: string; hint: string };
                "test-arg": { default: never[]; description: string; hint: string };
                "test-env": { default: never[]; description: string; hint: string };
            } & {
                exclude: ConfigOption<"string", true, undefined | readonly string[]>;
                include: ConfigOption<"string", true, undefined | readonly string[]>;
                "node-arg": ConfigOption<"string", true, undefined | readonly string[]>;
                serial: ConfigOption<"string", true, undefined | readonly string[]>;
                "test-arg": ConfigOption<"string", true, undefined | readonly string[]>;
                "test-env": ConfigOption<"string", true, undefined | readonly string[]>;
            } & {
                debug: { description: string };
                help: { description: string; short: string; type: "boolean" };
                "no-omit-whitespace": { description: string };
                "omit-version": { description: string };
                "omit-whitespace": { description: string };
                version: { description: string; short: string };
                versions: { description: string; short: string };
            } & {
                debug: ConfigOption<"boolean", false, undefined>;
                help: ConfigOption<"boolean", false, undefined>;
                "no-omit-whitespace": ConfigOption<"boolean", false, undefined>;
                "omit-version": ConfigOption<"boolean", false, undefined>;
                "omit-whitespace": ConfigOption<"boolean", false, undefined>;
                version: ConfigOption<"boolean", false, undefined>;
                versions: ConfigOption<"boolean", false, undefined>;
            } & {
                only: {
                    description: string;
                    nodeArgs: (v: boolean) => (...)[];
                    short: string;
                    type: string;
                } & ConfigOption<"boolean", false, undefined>;
            } & { only: ConfigOption<"boolean", false, undefined> } & {
                grep: {
                    description: string;
                    hint: string;
                    multiple: boolean;
                    nodeArgs: (value: (...)[]) => (...)[];
                    short: string;
                    type: string;
                } & ConfigOption<"string", true, undefined | readonly (...)[]>;
            } & { grep: ConfigOption<"string", true, undefined | readonly string[]> } & {
                invert: { description: string; short: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { invert: ConfigOption<"boolean", false, undefined> } & {
                "no-invert": { description: string; short: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { "no-invert": ConfigOption<"boolean", false, undefined> } & {
                "filter-quietly": { description: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { "filter-quietly": ConfigOption<"boolean", false, undefined> } & {
                "no-filter-quietly": { description: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { "no-filter-quietly": ConfigOption<"boolean", false, undefined> } & {
                "save-fixture": { description: string; short: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { "save-fixture": ConfigOption<"boolean", false, undefined> } & {
                snapshot: { description: string; short: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { snapshot: ConfigOption<"boolean", false, undefined> } & {
                "snapshot-clean-cwd": {
                    default: boolean;
                    description: string;
                    type: string;
                } & ConfigOption<"boolean", false, undefined>;
            } & { "snapshot-clean-cwd": ConfigOption<"boolean", false, undefined> } & {
                "no-snapshot-clean-cwd": { description: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & {
                "no-snapshot-clean-cwd": ConfigOption<"boolean", false, undefined>;
            } & {
                typecheck: { description: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { typecheck: ConfigOption<"boolean", false, undefined> } & {
                tsconfig: { description: string; type: string } & ConfigOption<
                    "string",
                    false,
                    undefined
                    | readonly (...)[],
                >;
            } & {
                tsconfig: ConfigOption<
                    "string",
                    false,
                    undefined
                    | readonly string[],
                >;
            } & {
                "type-strip-only": { description: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { "type-strip-only": ConfigOption<"boolean", false, undefined> },
        >;
    },
>
Read a package.json file
Parameters
- pj: string
- silent: boolean = false
Returns Promise<
    | undefined
    | {
        tap?: OptionsResults<
            { plugin: { default: string[]; description: string; hint: string } } & {
                plugin: ConfigOption<"string", true, undefined | readonly string[]>;
            } & {
                reporter: { description: string; hint: string; short: string };
                "reporter-file": { description: string; hint: string; short: string };
            } & {
                reporter: ConfigOption<
                    "string",
                    false,
                    undefined
                    | readonly string[],
                >;
                "reporter-file": ConfigOption<
                    "string",
                    false,
                    undefined
                    | readonly string[],
                >;
            } & {
                "reporter-arg": { description: string; hint: string; short: string };
            } & {
                "reporter-arg": ConfigOption<
                    "string",
                    true,
                    undefined
                    | readonly string[],
                >;
            } & {
                "coverage-report": {
                    default: string[];
                    description: string;
                    hint: string;
                };
            } & {
                "coverage-report": ConfigOption<
                    "string",
                    true,
                    undefined
                    | readonly string[],
                >;
            } & {
                browser: { default: true; description: string };
                "no-browser": { description: string };
                "show-full-coverage": { description: string };
            } & {
                browser: ConfigOption<"boolean", false, undefined>;
                "no-browser": ConfigOption<"boolean", false, undefined>;
                "show-full-coverage": ConfigOption<"boolean", false, undefined>;
            } & { "coverage-map": { description: string; hint: string } } & {
                "coverage-map": ConfigOption<
                    "string",
                    false,
                    undefined
                    | readonly string[],
                >;
            } & {
                "allow-empty-coverage": { description: string };
                "allow-incomplete-coverage": { description: string };
                "disable-coverage": { description: string };
            } & {
                "allow-empty-coverage": ConfigOption<"boolean", false, undefined>;
                "allow-incomplete-coverage": ConfigOption<"boolean", false, undefined>;
                "disable-coverage": ConfigOption<"boolean", false, undefined>;
            } & {
                bail: { description: string; short: string };
                changed: { description: string; short: string };
                color: { description: string; short: string };
                comments: { description: string };
                "fail-only": { description: string };
                "fail-skip": { description: string };
                "fail-todo": { description: string };
                "no-bail": { description: string; short: string };
                "no-color": { description: string; short: string };
                passes: { description: string };
            } & {
                bail: ConfigOption<"boolean", false, undefined>;
                changed: ConfigOption<"boolean", false, undefined>;
                color: ConfigOption<"boolean", false, undefined>;
                comments: ConfigOption<"boolean", false, undefined>;
                "fail-only": ConfigOption<"boolean", false, undefined>;
                "fail-skip": ConfigOption<"boolean", false, undefined>;
                "fail-todo": ConfigOption<"boolean", false, undefined>;
                "no-bail": ConfigOption<"boolean", false, undefined>;
                "no-color": ConfigOption<"boolean", false, undefined>;
                passes: ConfigOption<"boolean", false, undefined>;
            } & { save: { description: string; hint: string; short: string } } & {
                save: ConfigOption<"string", false, undefined | readonly string[]>;
            } & { diag: { description: string }; "no-diag": { description: string } } & {
                diag: ConfigOption<"boolean", false, undefined>;
                "no-diag": ConfigOption<"boolean", false, undefined>;
            } & {
                timeout: {
                    default: number;
                    description: string;
                    hint: string;
                    short: string;
                };
            } & {
                timeout: ConfigOption<"number", false, undefined | readonly number[]>;
            } & { files: { description: string; hint: string } } & {
                files: ConfigOption<"string", true, undefined | readonly string[]>;
            } & {
                jobs: {
                    default: number;
                    description: string;
                    hint: string;
                    short: string;
                };
            } & {
                jobs: ConfigOption<"number", false, undefined | readonly number[]>;
            } & {
                after: { description: string; hint: string };
                before: { description: string; hint: string };
                "output-dir": { description: string; hint: string; short: string };
                "output-file": { description: string; hint: string; short: string };
            } & {
                after: ConfigOption<"string", false, undefined | readonly string[]>;
                before: ConfigOption<"string", false, undefined | readonly string[]>;
                "output-dir": ConfigOption<
                    "string",
                    false,
                    undefined
                    | readonly string[],
                >;
                "output-file": ConfigOption<
                    "string",
                    false,
                    undefined
                    | readonly string[],
                >;
            } & {
                exclude: { default: string[]; description: string; hint: string };
                include: { default: string[]; description: string; hint: string };
                "node-arg": { default: never[]; description: string; hint: string };
                serial: { description: string; hint: string };
                "test-arg": { default: never[]; description: string; hint: string };
                "test-env": { default: never[]; description: string; hint: string };
            } & {
                exclude: ConfigOption<"string", true, undefined | readonly string[]>;
                include: ConfigOption<"string", true, undefined | readonly string[]>;
                "node-arg": ConfigOption<"string", true, undefined | readonly string[]>;
                serial: ConfigOption<"string", true, undefined | readonly string[]>;
                "test-arg": ConfigOption<"string", true, undefined | readonly string[]>;
                "test-env": ConfigOption<"string", true, undefined | readonly string[]>;
            } & {
                debug: { description: string };
                help: { description: string; short: string; type: "boolean" };
                "no-omit-whitespace": { description: string };
                "omit-version": { description: string };
                "omit-whitespace": { description: string };
                version: { description: string; short: string };
                versions: { description: string; short: string };
            } & {
                debug: ConfigOption<"boolean", false, undefined>;
                help: ConfigOption<"boolean", false, undefined>;
                "no-omit-whitespace": ConfigOption<"boolean", false, undefined>;
                "omit-version": ConfigOption<"boolean", false, undefined>;
                "omit-whitespace": ConfigOption<"boolean", false, undefined>;
                version: ConfigOption<"boolean", false, undefined>;
                versions: ConfigOption<"boolean", false, undefined>;
            } & {
                only: {
                    description: string;
                    nodeArgs: (v: boolean) => (...)[];
                    short: string;
                    type: string;
                } & ConfigOption<"boolean", false, undefined>;
            } & { only: ConfigOption<"boolean", false, undefined> } & {
                grep: {
                    description: string;
                    hint: string;
                    multiple: boolean;
                    nodeArgs: (value: (...)[]) => (...)[];
                    short: string;
                    type: string;
                } & ConfigOption<"string", true, undefined | readonly (...)[]>;
            } & { grep: ConfigOption<"string", true, undefined | readonly string[]> } & {
                invert: { description: string; short: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { invert: ConfigOption<"boolean", false, undefined> } & {
                "no-invert": { description: string; short: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { "no-invert": ConfigOption<"boolean", false, undefined> } & {
                "filter-quietly": { description: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { "filter-quietly": ConfigOption<"boolean", false, undefined> } & {
                "no-filter-quietly": { description: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { "no-filter-quietly": ConfigOption<"boolean", false, undefined> } & {
                "save-fixture": { description: string; short: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { "save-fixture": ConfigOption<"boolean", false, undefined> } & {
                snapshot: { description: string; short: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { snapshot: ConfigOption<"boolean", false, undefined> } & {
                "snapshot-clean-cwd": {
                    default: boolean;
                    description: string;
                    type: string;
                } & ConfigOption<"boolean", false, undefined>;
            } & { "snapshot-clean-cwd": ConfigOption<"boolean", false, undefined> } & {
                "no-snapshot-clean-cwd": { description: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & {
                "no-snapshot-clean-cwd": ConfigOption<"boolean", false, undefined>;
            } & {
                typecheck: { description: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { typecheck: ConfigOption<"boolean", false, undefined> } & {
                tsconfig: { description: string; type: string } & ConfigOption<
                    "string",
                    false,
                    undefined
                    | readonly (...)[],
                >;
            } & {
                tsconfig: ConfigOption<
                    "string",
                    false,
                    undefined
                    | readonly string[],
                >;
            } & {
                "type-strip-only": { description: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { "type-strip-only": ConfigOption<"boolean", false, undefined> },
        >;
    },
>
Inherited from ReturnType.readPackageJson
- Defined in src/config/src/index.ts:262

readPackageJsonConfig

readPackageJsonConfig(
    pj: string,
): Promise<
    | undefined
    | OptionsSubset<
        { plugin: { default: string[]; description: string; hint: string } } & {
            plugin: ConfigOption<"string", true, undefined | readonly string[]>;
        } & {
            reporter: { description: string; hint: string; short: string };
            "reporter-file": { description: string; hint: string; short: string };
        } & {
            reporter: ConfigOption<"string", false, undefined | readonly string[]>;
            "reporter-file": ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
        } & {
            "reporter-arg": { description: string; hint: string; short: string };
        } & {
            "reporter-arg": ConfigOption<
                "string",
                true,
                undefined
                | readonly string[],
            >;
        } & {
            "coverage-report": {
                default: string[];
                description: string;
                hint: string;
            };
        } & {
            "coverage-report": ConfigOption<
                "string",
                true,
                undefined
                | readonly string[],
            >;
        } & {
            browser: { default: true; description: string };
            "no-browser": { description: string };
            "show-full-coverage": { description: string };
        } & {
            browser: ConfigOption<"boolean", false, undefined>;
            "no-browser": ConfigOption<"boolean", false, undefined>;
            "show-full-coverage": ConfigOption<"boolean", false, undefined>;
        } & { "coverage-map": { description: string; hint: string } } & {
            "coverage-map": ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
        } & {
            "allow-empty-coverage": { description: string };
            "allow-incomplete-coverage": { description: string };
            "disable-coverage": { description: string };
        } & {
            "allow-empty-coverage": ConfigOption<"boolean", false, undefined>;
            "allow-incomplete-coverage": ConfigOption<"boolean", false, undefined>;
            "disable-coverage": ConfigOption<"boolean", false, undefined>;
        } & {
            bail: { description: string; short: string };
            changed: { description: string; short: string };
            color: { description: string; short: string };
            comments: { description: string };
            "fail-only": { description: string };
            "fail-skip": { description: string };
            "fail-todo": { description: string };
            "no-bail": { description: string; short: string };
            "no-color": { description: string; short: string };
            passes: { description: string };
        } & {
            bail: ConfigOption<"boolean", false, undefined>;
            changed: ConfigOption<"boolean", false, undefined>;
            color: ConfigOption<"boolean", false, undefined>;
            comments: ConfigOption<"boolean", false, undefined>;
            "fail-only": ConfigOption<"boolean", false, undefined>;
            "fail-skip": ConfigOption<"boolean", false, undefined>;
            "fail-todo": ConfigOption<"boolean", false, undefined>;
            "no-bail": ConfigOption<"boolean", false, undefined>;
            "no-color": ConfigOption<"boolean", false, undefined>;
            passes: ConfigOption<"boolean", false, undefined>;
        } & { save: { description: string; hint: string; short: string } } & {
            save: ConfigOption<"string", false, undefined | readonly string[]>;
        } & { diag: { description: string }; "no-diag": { description: string } } & {
            diag: ConfigOption<"boolean", false, undefined>;
            "no-diag": ConfigOption<"boolean", false, undefined>;
        } & {
            timeout: {
                default: number;
                description: string;
                hint: string;
                short: string;
            };
        } & {
            timeout: ConfigOption<"number", false, undefined | readonly number[]>;
        } & { files: { description: string; hint: string } } & {
            files: ConfigOption<"string", true, undefined | readonly string[]>;
        } & {
            jobs: {
                default: number;
                description: string;
                hint: string;
                short: string;
            };
        } & { jobs: ConfigOption<"number", false, undefined | readonly number[]> } & {
            after: { description: string; hint: string };
            before: { description: string; hint: string };
            "output-dir": { description: string; hint: string; short: string };
            "output-file": { description: string; hint: string; short: string };
        } & {
            after: ConfigOption<"string", false, undefined | readonly string[]>;
            before: ConfigOption<"string", false, undefined | readonly string[]>;
            "output-dir": ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
            "output-file": ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
        } & {
            exclude: { default: string[]; description: string; hint: string };
            include: { default: string[]; description: string; hint: string };
            "node-arg": { default: never[]; description: string; hint: string };
            serial: { description: string; hint: string };
            "test-arg": { default: never[]; description: string; hint: string };
            "test-env": { default: never[]; description: string; hint: string };
        } & {
            exclude: ConfigOption<"string", true, undefined | readonly string[]>;
            include: ConfigOption<"string", true, undefined | readonly string[]>;
            "node-arg": ConfigOption<"string", true, undefined | readonly string[]>;
            serial: ConfigOption<"string", true, undefined | readonly string[]>;
            "test-arg": ConfigOption<"string", true, undefined | readonly string[]>;
            "test-env": ConfigOption<"string", true, undefined | readonly string[]>;
        } & {
            debug: { description: string };
            help: { description: string; short: string; type: "boolean" };
            "no-omit-whitespace": { description: string };
            "omit-version": { description: string };
            "omit-whitespace": { description: string };
            version: { description: string; short: string };
            versions: { description: string; short: string };
        } & {
            debug: ConfigOption<"boolean", false, undefined>;
            help: ConfigOption<"boolean", false, undefined>;
            "no-omit-whitespace": ConfigOption<"boolean", false, undefined>;
            "omit-version": ConfigOption<"boolean", false, undefined>;
            "omit-whitespace": ConfigOption<"boolean", false, undefined>;
            version: ConfigOption<"boolean", false, undefined>;
            versions: ConfigOption<"boolean", false, undefined>;
        } & {
            only: {
                description: string;
                nodeArgs: (v: boolean) => string[];
                short: string;
                type: string;
            } & ConfigOption<"boolean", false, undefined>;
        } & { only: ConfigOption<"boolean", false, undefined> } & {
            grep: {
                description: string;
                hint: string;
                multiple: boolean;
                nodeArgs: (value: string[]) => string[];
                short: string;
                type: string;
            } & ConfigOption<"string", true, undefined | readonly string[]>;
        } & { grep: ConfigOption<"string", true, undefined | readonly string[]> } & {
            invert: { description: string; short: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { invert: ConfigOption<"boolean", false, undefined> } & {
            "no-invert": { description: string; short: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "no-invert": ConfigOption<"boolean", false, undefined> } & {
            "filter-quietly": { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "filter-quietly": ConfigOption<"boolean", false, undefined> } & {
            "no-filter-quietly": { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "no-filter-quietly": ConfigOption<"boolean", false, undefined> } & {
            "save-fixture": { description: string; short: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "save-fixture": ConfigOption<"boolean", false, undefined> } & {
            snapshot: { description: string; short: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { snapshot: ConfigOption<"boolean", false, undefined> } & {
            "snapshot-clean-cwd": {
                default: boolean;
                description: string;
                type: string;
            } & ConfigOption<"boolean", false, undefined>;
        } & { "snapshot-clean-cwd": ConfigOption<"boolean", false, undefined> } & {
            "no-snapshot-clean-cwd": { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "no-snapshot-clean-cwd": ConfigOption<"boolean", false, undefined> } & {
            typecheck: { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { typecheck: ConfigOption<"boolean", false, undefined> } & {
            tsconfig: { description: string; type: string } & ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
        } & {
            tsconfig: ConfigOption<"string", false, undefined | readonly string[]>;
        } & {
            "type-strip-only": { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "type-strip-only": ConfigOption<"boolean", false, undefined> },
    >,
>
Read the configuration from the "tap" object in a package.json file
Parameters
- pj: string
Returns Promise<
    | undefined
    | OptionsSubset<
        { plugin: { default: string[]; description: string; hint: string } } & {
            plugin: ConfigOption<"string", true, undefined | readonly string[]>;
        } & {
            reporter: { description: string; hint: string; short: string };
            "reporter-file": { description: string; hint: string; short: string };
        } & {
            reporter: ConfigOption<"string", false, undefined | readonly string[]>;
            "reporter-file": ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
        } & {
            "reporter-arg": { description: string; hint: string; short: string };
        } & {
            "reporter-arg": ConfigOption<
                "string",
                true,
                undefined
                | readonly string[],
            >;
        } & {
            "coverage-report": {
                default: string[];
                description: string;
                hint: string;
            };
        } & {
            "coverage-report": ConfigOption<
                "string",
                true,
                undefined
                | readonly string[],
            >;
        } & {
            browser: { default: true; description: string };
            "no-browser": { description: string };
            "show-full-coverage": { description: string };
        } & {
            browser: ConfigOption<"boolean", false, undefined>;
            "no-browser": ConfigOption<"boolean", false, undefined>;
            "show-full-coverage": ConfigOption<"boolean", false, undefined>;
        } & { "coverage-map": { description: string; hint: string } } & {
            "coverage-map": ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
        } & {
            "allow-empty-coverage": { description: string };
            "allow-incomplete-coverage": { description: string };
            "disable-coverage": { description: string };
        } & {
            "allow-empty-coverage": ConfigOption<"boolean", false, undefined>;
            "allow-incomplete-coverage": ConfigOption<"boolean", false, undefined>;
            "disable-coverage": ConfigOption<"boolean", false, undefined>;
        } & {
            bail: { description: string; short: string };
            changed: { description: string; short: string };
            color: { description: string; short: string };
            comments: { description: string };
            "fail-only": { description: string };
            "fail-skip": { description: string };
            "fail-todo": { description: string };
            "no-bail": { description: string; short: string };
            "no-color": { description: string; short: string };
            passes: { description: string };
        } & {
            bail: ConfigOption<"boolean", false, undefined>;
            changed: ConfigOption<"boolean", false, undefined>;
            color: ConfigOption<"boolean", false, undefined>;
            comments: ConfigOption<"boolean", false, undefined>;
            "fail-only": ConfigOption<"boolean", false, undefined>;
            "fail-skip": ConfigOption<"boolean", false, undefined>;
            "fail-todo": ConfigOption<"boolean", false, undefined>;
            "no-bail": ConfigOption<"boolean", false, undefined>;
            "no-color": ConfigOption<"boolean", false, undefined>;
            passes: ConfigOption<"boolean", false, undefined>;
        } & { save: { description: string; hint: string; short: string } } & {
            save: ConfigOption<"string", false, undefined | readonly string[]>;
        } & { diag: { description: string }; "no-diag": { description: string } } & {
            diag: ConfigOption<"boolean", false, undefined>;
            "no-diag": ConfigOption<"boolean", false, undefined>;
        } & {
            timeout: {
                default: number;
                description: string;
                hint: string;
                short: string;
            };
        } & {
            timeout: ConfigOption<"number", false, undefined | readonly number[]>;
        } & { files: { description: string; hint: string } } & {
            files: ConfigOption<"string", true, undefined | readonly string[]>;
        } & {
            jobs: {
                default: number;
                description: string;
                hint: string;
                short: string;
            };
        } & { jobs: ConfigOption<"number", false, undefined | readonly number[]> } & {
            after: { description: string; hint: string };
            before: { description: string; hint: string };
            "output-dir": { description: string; hint: string; short: string };
            "output-file": { description: string; hint: string; short: string };
        } & {
            after: ConfigOption<"string", false, undefined | readonly string[]>;
            before: ConfigOption<"string", false, undefined | readonly string[]>;
            "output-dir": ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
            "output-file": ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
        } & {
            exclude: { default: string[]; description: string; hint: string };
            include: { default: string[]; description: string; hint: string };
            "node-arg": { default: never[]; description: string; hint: string };
            serial: { description: string; hint: string };
            "test-arg": { default: never[]; description: string; hint: string };
            "test-env": { default: never[]; description: string; hint: string };
        } & {
            exclude: ConfigOption<"string", true, undefined | readonly string[]>;
            include: ConfigOption<"string", true, undefined | readonly string[]>;
            "node-arg": ConfigOption<"string", true, undefined | readonly string[]>;
            serial: ConfigOption<"string", true, undefined | readonly string[]>;
            "test-arg": ConfigOption<"string", true, undefined | readonly string[]>;
            "test-env": ConfigOption<"string", true, undefined | readonly string[]>;
        } & {
            debug: { description: string };
            help: { description: string; short: string; type: "boolean" };
            "no-omit-whitespace": { description: string };
            "omit-version": { description: string };
            "omit-whitespace": { description: string };
            version: { description: string; short: string };
            versions: { description: string; short: string };
        } & {
            debug: ConfigOption<"boolean", false, undefined>;
            help: ConfigOption<"boolean", false, undefined>;
            "no-omit-whitespace": ConfigOption<"boolean", false, undefined>;
            "omit-version": ConfigOption<"boolean", false, undefined>;
            "omit-whitespace": ConfigOption<"boolean", false, undefined>;
            version: ConfigOption<"boolean", false, undefined>;
            versions: ConfigOption<"boolean", false, undefined>;
        } & {
            only: {
                description: string;
                nodeArgs: (v: boolean) => string[];
                short: string;
                type: string;
            } & ConfigOption<"boolean", false, undefined>;
        } & { only: ConfigOption<"boolean", false, undefined> } & {
            grep: {
                description: string;
                hint: string;
                multiple: boolean;
                nodeArgs: (value: string[]) => string[];
                short: string;
                type: string;
            } & ConfigOption<"string", true, undefined | readonly string[]>;
        } & { grep: ConfigOption<"string", true, undefined | readonly string[]> } & {
            invert: { description: string; short: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { invert: ConfigOption<"boolean", false, undefined> } & {
            "no-invert": { description: string; short: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "no-invert": ConfigOption<"boolean", false, undefined> } & {
            "filter-quietly": { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "filter-quietly": ConfigOption<"boolean", false, undefined> } & {
            "no-filter-quietly": { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "no-filter-quietly": ConfigOption<"boolean", false, undefined> } & {
            "save-fixture": { description: string; short: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "save-fixture": ConfigOption<"boolean", false, undefined> } & {
            snapshot: { description: string; short: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { snapshot: ConfigOption<"boolean", false, undefined> } & {
            "snapshot-clean-cwd": {
                default: boolean;
                description: string;
                type: string;
            } & ConfigOption<"boolean", false, undefined>;
        } & { "snapshot-clean-cwd": ConfigOption<"boolean", false, undefined> } & {
            "no-snapshot-clean-cwd": { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "no-snapshot-clean-cwd": ConfigOption<"boolean", false, undefined> } & {
            typecheck: { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { typecheck: ConfigOption<"boolean", false, undefined> } & {
            tsconfig: { description: string; type: string } & ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
        } & {
            tsconfig: ConfigOption<"string", false, undefined | readonly string[]>;
        } & {
            "type-strip-only": { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "type-strip-only": ConfigOption<"boolean", false, undefined> },
    >,
>
Inherited from ReturnType.readPackageJsonConfig
- Defined in src/config/src/index.ts:285

readYAMLConfig

readYAMLConfig(
    rc: string,
    silent?: boolean,
): Promise<
    | undefined
    | ConfigFileData<
        { plugin: { default: string[]; description: string; hint: string } } & {
            plugin: ConfigOption<"string", true, undefined | readonly string[]>;
        } & {
            reporter: { description: string; hint: string; short: string };
            "reporter-file": { description: string; hint: string; short: string };
        } & {
            reporter: ConfigOption<"string", false, undefined | readonly string[]>;
            "reporter-file": ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
        } & {
            "reporter-arg": { description: string; hint: string; short: string };
        } & {
            "reporter-arg": ConfigOption<
                "string",
                true,
                undefined
                | readonly string[],
            >;
        } & {
            "coverage-report": {
                default: string[];
                description: string;
                hint: string;
            };
        } & {
            "coverage-report": ConfigOption<
                "string",
                true,
                undefined
                | readonly string[],
            >;
        } & {
            browser: { default: true; description: string };
            "no-browser": { description: string };
            "show-full-coverage": { description: string };
        } & {
            browser: ConfigOption<"boolean", false, undefined>;
            "no-browser": ConfigOption<"boolean", false, undefined>;
            "show-full-coverage": ConfigOption<"boolean", false, undefined>;
        } & { "coverage-map": { description: string; hint: string } } & {
            "coverage-map": ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
        } & {
            "allow-empty-coverage": { description: string };
            "allow-incomplete-coverage": { description: string };
            "disable-coverage": { description: string };
        } & {
            "allow-empty-coverage": ConfigOption<"boolean", false, undefined>;
            "allow-incomplete-coverage": ConfigOption<"boolean", false, undefined>;
            "disable-coverage": ConfigOption<"boolean", false, undefined>;
        } & {
            bail: { description: string; short: string };
            changed: { description: string; short: string };
            color: { description: string; short: string };
            comments: { description: string };
            "fail-only": { description: string };
            "fail-skip": { description: string };
            "fail-todo": { description: string };
            "no-bail": { description: string; short: string };
            "no-color": { description: string; short: string };
            passes: { description: string };
        } & {
            bail: ConfigOption<"boolean", false, undefined>;
            changed: ConfigOption<"boolean", false, undefined>;
            color: ConfigOption<"boolean", false, undefined>;
            comments: ConfigOption<"boolean", false, undefined>;
            "fail-only": ConfigOption<"boolean", false, undefined>;
            "fail-skip": ConfigOption<"boolean", false, undefined>;
            "fail-todo": ConfigOption<"boolean", false, undefined>;
            "no-bail": ConfigOption<"boolean", false, undefined>;
            "no-color": ConfigOption<"boolean", false, undefined>;
            passes: ConfigOption<"boolean", false, undefined>;
        } & { save: { description: string; hint: string; short: string } } & {
            save: ConfigOption<"string", false, undefined | readonly string[]>;
        } & { diag: { description: string }; "no-diag": { description: string } } & {
            diag: ConfigOption<"boolean", false, undefined>;
            "no-diag": ConfigOption<"boolean", false, undefined>;
        } & {
            timeout: {
                default: number;
                description: string;
                hint: string;
                short: string;
            };
        } & {
            timeout: ConfigOption<"number", false, undefined | readonly number[]>;
        } & { files: { description: string; hint: string } } & {
            files: ConfigOption<"string", true, undefined | readonly string[]>;
        } & {
            jobs: {
                default: number;
                description: string;
                hint: string;
                short: string;
            };
        } & { jobs: ConfigOption<"number", false, undefined | readonly number[]> } & {
            after: { description: string; hint: string };
            before: { description: string; hint: string };
            "output-dir": { description: string; hint: string; short: string };
            "output-file": { description: string; hint: string; short: string };
        } & {
            after: ConfigOption<"string", false, undefined | readonly string[]>;
            before: ConfigOption<"string", false, undefined | readonly string[]>;
            "output-dir": ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
            "output-file": ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
        } & {
            exclude: { default: string[]; description: string; hint: string };
            include: { default: string[]; description: string; hint: string };
            "node-arg": { default: never[]; description: string; hint: string };
            serial: { description: string; hint: string };
            "test-arg": { default: never[]; description: string; hint: string };
            "test-env": { default: never[]; description: string; hint: string };
        } & {
            exclude: ConfigOption<"string", true, undefined | readonly string[]>;
            include: ConfigOption<"string", true, undefined | readonly string[]>;
            "node-arg": ConfigOption<"string", true, undefined | readonly string[]>;
            serial: ConfigOption<"string", true, undefined | readonly string[]>;
            "test-arg": ConfigOption<"string", true, undefined | readonly string[]>;
            "test-env": ConfigOption<"string", true, undefined | readonly string[]>;
        } & {
            debug: { description: string };
            help: { description: string; short: string; type: "boolean" };
            "no-omit-whitespace": { description: string };
            "omit-version": { description: string };
            "omit-whitespace": { description: string };
            version: { description: string; short: string };
            versions: { description: string; short: string };
        } & {
            debug: ConfigOption<"boolean", false, undefined>;
            help: ConfigOption<"boolean", false, undefined>;
            "no-omit-whitespace": ConfigOption<"boolean", false, undefined>;
            "omit-version": ConfigOption<"boolean", false, undefined>;
            "omit-whitespace": ConfigOption<"boolean", false, undefined>;
            version: ConfigOption<"boolean", false, undefined>;
            versions: ConfigOption<"boolean", false, undefined>;
        } & {
            only: {
                description: string;
                nodeArgs: (v: boolean) => string[];
                short: string;
                type: string;
            } & ConfigOption<"boolean", false, undefined>;
        } & { only: ConfigOption<"boolean", false, undefined> } & {
            grep: {
                description: string;
                hint: string;
                multiple: boolean;
                nodeArgs: (value: string[]) => string[];
                short: string;
                type: string;
            } & ConfigOption<"string", true, undefined | readonly string[]>;
        } & { grep: ConfigOption<"string", true, undefined | readonly string[]> } & {
            invert: { description: string; short: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { invert: ConfigOption<"boolean", false, undefined> } & {
            "no-invert": { description: string; short: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "no-invert": ConfigOption<"boolean", false, undefined> } & {
            "filter-quietly": { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "filter-quietly": ConfigOption<"boolean", false, undefined> } & {
            "no-filter-quietly": { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "no-filter-quietly": ConfigOption<"boolean", false, undefined> } & {
            "save-fixture": { description: string; short: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "save-fixture": ConfigOption<"boolean", false, undefined> } & {
            snapshot: { description: string; short: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { snapshot: ConfigOption<"boolean", false, undefined> } & {
            "snapshot-clean-cwd": {
                default: boolean;
                description: string;
                type: string;
            } & ConfigOption<"boolean", false, undefined>;
        } & { "snapshot-clean-cwd": ConfigOption<"boolean", false, undefined> } & {
            "no-snapshot-clean-cwd": { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "no-snapshot-clean-cwd": ConfigOption<"boolean", false, undefined> } & {
            typecheck: { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { typecheck: ConfigOption<"boolean", false, undefined> } & {
            tsconfig: { description: string; type: string } & ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
        } & {
            tsconfig: ConfigOption<"string", false, undefined | readonly string[]>;
        } & {
            "type-strip-only": { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "type-strip-only": ConfigOption<"boolean", false, undefined> },
    >,
>
Read configuration from a yaml .taprc file
Parameters
- rc: string
- silent: boolean = false
Returns Promise<
    | undefined
    | ConfigFileData<
        { plugin: { default: string[]; description: string; hint: string } } & {
            plugin: ConfigOption<"string", true, undefined | readonly string[]>;
        } & {
            reporter: { description: string; hint: string; short: string };
            "reporter-file": { description: string; hint: string; short: string };
        } & {
            reporter: ConfigOption<"string", false, undefined | readonly string[]>;
            "reporter-file": ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
        } & {
            "reporter-arg": { description: string; hint: string; short: string };
        } & {
            "reporter-arg": ConfigOption<
                "string",
                true,
                undefined
                | readonly string[],
            >;
        } & {
            "coverage-report": {
                default: string[];
                description: string;
                hint: string;
            };
        } & {
            "coverage-report": ConfigOption<
                "string",
                true,
                undefined
                | readonly string[],
            >;
        } & {
            browser: { default: true; description: string };
            "no-browser": { description: string };
            "show-full-coverage": { description: string };
        } & {
            browser: ConfigOption<"boolean", false, undefined>;
            "no-browser": ConfigOption<"boolean", false, undefined>;
            "show-full-coverage": ConfigOption<"boolean", false, undefined>;
        } & { "coverage-map": { description: string; hint: string } } & {
            "coverage-map": ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
        } & {
            "allow-empty-coverage": { description: string };
            "allow-incomplete-coverage": { description: string };
            "disable-coverage": { description: string };
        } & {
            "allow-empty-coverage": ConfigOption<"boolean", false, undefined>;
            "allow-incomplete-coverage": ConfigOption<"boolean", false, undefined>;
            "disable-coverage": ConfigOption<"boolean", false, undefined>;
        } & {
            bail: { description: string; short: string };
            changed: { description: string; short: string };
            color: { description: string; short: string };
            comments: { description: string };
            "fail-only": { description: string };
            "fail-skip": { description: string };
            "fail-todo": { description: string };
            "no-bail": { description: string; short: string };
            "no-color": { description: string; short: string };
            passes: { description: string };
        } & {
            bail: ConfigOption<"boolean", false, undefined>;
            changed: ConfigOption<"boolean", false, undefined>;
            color: ConfigOption<"boolean", false, undefined>;
            comments: ConfigOption<"boolean", false, undefined>;
            "fail-only": ConfigOption<"boolean", false, undefined>;
            "fail-skip": ConfigOption<"boolean", false, undefined>;
            "fail-todo": ConfigOption<"boolean", false, undefined>;
            "no-bail": ConfigOption<"boolean", false, undefined>;
            "no-color": ConfigOption<"boolean", false, undefined>;
            passes: ConfigOption<"boolean", false, undefined>;
        } & { save: { description: string; hint: string; short: string } } & {
            save: ConfigOption<"string", false, undefined | readonly string[]>;
        } & { diag: { description: string }; "no-diag": { description: string } } & {
            diag: ConfigOption<"boolean", false, undefined>;
            "no-diag": ConfigOption<"boolean", false, undefined>;
        } & {
            timeout: {
                default: number;
                description: string;
                hint: string;
                short: string;
            };
        } & {
            timeout: ConfigOption<"number", false, undefined | readonly number[]>;
        } & { files: { description: string; hint: string } } & {
            files: ConfigOption<"string", true, undefined | readonly string[]>;
        } & {
            jobs: {
                default: number;
                description: string;
                hint: string;
                short: string;
            };
        } & { jobs: ConfigOption<"number", false, undefined | readonly number[]> } & {
            after: { description: string; hint: string };
            before: { description: string; hint: string };
            "output-dir": { description: string; hint: string; short: string };
            "output-file": { description: string; hint: string; short: string };
        } & {
            after: ConfigOption<"string", false, undefined | readonly string[]>;
            before: ConfigOption<"string", false, undefined | readonly string[]>;
            "output-dir": ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
            "output-file": ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
        } & {
            exclude: { default: string[]; description: string; hint: string };
            include: { default: string[]; description: string; hint: string };
            "node-arg": { default: never[]; description: string; hint: string };
            serial: { description: string; hint: string };
            "test-arg": { default: never[]; description: string; hint: string };
            "test-env": { default: never[]; description: string; hint: string };
        } & {
            exclude: ConfigOption<"string", true, undefined | readonly string[]>;
            include: ConfigOption<"string", true, undefined | readonly string[]>;
            "node-arg": ConfigOption<"string", true, undefined | readonly string[]>;
            serial: ConfigOption<"string", true, undefined | readonly string[]>;
            "test-arg": ConfigOption<"string", true, undefined | readonly string[]>;
            "test-env": ConfigOption<"string", true, undefined | readonly string[]>;
        } & {
            debug: { description: string };
            help: { description: string; short: string; type: "boolean" };
            "no-omit-whitespace": { description: string };
            "omit-version": { description: string };
            "omit-whitespace": { description: string };
            version: { description: string; short: string };
            versions: { description: string; short: string };
        } & {
            debug: ConfigOption<"boolean", false, undefined>;
            help: ConfigOption<"boolean", false, undefined>;
            "no-omit-whitespace": ConfigOption<"boolean", false, undefined>;
            "omit-version": ConfigOption<"boolean", false, undefined>;
            "omit-whitespace": ConfigOption<"boolean", false, undefined>;
            version: ConfigOption<"boolean", false, undefined>;
            versions: ConfigOption<"boolean", false, undefined>;
        } & {
            only: {
                description: string;
                nodeArgs: (v: boolean) => string[];
                short: string;
                type: string;
            } & ConfigOption<"boolean", false, undefined>;
        } & { only: ConfigOption<"boolean", false, undefined> } & {
            grep: {
                description: string;
                hint: string;
                multiple: boolean;
                nodeArgs: (value: string[]) => string[];
                short: string;
                type: string;
            } & ConfigOption<"string", true, undefined | readonly string[]>;
        } & { grep: ConfigOption<"string", true, undefined | readonly string[]> } & {
            invert: { description: string; short: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { invert: ConfigOption<"boolean", false, undefined> } & {
            "no-invert": { description: string; short: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "no-invert": ConfigOption<"boolean", false, undefined> } & {
            "filter-quietly": { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "filter-quietly": ConfigOption<"boolean", false, undefined> } & {
            "no-filter-quietly": { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "no-filter-quietly": ConfigOption<"boolean", false, undefined> } & {
            "save-fixture": { description: string; short: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "save-fixture": ConfigOption<"boolean", false, undefined> } & {
            snapshot: { description: string; short: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { snapshot: ConfigOption<"boolean", false, undefined> } & {
            "snapshot-clean-cwd": {
                default: boolean;
                description: string;
                type: string;
            } & ConfigOption<"boolean", false, undefined>;
        } & { "snapshot-clean-cwd": ConfigOption<"boolean", false, undefined> } & {
            "no-snapshot-clean-cwd": { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "no-snapshot-clean-cwd": ConfigOption<"boolean", false, undefined> } & {
            typecheck: { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { typecheck: ConfigOption<"boolean", false, undefined> } & {
            tsconfig: { description: string; type: string } & ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
        } & {
            tsconfig: ConfigOption<"string", false, undefined | readonly string[]>;
        } & {
            "type-strip-only": { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "type-strip-only": ConfigOption<"boolean", false, undefined> },
    >,
>
Inherited from ReturnType.readYAMLConfig
- Defined in src/config/src/index.ts:239

resolveExtension

resolveExtension(ext: string, file: string): Promise<string>
Resolve the source of an extends field in TAP configs
Parameters
- ext: string
- file: string
Returns Promise<string>
Inherited from ReturnType.resolveExtension
- Defined in src/config/src/index.ts:325

resolvePathOptions

resolvePathOptions(
    conf:
        | undefined
        | ConfigFileData<
            { plugin: { default: string[]; description: string; hint: string } } & {
                plugin: ConfigOption<"string", true, undefined | readonly string[]>;
            } & {
                reporter: { description: string; hint: string; short: string };
                "reporter-file": { description: string; hint: string; short: string };
            } & {
                reporter: ConfigOption<
                    "string",
                    false,
                    undefined
                    | readonly string[],
                >;
                "reporter-file": ConfigOption<
                    "string",
                    false,
                    undefined
                    | readonly string[],
                >;
            } & {
                "reporter-arg": { description: string; hint: string; short: string };
            } & {
                "reporter-arg": ConfigOption<
                    "string",
                    true,
                    undefined
                    | readonly string[],
                >;
            } & {
                "coverage-report": {
                    default: string[];
                    description: string;
                    hint: string;
                };
            } & {
                "coverage-report": ConfigOption<
                    "string",
                    true,
                    undefined
                    | readonly string[],
                >;
            } & {
                browser: { default: true; description: string };
                "no-browser": { description: string };
                "show-full-coverage": { description: string };
            } & {
                browser: ConfigOption<"boolean", false, undefined>;
                "no-browser": ConfigOption<"boolean", false, undefined>;
                "show-full-coverage": ConfigOption<"boolean", false, undefined>;
            } & { "coverage-map": { description: string; hint: string } } & {
                "coverage-map": ConfigOption<
                    "string",
                    false,
                    undefined
                    | readonly string[],
                >;
            } & {
                "allow-empty-coverage": { description: string };
                "allow-incomplete-coverage": { description: string };
                "disable-coverage": { description: string };
            } & {
                "allow-empty-coverage": ConfigOption<"boolean", false, undefined>;
                "allow-incomplete-coverage": ConfigOption<"boolean", false, undefined>;
                "disable-coverage": ConfigOption<"boolean", false, undefined>;
            } & {
                bail: { description: string; short: string };
                changed: { description: string; short: string };
                color: { description: string; short: string };
                comments: { description: string };
                "fail-only": { description: string };
                "fail-skip": { description: string };
                "fail-todo": { description: string };
                "no-bail": { description: string; short: string };
                "no-color": { description: string; short: string };
                passes: { description: string };
            } & {
                bail: ConfigOption<"boolean", false, undefined>;
                changed: ConfigOption<"boolean", false, undefined>;
                color: ConfigOption<"boolean", false, undefined>;
                comments: ConfigOption<"boolean", false, undefined>;
                "fail-only": ConfigOption<"boolean", false, undefined>;
                "fail-skip": ConfigOption<"boolean", false, undefined>;
                "fail-todo": ConfigOption<"boolean", false, undefined>;
                "no-bail": ConfigOption<"boolean", false, undefined>;
                "no-color": ConfigOption<"boolean", false, undefined>;
                passes: ConfigOption<"boolean", false, undefined>;
            } & { save: { description: string; hint: string; short: string } } & {
                save: ConfigOption<"string", false, undefined | readonly string[]>;
            } & { diag: { description: string }; "no-diag": { description: string } } & {
                diag: ConfigOption<"boolean", false, undefined>;
                "no-diag": ConfigOption<"boolean", false, undefined>;
            } & {
                timeout: {
                    default: number;
                    description: string;
                    hint: string;
                    short: string;
                };
            } & {
                timeout: ConfigOption<"number", false, undefined | readonly number[]>;
            } & { files: { description: string; hint: string } } & {
                files: ConfigOption<"string", true, undefined | readonly string[]>;
            } & {
                jobs: {
                    default: number;
                    description: string;
                    hint: string;
                    short: string;
                };
            } & {
                jobs: ConfigOption<"number", false, undefined | readonly number[]>;
            } & {
                after: { description: string; hint: string };
                before: { description: string; hint: string };
                "output-dir": { description: string; hint: string; short: string };
                "output-file": { description: string; hint: string; short: string };
            } & {
                after: ConfigOption<"string", false, undefined | readonly string[]>;
                before: ConfigOption<"string", false, undefined | readonly string[]>;
                "output-dir": ConfigOption<
                    "string",
                    false,
                    undefined
                    | readonly string[],
                >;
                "output-file": ConfigOption<
                    "string",
                    false,
                    undefined
                    | readonly string[],
                >;
            } & {
                exclude: { default: string[]; description: string; hint: string };
                include: { default: string[]; description: string; hint: string };
                "node-arg": { default: never[]; description: string; hint: string };
                serial: { description: string; hint: string };
                "test-arg": { default: never[]; description: string; hint: string };
                "test-env": { default: never[]; description: string; hint: string };
            } & {
                exclude: ConfigOption<"string", true, undefined | readonly string[]>;
                include: ConfigOption<"string", true, undefined | readonly string[]>;
                "node-arg": ConfigOption<"string", true, undefined | readonly string[]>;
                serial: ConfigOption<"string", true, undefined | readonly string[]>;
                "test-arg": ConfigOption<"string", true, undefined | readonly string[]>;
                "test-env": ConfigOption<"string", true, undefined | readonly string[]>;
            } & {
                debug: { description: string };
                help: { description: string; short: string; type: "boolean" };
                "no-omit-whitespace": { description: string };
                "omit-version": { description: string };
                "omit-whitespace": { description: string };
                version: { description: string; short: string };
                versions: { description: string; short: string };
            } & {
                debug: ConfigOption<"boolean", false, undefined>;
                help: ConfigOption<"boolean", false, undefined>;
                "no-omit-whitespace": ConfigOption<"boolean", false, undefined>;
                "omit-version": ConfigOption<"boolean", false, undefined>;
                "omit-whitespace": ConfigOption<"boolean", false, undefined>;
                version: ConfigOption<"boolean", false, undefined>;
                versions: ConfigOption<"boolean", false, undefined>;
            } & {
                only: {
                    description: string;
                    nodeArgs: (v: boolean) => string[];
                    short: string;
                    type: string;
                } & ConfigOption<"boolean", false, undefined>;
            } & { only: ConfigOption<"boolean", false, undefined> } & {
                grep: {
                    description: string;
                    hint: string;
                    multiple: boolean;
                    nodeArgs: (value: string[]) => string[];
                    short: string;
                    type: string;
                } & ConfigOption<"string", true, undefined | readonly string[]>;
            } & { grep: ConfigOption<"string", true, undefined | readonly string[]> } & {
                invert: { description: string; short: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { invert: ConfigOption<"boolean", false, undefined> } & {
                "no-invert": { description: string; short: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { "no-invert": ConfigOption<"boolean", false, undefined> } & {
                "filter-quietly": { description: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { "filter-quietly": ConfigOption<"boolean", false, undefined> } & {
                "no-filter-quietly": { description: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { "no-filter-quietly": ConfigOption<"boolean", false, undefined> } & {
                "save-fixture": { description: string; short: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { "save-fixture": ConfigOption<"boolean", false, undefined> } & {
                snapshot: { description: string; short: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { snapshot: ConfigOption<"boolean", false, undefined> } & {
                "snapshot-clean-cwd": {
                    default: boolean;
                    description: string;
                    type: string;
                } & ConfigOption<"boolean", false, undefined>;
            } & { "snapshot-clean-cwd": ConfigOption<"boolean", false, undefined> } & {
                "no-snapshot-clean-cwd": { description: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & {
                "no-snapshot-clean-cwd": ConfigOption<"boolean", false, undefined>;
            } & {
                typecheck: { description: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { typecheck: ConfigOption<"boolean", false, undefined> } & {
                tsconfig: { description: string; type: string } & ConfigOption<
                    "string",
                    false,
                    undefined
                    | readonly string[],
                >;
            } & {
                tsconfig: ConfigOption<
                    "string",
                    false,
                    undefined
                    | readonly string[],
                >;
            } & {
                "type-strip-only": { description: string; type: string } & ConfigOption<
                    "boolean",
                    false,
                    undefined,
                >;
            } & { "type-strip-only": ConfigOption<"boolean", false, undefined> },
        >,
    file: string,
):
    | undefined
    | OptionsSubset<
        { plugin: { default: string[]; description: string; hint: string } } & {
            plugin: ConfigOption<"string", true, undefined | readonly string[]>;
        } & {
            reporter: { description: string; hint: string; short: string };
            "reporter-file": { description: string; hint: string; short: string };
        } & {
            reporter: ConfigOption<"string", false, undefined | readonly string[]>;
            "reporter-file": ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
        } & {
            "reporter-arg": { description: string; hint: string; short: string };
        } & {
            "reporter-arg": ConfigOption<
                "string",
                true,
                undefined
                | readonly string[],
            >;
        } & {
            "coverage-report": {
                default: string[];
                description: string;
                hint: string;
            };
        } & {
            "coverage-report": ConfigOption<
                "string",
                true,
                undefined
                | readonly string[],
            >;
        } & {
            browser: { default: true; description: string };
            "no-browser": { description: string };
            "show-full-coverage": { description: string };
        } & {
            browser: ConfigOption<"boolean", false, undefined>;
            "no-browser": ConfigOption<"boolean", false, undefined>;
            "show-full-coverage": ConfigOption<"boolean", false, undefined>;
        } & { "coverage-map": { description: string; hint: string } } & {
            "coverage-map": ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
        } & {
            "allow-empty-coverage": { description: string };
            "allow-incomplete-coverage": { description: string };
            "disable-coverage": { description: string };
        } & {
            "allow-empty-coverage": ConfigOption<"boolean", false, undefined>;
            "allow-incomplete-coverage": ConfigOption<"boolean", false, undefined>;
            "disable-coverage": ConfigOption<"boolean", false, undefined>;
        } & {
            bail: { description: string; short: string };
            changed: { description: string; short: string };
            color: { description: string; short: string };
            comments: { description: string };
            "fail-only": { description: string };
            "fail-skip": { description: string };
            "fail-todo": { description: string };
            "no-bail": { description: string; short: string };
            "no-color": { description: string; short: string };
            passes: { description: string };
        } & {
            bail: ConfigOption<"boolean", false, undefined>;
            changed: ConfigOption<"boolean", false, undefined>;
            color: ConfigOption<"boolean", false, undefined>;
            comments: ConfigOption<"boolean", false, undefined>;
            "fail-only": ConfigOption<"boolean", false, undefined>;
            "fail-skip": ConfigOption<"boolean", false, undefined>;
            "fail-todo": ConfigOption<"boolean", false, undefined>;
            "no-bail": ConfigOption<"boolean", false, undefined>;
            "no-color": ConfigOption<"boolean", false, undefined>;
            passes: ConfigOption<"boolean", false, undefined>;
        } & { save: { description: string; hint: string; short: string } } & {
            save: ConfigOption<"string", false, undefined | readonly string[]>;
        } & { diag: { description: string }; "no-diag": { description: string } } & {
            diag: ConfigOption<"boolean", false, undefined>;
            "no-diag": ConfigOption<"boolean", false, undefined>;
        } & {
            timeout: {
                default: number;
                description: string;
                hint: string;
                short: string;
            };
        } & {
            timeout: ConfigOption<"number", false, undefined | readonly number[]>;
        } & { files: { description: string; hint: string } } & {
            files: ConfigOption<"string", true, undefined | readonly string[]>;
        } & {
            jobs: {
                default: number;
                description: string;
                hint: string;
                short: string;
            };
        } & { jobs: ConfigOption<"number", false, undefined | readonly number[]> } & {
            after: { description: string; hint: string };
            before: { description: string; hint: string };
            "output-dir": { description: string; hint: string; short: string };
            "output-file": { description: string; hint: string; short: string };
        } & {
            after: ConfigOption<"string", false, undefined | readonly string[]>;
            before: ConfigOption<"string", false, undefined | readonly string[]>;
            "output-dir": ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
            "output-file": ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
        } & {
            exclude: { default: string[]; description: string; hint: string };
            include: { default: string[]; description: string; hint: string };
            "node-arg": { default: never[]; description: string; hint: string };
            serial: { description: string; hint: string };
            "test-arg": { default: never[]; description: string; hint: string };
            "test-env": { default: never[]; description: string; hint: string };
        } & {
            exclude: ConfigOption<"string", true, undefined | readonly string[]>;
            include: ConfigOption<"string", true, undefined | readonly string[]>;
            "node-arg": ConfigOption<"string", true, undefined | readonly string[]>;
            serial: ConfigOption<"string", true, undefined | readonly string[]>;
            "test-arg": ConfigOption<"string", true, undefined | readonly string[]>;
            "test-env": ConfigOption<"string", true, undefined | readonly string[]>;
        } & {
            debug: { description: string };
            help: { description: string; short: string; type: "boolean" };
            "no-omit-whitespace": { description: string };
            "omit-version": { description: string };
            "omit-whitespace": { description: string };
            version: { description: string; short: string };
            versions: { description: string; short: string };
        } & {
            debug: ConfigOption<"boolean", false, undefined>;
            help: ConfigOption<"boolean", false, undefined>;
            "no-omit-whitespace": ConfigOption<"boolean", false, undefined>;
            "omit-version": ConfigOption<"boolean", false, undefined>;
            "omit-whitespace": ConfigOption<"boolean", false, undefined>;
            version: ConfigOption<"boolean", false, undefined>;
            versions: ConfigOption<"boolean", false, undefined>;
        } & {
            only: {
                description: string;
                nodeArgs: (v: boolean) => string[];
                short: string;
                type: string;
            } & ConfigOption<"boolean", false, undefined>;
        } & { only: ConfigOption<"boolean", false, undefined> } & {
            grep: {
                description: string;
                hint: string;
                multiple: boolean;
                nodeArgs: (value: string[]) => string[];
                short: string;
                type: string;
            } & ConfigOption<"string", true, undefined | readonly string[]>;
        } & { grep: ConfigOption<"string", true, undefined | readonly string[]> } & {
            invert: { description: string; short: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { invert: ConfigOption<"boolean", false, undefined> } & {
            "no-invert": { description: string; short: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "no-invert": ConfigOption<"boolean", false, undefined> } & {
            "filter-quietly": { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "filter-quietly": ConfigOption<"boolean", false, undefined> } & {
            "no-filter-quietly": { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "no-filter-quietly": ConfigOption<"boolean", false, undefined> } & {
            "save-fixture": { description: string; short: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "save-fixture": ConfigOption<"boolean", false, undefined> } & {
            snapshot: { description: string; short: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { snapshot: ConfigOption<"boolean", false, undefined> } & {
            "snapshot-clean-cwd": {
                default: boolean;
                description: string;
                type: string;
            } & ConfigOption<"boolean", false, undefined>;
        } & { "snapshot-clean-cwd": ConfigOption<"boolean", false, undefined> } & {
            "no-snapshot-clean-cwd": { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "no-snapshot-clean-cwd": ConfigOption<"boolean", false, undefined> } & {
            typecheck: { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { typecheck: ConfigOption<"boolean", false, undefined> } & {
            tsconfig: { description: string; type: string } & ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
        } & {
            tsconfig: ConfigOption<"string", false, undefined | readonly string[]>;
        } & {
            "type-strip-only": { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "type-strip-only": ConfigOption<"boolean", false, undefined> },
    >
Parameters
- conf:
      | undefined
      | ConfigFileData<
          { plugin: { default: string[]; description: string; hint: string } } & {
              plugin: ConfigOption<"string", true, undefined | readonly string[]>;
          } & {
              reporter: { description: string; hint: string; short: string };
              "reporter-file": { description: string; hint: string; short: string };
          } & {
              reporter: ConfigOption<"string", false, undefined | readonly string[]>;
              "reporter-file": ConfigOption<
                  "string",
                  false,
                  undefined
                  | readonly string[],
              >;
          } & {
              "reporter-arg": { description: string; hint: string; short: string };
          } & {
              "reporter-arg": ConfigOption<
                  "string",
                  true,
                  undefined
                  | readonly string[],
              >;
          } & {
              "coverage-report": {
                  default: string[];
                  description: string;
                  hint: string;
              };
          } & {
              "coverage-report": ConfigOption<
                  "string",
                  true,
                  undefined
                  | readonly string[],
              >;
          } & {
              browser: { default: true; description: string };
              "no-browser": { description: string };
              "show-full-coverage": { description: string };
          } & {
              browser: ConfigOption<"boolean", false, undefined>;
              "no-browser": ConfigOption<"boolean", false, undefined>;
              "show-full-coverage": ConfigOption<"boolean", false, undefined>;
          } & { "coverage-map": { description: string; hint: string } } & {
              "coverage-map": ConfigOption<
                  "string",
                  false,
                  undefined
                  | readonly string[],
              >;
          } & {
              "allow-empty-coverage": { description: string };
              "allow-incomplete-coverage": { description: string };
              "disable-coverage": { description: string };
          } & {
              "allow-empty-coverage": ConfigOption<"boolean", false, undefined>;
              "allow-incomplete-coverage": ConfigOption<"boolean", false, undefined>;
              "disable-coverage": ConfigOption<"boolean", false, undefined>;
          } & {
              bail: { description: string; short: string };
              changed: { description: string; short: string };
              color: { description: string; short: string };
              comments: { description: string };
              "fail-only": { description: string };
              "fail-skip": { description: string };
              "fail-todo": { description: string };
              "no-bail": { description: string; short: string };
              "no-color": { description: string; short: string };
              passes: { description: string };
          } & {
              bail: ConfigOption<"boolean", false, undefined>;
              changed: ConfigOption<"boolean", false, undefined>;
              color: ConfigOption<"boolean", false, undefined>;
              comments: ConfigOption<"boolean", false, undefined>;
              "fail-only": ConfigOption<"boolean", false, undefined>;
              "fail-skip": ConfigOption<"boolean", false, undefined>;
              "fail-todo": ConfigOption<"boolean", false, undefined>;
              "no-bail": ConfigOption<"boolean", false, undefined>;
              "no-color": ConfigOption<"boolean", false, undefined>;
              passes: ConfigOption<"boolean", false, undefined>;
          } & { save: { description: string; hint: string; short: string } } & {
              save: ConfigOption<"string", false, undefined | readonly string[]>;
          } & { diag: { description: string }; "no-diag": { description: string } } & {
              diag: ConfigOption<"boolean", false, undefined>;
              "no-diag": ConfigOption<"boolean", false, undefined>;
          } & {
              timeout: {
                  default: number;
                  description: string;
                  hint: string;
                  short: string;
              };
          } & {
              timeout: ConfigOption<"number", false, undefined | readonly number[]>;
          } & { files: { description: string; hint: string } } & {
              files: ConfigOption<"string", true, undefined | readonly string[]>;
          } & {
              jobs: {
                  default: number;
                  description: string;
                  hint: string;
                  short: string;
              };
          } & { jobs: ConfigOption<"number", false, undefined | readonly number[]> } & {
              after: { description: string; hint: string };
              before: { description: string; hint: string };
              "output-dir": { description: string; hint: string; short: string };
              "output-file": { description: string; hint: string; short: string };
          } & {
              after: ConfigOption<"string", false, undefined | readonly string[]>;
              before: ConfigOption<"string", false, undefined | readonly string[]>;
              "output-dir": ConfigOption<
                  "string",
                  false,
                  undefined
                  | readonly string[],
              >;
              "output-file": ConfigOption<
                  "string",
                  false,
                  undefined
                  | readonly string[],
              >;
          } & {
              exclude: { default: string[]; description: string; hint: string };
              include: { default: string[]; description: string; hint: string };
              "node-arg": { default: never[]; description: string; hint: string };
              serial: { description: string; hint: string };
              "test-arg": { default: never[]; description: string; hint: string };
              "test-env": { default: never[]; description: string; hint: string };
          } & {
              exclude: ConfigOption<"string", true, undefined | readonly string[]>;
              include: ConfigOption<"string", true, undefined | readonly string[]>;
              "node-arg": ConfigOption<"string", true, undefined | readonly string[]>;
              serial: ConfigOption<"string", true, undefined | readonly string[]>;
              "test-arg": ConfigOption<"string", true, undefined | readonly string[]>;
              "test-env": ConfigOption<"string", true, undefined | readonly string[]>;
          } & {
              debug: { description: string };
              help: { description: string; short: string; type: "boolean" };
              "no-omit-whitespace": { description: string };
              "omit-version": { description: string };
              "omit-whitespace": { description: string };
              version: { description: string; short: string };
              versions: { description: string; short: string };
          } & {
              debug: ConfigOption<"boolean", false, undefined>;
              help: ConfigOption<"boolean", false, undefined>;
              "no-omit-whitespace": ConfigOption<"boolean", false, undefined>;
              "omit-version": ConfigOption<"boolean", false, undefined>;
              "omit-whitespace": ConfigOption<"boolean", false, undefined>;
              version: ConfigOption<"boolean", false, undefined>;
              versions: ConfigOption<"boolean", false, undefined>;
          } & {
              only: {
                  description: string;
                  nodeArgs: (v: boolean) => string[];
                  short: string;
                  type: string;
              } & ConfigOption<"boolean", false, undefined>;
          } & { only: ConfigOption<"boolean", false, undefined> } & {
              grep: {
                  description: string;
                  hint: string;
                  multiple: boolean;
                  nodeArgs: (value: string[]) => string[];
                  short: string;
                  type: string;
              } & ConfigOption<"string", true, undefined | readonly string[]>;
          } & { grep: ConfigOption<"string", true, undefined | readonly string[]> } & {
              invert: { description: string; short: string; type: string } & ConfigOption<
                  "boolean",
                  false,
                  undefined,
              >;
          } & { invert: ConfigOption<"boolean", false, undefined> } & {
              "no-invert": { description: string; short: string; type: string } & ConfigOption<
                  "boolean",
                  false,
                  undefined,
              >;
          } & { "no-invert": ConfigOption<"boolean", false, undefined> } & {
              "filter-quietly": { description: string; type: string } & ConfigOption<
                  "boolean",
                  false,
                  undefined,
              >;
          } & { "filter-quietly": ConfigOption<"boolean", false, undefined> } & {
              "no-filter-quietly": { description: string; type: string } & ConfigOption<
                  "boolean",
                  false,
                  undefined,
              >;
          } & { "no-filter-quietly": ConfigOption<"boolean", false, undefined> } & {
              "save-fixture": { description: string; short: string; type: string } & ConfigOption<
                  "boolean",
                  false,
                  undefined,
              >;
          } & { "save-fixture": ConfigOption<"boolean", false, undefined> } & {
              snapshot: { description: string; short: string; type: string } & ConfigOption<
                  "boolean",
                  false,
                  undefined,
              >;
          } & { snapshot: ConfigOption<"boolean", false, undefined> } & {
              "snapshot-clean-cwd": {
                  default: boolean;
                  description: string;
                  type: string;
              } & ConfigOption<"boolean", false, undefined>;
          } & { "snapshot-clean-cwd": ConfigOption<"boolean", false, undefined> } & {
              "no-snapshot-clean-cwd": { description: string; type: string } & ConfigOption<
                  "boolean",
                  false,
                  undefined,
              >;
          } & { "no-snapshot-clean-cwd": ConfigOption<"boolean", false, undefined> } & {
              typecheck: { description: string; type: string } & ConfigOption<
                  "boolean",
                  false,
                  undefined,
              >;
          } & { typecheck: ConfigOption<"boolean", false, undefined> } & {
              tsconfig: { description: string; type: string } & ConfigOption<
                  "string",
                  false,
                  undefined
                  | readonly string[],
              >;
          } & {
              tsconfig: ConfigOption<"string", false, undefined | readonly string[]>;
          } & {
              "type-strip-only": { description: string; type: string } & ConfigOption<
                  "boolean",
                  false,
                  undefined,
              >;
          } & { "type-strip-only": ConfigOption<"boolean", false, undefined> },
      >
- file: string
Returns
    | undefined
    | OptionsSubset<
        { plugin: { default: string[]; description: string; hint: string } } & {
            plugin: ConfigOption<"string", true, undefined | readonly string[]>;
        } & {
            reporter: { description: string; hint: string; short: string };
            "reporter-file": { description: string; hint: string; short: string };
        } & {
            reporter: ConfigOption<"string", false, undefined | readonly string[]>;
            "reporter-file": ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
        } & {
            "reporter-arg": { description: string; hint: string; short: string };
        } & {
            "reporter-arg": ConfigOption<
                "string",
                true,
                undefined
                | readonly string[],
            >;
        } & {
            "coverage-report": {
                default: string[];
                description: string;
                hint: string;
            };
        } & {
            "coverage-report": ConfigOption<
                "string",
                true,
                undefined
                | readonly string[],
            >;
        } & {
            browser: { default: true; description: string };
            "no-browser": { description: string };
            "show-full-coverage": { description: string };
        } & {
            browser: ConfigOption<"boolean", false, undefined>;
            "no-browser": ConfigOption<"boolean", false, undefined>;
            "show-full-coverage": ConfigOption<"boolean", false, undefined>;
        } & { "coverage-map": { description: string; hint: string } } & {
            "coverage-map": ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
        } & {
            "allow-empty-coverage": { description: string };
            "allow-incomplete-coverage": { description: string };
            "disable-coverage": { description: string };
        } & {
            "allow-empty-coverage": ConfigOption<"boolean", false, undefined>;
            "allow-incomplete-coverage": ConfigOption<"boolean", false, undefined>;
            "disable-coverage": ConfigOption<"boolean", false, undefined>;
        } & {
            bail: { description: string; short: string };
            changed: { description: string; short: string };
            color: { description: string; short: string };
            comments: { description: string };
            "fail-only": { description: string };
            "fail-skip": { description: string };
            "fail-todo": { description: string };
            "no-bail": { description: string; short: string };
            "no-color": { description: string; short: string };
            passes: { description: string };
        } & {
            bail: ConfigOption<"boolean", false, undefined>;
            changed: ConfigOption<"boolean", false, undefined>;
            color: ConfigOption<"boolean", false, undefined>;
            comments: ConfigOption<"boolean", false, undefined>;
            "fail-only": ConfigOption<"boolean", false, undefined>;
            "fail-skip": ConfigOption<"boolean", false, undefined>;
            "fail-todo": ConfigOption<"boolean", false, undefined>;
            "no-bail": ConfigOption<"boolean", false, undefined>;
            "no-color": ConfigOption<"boolean", false, undefined>;
            passes: ConfigOption<"boolean", false, undefined>;
        } & { save: { description: string; hint: string; short: string } } & {
            save: ConfigOption<"string", false, undefined | readonly string[]>;
        } & { diag: { description: string }; "no-diag": { description: string } } & {
            diag: ConfigOption<"boolean", false, undefined>;
            "no-diag": ConfigOption<"boolean", false, undefined>;
        } & {
            timeout: {
                default: number;
                description: string;
                hint: string;
                short: string;
            };
        } & {
            timeout: ConfigOption<"number", false, undefined | readonly number[]>;
        } & { files: { description: string; hint: string } } & {
            files: ConfigOption<"string", true, undefined | readonly string[]>;
        } & {
            jobs: {
                default: number;
                description: string;
                hint: string;
                short: string;
            };
        } & { jobs: ConfigOption<"number", false, undefined | readonly number[]> } & {
            after: { description: string; hint: string };
            before: { description: string; hint: string };
            "output-dir": { description: string; hint: string; short: string };
            "output-file": { description: string; hint: string; short: string };
        } & {
            after: ConfigOption<"string", false, undefined | readonly string[]>;
            before: ConfigOption<"string", false, undefined | readonly string[]>;
            "output-dir": ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
            "output-file": ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
        } & {
            exclude: { default: string[]; description: string; hint: string };
            include: { default: string[]; description: string; hint: string };
            "node-arg": { default: never[]; description: string; hint: string };
            serial: { description: string; hint: string };
            "test-arg": { default: never[]; description: string; hint: string };
            "test-env": { default: never[]; description: string; hint: string };
        } & {
            exclude: ConfigOption<"string", true, undefined | readonly string[]>;
            include: ConfigOption<"string", true, undefined | readonly string[]>;
            "node-arg": ConfigOption<"string", true, undefined | readonly string[]>;
            serial: ConfigOption<"string", true, undefined | readonly string[]>;
            "test-arg": ConfigOption<"string", true, undefined | readonly string[]>;
            "test-env": ConfigOption<"string", true, undefined | readonly string[]>;
        } & {
            debug: { description: string };
            help: { description: string; short: string; type: "boolean" };
            "no-omit-whitespace": { description: string };
            "omit-version": { description: string };
            "omit-whitespace": { description: string };
            version: { description: string; short: string };
            versions: { description: string; short: string };
        } & {
            debug: ConfigOption<"boolean", false, undefined>;
            help: ConfigOption<"boolean", false, undefined>;
            "no-omit-whitespace": ConfigOption<"boolean", false, undefined>;
            "omit-version": ConfigOption<"boolean", false, undefined>;
            "omit-whitespace": ConfigOption<"boolean", false, undefined>;
            version: ConfigOption<"boolean", false, undefined>;
            versions: ConfigOption<"boolean", false, undefined>;
        } & {
            only: {
                description: string;
                nodeArgs: (v: boolean) => string[];
                short: string;
                type: string;
            } & ConfigOption<"boolean", false, undefined>;
        } & { only: ConfigOption<"boolean", false, undefined> } & {
            grep: {
                description: string;
                hint: string;
                multiple: boolean;
                nodeArgs: (value: string[]) => string[];
                short: string;
                type: string;
            } & ConfigOption<"string", true, undefined | readonly string[]>;
        } & { grep: ConfigOption<"string", true, undefined | readonly string[]> } & {
            invert: { description: string; short: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { invert: ConfigOption<"boolean", false, undefined> } & {
            "no-invert": { description: string; short: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "no-invert": ConfigOption<"boolean", false, undefined> } & {
            "filter-quietly": { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "filter-quietly": ConfigOption<"boolean", false, undefined> } & {
            "no-filter-quietly": { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "no-filter-quietly": ConfigOption<"boolean", false, undefined> } & {
            "save-fixture": { description: string; short: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "save-fixture": ConfigOption<"boolean", false, undefined> } & {
            snapshot: { description: string; short: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { snapshot: ConfigOption<"boolean", false, undefined> } & {
            "snapshot-clean-cwd": {
                default: boolean;
                description: string;
                type: string;
            } & ConfigOption<"boolean", false, undefined>;
        } & { "snapshot-clean-cwd": ConfigOption<"boolean", false, undefined> } & {
            "no-snapshot-clean-cwd": { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "no-snapshot-clean-cwd": ConfigOption<"boolean", false, undefined> } & {
            typecheck: { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { typecheck: ConfigOption<"boolean", false, undefined> } & {
            tsconfig: { description: string; type: string } & ConfigOption<
                "string",
                false,
                undefined
                | readonly string[],
            >;
        } & {
            tsconfig: ConfigOption<"string", false, undefined | readonly string[]>;
        } & {
            "type-strip-only": { description: string; type: string } & ConfigOption<
                "boolean",
                false,
                undefined,
            >;
        } & { "type-strip-only": ConfigOption<"boolean", false, undefined> },
    >
Inherited from ReturnType.resolvePathOptions
- Defined in src/config/src/index.ts:296

Interface LoadedConfig

Hierarchy

Index

Properties

Accessors

Methods

Properties

configFile

jack

positionals

projectRoot

testFileExtensions

values

valuesFromConfigFile

Accessors

pluginList

Returns string[]

pluginSignature

Returns string

Methods

addFields

Type Parameters

Parameters

editConfigFile

Parameters

Returns Promise<void>

editPackageJsonConfig

Parameters

Returns Promise<void>

editYAMLConfig

Parameters

Returns Promise<void>

expandInclude

Parameters

Returns string

extendConfigData

Parameters

Returns Promise<void>

get

Type Parameters

Parameters

loadColor

Returns Promise<LoadedConfig>

loadConfigData

Parameters

Returns Promise< LoadedConfig & { configFile: string; valuesFromConfigFile: OptionsResults<C>; },>

loadConfigFile

Returns Promise< LoadedConfig & { configFile: string; valuesFromConfigFile: OptionsSubset<C>; },>

loadPluginConfigFields

loadReporter

Returns LoadedConfig

parse

Parameters

Returns LoadedConfig & { positionals: string[]; values: OptionsResults<C> }

readDepConfig

Parameters

readPackageJson

Parameters

readPackageJsonConfig

Parameters

readYAMLConfig

Parameters

resolveExtension

Parameters

Returns Promise<string>

resolvePathOptions

Parameters

Settings

On This Page

Returns Promise<
LoadedConfig & {
configFile: string;
valuesFromConfigFile: OptionsResults<C>;
},
>

Returns Promise<
LoadedConfig & {
configFile: string;
valuesFromConfigFile: OptionsSubset<C>;
},
>