Interface LoadedConfig

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

Hierarchy

  • ReturnType<ReturnType<Awaited<ReturnType<Awaited<ReturnType<ReturnType<TapConfig["loadPluginConfigFields"]>["loadConfigFile"]>>["loadColor"]>>["loadReporter"]>["parse"]>
    • LoadedConfig

Properties

configFile: string

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

globCwd: 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.

jack: Jack<ConfigSetFromMetaSet<"string", true, {
    plugin: {
        default: string[];
        description: string;
        hint: string;
    };
}> & ConfigSetFromMetaSet<"string", false, {
    reporter: {
        description: string;
        hint: string;
        short: string;
    };
    reporter-file: {
        description: string;
        hint: string;
        short: string;
    };
}> & ConfigSetFromMetaSet<"string", true, {
    reporter-arg: {
        description: string;
        hint: string;
        short: string;
    };
}> & ConfigSetFromMetaSet<"string", true, {
    coverage-report: {
        default: string[];
        description: string;
        hint: string;
    };
}> & ConfigSetFromMetaSet<"boolean", false, {
    show-full-coverage: {
        description: string;
    };
}> & ConfigSetFromMetaSet<"string", false, {
    coverage-map: {
        description: string;
        hint: string;
    };
}> & ConfigSetFromMetaSet<"boolean", false, {
    allow-empty-coverage: {
        description: string;
    };
    allow-incomplete-coverage: {
        description: string;
    };
    disable-coverage: {
        description: string;
    };
}> & ConfigSetFromMetaSet<"boolean", false, {
    bail: {
        description: string;
        short: string;
    };
    changed: {
        description: string;
        short: string;
    };
    color: {
        description: string;
        short: string;
    };
    comments: {
        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;
    };
}> & ConfigSetFromMetaSet<"string", false, {
    save: {
        description: string;
        hint: string;
        short: string;
    };
}> & ConfigSetFromMetaSet<"boolean", false, {
    diag: {
        description: string;
    };
    no-diag: {
        description: string;
    };
}> & ConfigSetFromMetaSet<"number", false, {
    timeout: {
        default: number;
        description: string;
        hint: string;
        short: string;
    };
}> & ConfigSetFromMetaSet<"string", true, {
    files: {
        description: string;
        hint: string;
    };
}> & ConfigSetFromMetaSet<"number", false, {
    jobs: {
        default: number;
        description: string;
        hint: string;
        short: string;
    };
}> & ConfigSetFromMetaSet<"string", false, {
    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;
    };
}> & ConfigSetFromMetaSet<"string", true, {
    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;
    };
}> & ConfigSetFromMetaSet<"boolean", false, {
    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;
    };
}> & ConfigSetFromMetaSet<"boolean", false, {
    only: {
        description: string;
        nodeArgs: ((v) => string[]);
        short: string;
        type: string;
    } & {
        default?: boolean;
        description?: string;
        hint?: undefined;
        short?: string;
        type: "boolean";
        validate?: ((v) => v is boolean);
    } & {
        delim?: undefined;
        multiple?: false;
    };
}> & ConfigSetFromMetaSet<"string", true, {
    grep: {
        description: string;
        hint: string;
        multiple: boolean;
        nodeArgs: ((value) => string[]);
        short: string;
        type: string;
    } & {
        default?: string[];
        description?: string;
        hint?: string;
        short?: string;
        type: "string";
        validate?: ((v) => v is string[]);
    } & {
        delim?: string;
        multiple: true;
    };
}> & ConfigSetFromMetaSet<"boolean", false, {
    invert: {
        description: string;
        short: string;
        type: string;
    } & {
        default?: boolean;
        description?: string;
        hint?: undefined;
        short?: string;
        type: "boolean";
        validate?: ((v) => v is boolean);
    } & {
        delim?: undefined;
        multiple?: false;
    };
}> & ConfigSetFromMetaSet<"boolean", false, {
    no-invert: {
        description: string;
        short: string;
        type: string;
    } & {
        default?: boolean;
        description?: string;
        hint?: undefined;
        short?: string;
        type: "boolean";
        validate?: ((v) => v is boolean);
    } & {
        delim?: undefined;
        multiple?: false;
    };
}> & ConfigSetFromMetaSet<"boolean", false, {
    filter-quietly: {
        description: string;
        type: string;
    } & {
        default?: boolean;
        description?: string;
        hint?: undefined;
        short?: string;
        type: "boolean";
        validate?: ((v) => v is boolean);
    } & {
        delim?: undefined;
        multiple?: false;
    };
}> & ConfigSetFromMetaSet<"boolean", false, {
    no-filter-quietly: {
        description: string;
        type: string;
    } & {
        default?: boolean;
        description?: string;
        hint?: undefined;
        short?: string;
        type: "boolean";
        validate?: ((v) => v is boolean);
    } & {
        delim?: undefined;
        multiple?: false;
    };
}> & ConfigSetFromMetaSet<"boolean", false, {
    save-fixture: {
        description: string;
        short: string;
        type: string;
    } & {
        default?: boolean;
        description?: string;
        hint?: undefined;
        short?: string;
        type: "boolean";
        validate?: ((v) => v is boolean);
    } & {
        delim?: undefined;
        multiple?: false;
    };
}> & ConfigSetFromMetaSet<"boolean", false, {
    snapshot: {
        description: string;
        short: string;
        type: string;
    } & {
        default?: boolean;
        description?: string;
        hint?: undefined;
        short?: string;
        type: "boolean";
        validate?: ((v) => v is boolean);
    } & {
        delim?: undefined;
        multiple?: false;
    };
}> & ConfigSetFromMetaSet<"boolean", false, {
    snapshot-clean-cwd: {
        default: boolean;
        description: string;
        type: string;
    } & {
        default?: boolean;
        description?: string;
        hint?: undefined;
        short?: string;
        type: "boolean";
        validate?: ((v) => v is boolean);
    } & {
        delim?: undefined;
        multiple?: false;
    };
}> & ConfigSetFromMetaSet<"boolean", false, {
    no-snapshot-clean-cwd: {
        description: string;
        type: string;
    } & {
        default?: boolean;
        description?: string;
        hint?: undefined;
        short?: string;
        type: "boolean";
        validate?: ((v) => v is boolean);
    } & {
        delim?: undefined;
        multiple?: false;
    };
}> & ConfigSetFromMetaSet<"boolean", false, {
    typecheck: {
        description: string;
        type: string;
    } & {
        default?: boolean;
        description?: string;
        hint?: undefined;
        short?: string;
        type: "boolean";
        validate?: ((v) => v is boolean);
    } & {
        delim?: undefined;
        multiple?: false;
    };
}> & ConfigSetFromMetaSet<"string", false, {
    tsconfig: {
        description: string;
        type: string;
    } & {
        default?: string;
        description?: string;
        hint?: string;
        short?: string;
        type: "string";
        validate?: ((v) => v is string);
    } & {
        delim?: undefined;
        multiple?: false;
    };
}>>

The JackSpeak object representing TAP's configuration

positionals: string[]

positional arguments to the TAP process

testFileExtensions: Set<string> = testFileExtensions

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

values: OptionsResults<ConfigSetFromMetaSet<"string", true, {
    plugin: {
        default: string[];
        description: string;
        hint: string;
    };
}> & ConfigSetFromMetaSet<"string", false, {
    reporter: {
        description: string;
        hint: string;
        short: string;
    };
    reporter-file: {
        description: string;
        hint: string;
        short: string;
    };
}> & ConfigSetFromMetaSet<"string", true, {
    reporter-arg: {
        description: string;
        hint: string;
        short: string;
    };
}> & ConfigSetFromMetaSet<"string", true, {
    coverage-report: {
        default: string[];
        description: string;
        hint: string;
    };
}> & ConfigSetFromMetaSet<"boolean", false, {
    show-full-coverage: {
        description: string;
    };
}> & ConfigSetFromMetaSet<"string", false, {
    coverage-map: {
        description: string;
        hint: string;
    };
}> & ConfigSetFromMetaSet<"boolean", false, {
    allow-empty-coverage: {
        description: string;
    };
    allow-incomplete-coverage: {
        description: string;
    };
    disable-coverage: {
        description: string;
    };
}> & ConfigSetFromMetaSet<"boolean", false, {
    bail: {
        description: string;
        short: string;
    };
    changed: {
        description: string;
        short: string;
    };
    color: {
        description: string;
        short: string;
    };
    comments: {
        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;
    };
}> & ConfigSetFromMetaSet<"string", false, {
    save: {
        description: string;
        hint: string;
        short: string;
    };
}> & ConfigSetFromMetaSet<"boolean", false, {
    diag: {
        description: string;
    };
    no-diag: {
        description: string;
    };
}> & ConfigSetFromMetaSet<"number", false, {
    timeout: {
        default: number;
        description: string;
        hint: string;
        short: string;
    };
}> & ConfigSetFromMetaSet<"string", true, {
    files: {
        description: string;
        hint: string;
    };
}> & ConfigSetFromMetaSet<"number", false, {
    jobs: {
        default: number;
        description: string;
        hint: string;
        short: string;
    };
}> & ConfigSetFromMetaSet<"string", false, {
    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;
    };
}> & ConfigSetFromMetaSet<"string", true, {
    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;
    };
}> & ConfigSetFromMetaSet<"boolean", false, {
    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;
    };
}> & ConfigSetFromMetaSet<"boolean", false, {
    only: {
        description: string;
        nodeArgs: ((v) => string[]);
        short: string;
        type: string;
    } & {
        default?: boolean;
        description?: string;
        hint?: undefined;
        short?: string;
        type: "boolean";
        validate?: ((v) => v is boolean);
    } & {
        delim?: undefined;
        multiple?: false;
    };
}> & ConfigSetFromMetaSet<"string", true, {
    grep: {
        description: string;
        hint: string;
        multiple: boolean;
        nodeArgs: ((value) => string[]);
        short: string;
        type: string;
    } & {
        default?: string[];
        description?: string;
        hint?: string;
        short?: string;
        type: "string";
        validate?: ((v) => v is string[]);
    } & {
        delim?: string;
        multiple: true;
    };
}> & ConfigSetFromMetaSet<"boolean", false, {
    invert: {
        description: string;
        short: string;
        type: string;
    } & {
        default?: boolean;
        description?: string;
        hint?: undefined;
        short?: string;
        type: "boolean";
        validate?: ((v) => v is boolean);
    } & {
        delim?: undefined;
        multiple?: false;
    };
}> & ConfigSetFromMetaSet<"boolean", false, {
    no-invert: {
        description: string;
        short: string;
        type: string;
    } & {
        default?: boolean;
        description?: string;
        hint?: undefined;
        short?: string;
        type: "boolean";
        validate?: ((v) => v is boolean);
    } & {
        delim?: undefined;
        multiple?: false;
    };
}> & ConfigSetFromMetaSet<"boolean", false, {
    filter-quietly: {
        description: string;
        type: string;
    } & {
        default?: boolean;
        description?: string;
        hint?: undefined;
        short?: string;
        type: "boolean";
        validate?: ((v) => v is boolean);
    } & {
        delim?: undefined;
        multiple?: false;
    };
}> & ConfigSetFromMetaSet<"boolean", false, {
    no-filter-quietly: {
        description: string;
        type: string;
    } & {
        default?: boolean;
        description?: string;
        hint?: undefined;
        short?: string;
        type: "boolean";
        validate?: ((v) => v is boolean);
    } & {
        delim?: undefined;
        multiple?: false;
    };
}> & ConfigSetFromMetaSet<"boolean", false, {
    save-fixture: {
        description: string;
        short: string;
        type: string;
    } & {
        default?: boolean;
        description?: string;
        hint?: undefined;
        short?: string;
        type: "boolean";
        validate?: ((v) => v is boolean);
    } & {
        delim?: undefined;
        multiple?: false;
    };
}> & ConfigSetFromMetaSet<"boolean", false, {
    snapshot: {
        description: string;
        short: string;
        type: string;
    } & {
        default?: boolean;
        description?: string;
        hint?: undefined;
        short?: string;
        type: "boolean";
        validate?: ((v) => v is boolean);
    } & {
        delim?: undefined;
        multiple?: false;
    };
}> & ConfigSetFromMetaSet<"boolean", false, {
    snapshot-clean-cwd: {
        default: boolean;
        description: string;
        type: string;
    } & {
        default?: boolean;
        description?: string;
        hint?: undefined;
        short?: string;
        type: "boolean";
        validate?: ((v) => v is boolean);
    } & {
        delim?: undefined;
        multiple?: false;
    };
}> & ConfigSetFromMetaSet<"boolean", false, {
    no-snapshot-clean-cwd: {
        description: string;
        type: string;
    } & {
        default?: boolean;
        description?: string;
        hint?: undefined;
        short?: string;
        type: "boolean";
        validate?: ((v) => v is boolean);
    } & {
        delim?: undefined;
        multiple?: false;
    };
}> & ConfigSetFromMetaSet<"boolean", false, {
    typecheck: {
        description: string;
        type: string;
    } & {
        default?: boolean;
        description?: string;
        hint?: undefined;
        short?: string;
        type: "boolean";
        validate?: ((v) => v is boolean);
    } & {
        delim?: undefined;
        multiple?: false;
    };
}> & ConfigSetFromMetaSet<"string", false, {
    tsconfig: {
        description: string;
        type: string;
    } & {
        default?: string;
        description?: string;
        hint?: string;
        short?: string;
        type: "string";
        validate?: ((v) => v is string);
    } & {
        delim?: undefined;
        multiple?: false;
    };
}>>

Parsed values in effect

valuesFromConfigFile: OptionsResults<ConfigSetFromMetaSet<"string", true, {
    plugin: {
        default: string[];
        description: string;
        hint: string;
    };
}> & ConfigSetFromMetaSet<"string", false, {
    reporter: {
        description: string;
        hint: string;
        short: string;
    };
    reporter-file: {
        description: string;
        hint: string;
        short: string;
    };
}> & ConfigSetFromMetaSet<"string", true, {
    reporter-arg: {
        description: string;
        hint: string;
        short: string;
    };
}> & ConfigSetFromMetaSet<"string", true, {
    coverage-report: {
        default: string[];
        description: string;
        hint: string;
    };
}> & ConfigSetFromMetaSet<"boolean", false, {
    show-full-coverage: {
        description: string;
    };
}> & ConfigSetFromMetaSet<"string", false, {
    coverage-map: {
        description: string;
        hint: string;
    };
}> & ConfigSetFromMetaSet<"boolean", false, {
    allow-empty-coverage: {
        description: string;
    };
    allow-incomplete-coverage: {
        description: string;
    };
    disable-coverage: {
        description: string;
    };
}> & ConfigSetFromMetaSet<"boolean", false, {
    bail: {
        description: string;
        short: string;
    };
    changed: {
        description: string;
        short: string;
    };
    color: {
        description: string;
        short: string;
    };
    comments: {
        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;
    };
}> & ConfigSetFromMetaSet<"string", false, {
    save: {
        description: string;
        hint: string;
        short: string;
    };
}> & ConfigSetFromMetaSet<"boolean", false, {
    diag: {
        description: string;
    };
    no-diag: {
        description: string;
    };
}> & ConfigSetFromMetaSet<"number", false, {
    timeout: {
        default: number;
        description: string;
        hint: string;
        short: string;
    };
}> & ConfigSetFromMetaSet<"string", true, {
    files: {
        description: string;
        hint: string;
    };
}> & ConfigSetFromMetaSet<"number", false, {
    jobs: {
        default: number;
        description: string;
        hint: string;
        short: string;
    };
}> & ConfigSetFromMetaSet<"string", false, {
    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;
    };
}> & ConfigSetFromMetaSet<"string", true, {
    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;
    };
}> & ConfigSetFromMetaSet<"boolean", false, {
    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;
    };
}> & ConfigSetFromMetaSet<"boolean", false, {
    only: {
        description: string;
        nodeArgs: ((v) => string[]);
        short: string;
        type: string;
    } & {
        default?: boolean;
        description?: string;
        hint?: undefined;
        short?: string;
        type: "boolean";
        validate?: ((v) => v is boolean);
    } & {
        delim?: undefined;
        multiple?: false;
    };
}> & ConfigSetFromMetaSet<"string", true, {
    grep: {
        description: string;
        hint: string;
        multiple: boolean;
        nodeArgs: ((value) => string[]);
        short: string;
        type: string;
    } & {
        default?: string[];
        description?: string;
        hint?: string;
        short?: string;
        type: "string";
        validate?: ((v) => v is string[]);
    } & {
        delim?: string;
        multiple: true;
    };
}> & ConfigSetFromMetaSet<"boolean", false, {
    invert: {
        description: string;
        short: string;
        type: string;
    } & {
        default?: boolean;
        description?: string;
        hint?: undefined;
        short?: string;
        type: "boolean";
        validate?: ((v) => v is boolean);
    } & {
        delim?: undefined;
        multiple?: false;
    };
}> & ConfigSetFromMetaSet<"boolean", false, {
    no-invert: {
        description: string;
        short: string;
        type: string;
    } & {
        default?: boolean;
        description?: string;
        hint?: undefined;
        short?: string;
        type: "boolean";
        validate?: ((v) => v is boolean);
    } & {
        delim?: undefined;
        multiple?: false;
    };
}> & ConfigSetFromMetaSet<"boolean", false, {
    filter-quietly: {
        description: string;
        type: string;
    } & {
        default?: boolean;
        description?: string;
        hint?: undefined;
        short?: string;
        type: "boolean";
        validate?: ((v) => v is boolean);
    } & {
        delim?: undefined;
        multiple?: false;
    };
}> & ConfigSetFromMetaSet<"boolean", false, {
    no-filter-quietly: {
        description: string;
        type: string;
    } & {
        default?: boolean;
        description?: string;
        hint?: undefined;
        short?: string;
        type: "boolean";
        validate?: ((v) => v is boolean);
    } & {
        delim?: undefined;
        multiple?: false;
    };
}> & ConfigSetFromMetaSet<"boolean", false, {
    save-fixture: {
        description: string;
        short: string;
        type: string;
    } & {
        default?: boolean;
        description?: string;
        hint?: undefined;
        short?: string;
        type: "boolean";
        validate?: ((v) => v is boolean);
    } & {
        delim?: undefined;
        multiple?: false;
    };
}> & ConfigSetFromMetaSet<"boolean", false, {
    snapshot: {
        description: string;
        short: string;
        type: string;
    } & {
        default?: boolean;
        description?: string;
        hint?: undefined;
        short?: string;
        type: "boolean";
        validate?: ((v) => v is boolean);
    } & {
        delim?: undefined;
        multiple?: false;
    };
}> & ConfigSetFromMetaSet<"boolean", false, {
    snapshot-clean-cwd: {
        default: boolean;
        description: string;
        type: string;
    } & {
        default?: boolean;
        description?: string;
        hint?: undefined;
        short?: string;
        type: "boolean";
        validate?: ((v) => v is boolean);
    } & {
        delim?: undefined;
        multiple?: false;
    };
}> & ConfigSetFromMetaSet<"boolean", false, {
    no-snapshot-clean-cwd: {
        description: string;
        type: string;
    } & {
        default?: boolean;
        description?: string;
        hint?: undefined;
        short?: string;
        type: "boolean";
        validate?: ((v) => v is boolean);
    } & {
        delim?: undefined;
        multiple?: false;
    };
}> & ConfigSetFromMetaSet<"boolean", false, {
    typecheck: {
        description: string;
        type: string;
    } & {
        default?: boolean;
        description?: string;
        hint?: undefined;
        short?: string;
        type: "boolean";
        validate?: ((v) => v is boolean);
    } & {
        delim?: undefined;
        multiple?: false;
    };
}> & ConfigSetFromMetaSet<"string", false, {
    tsconfig: {
        description: string;
        type: string;
    } & {
        default?: string;
        description?: string;
        hint?: string;
        short?: string;
        type: "string";
        validate?: ((v) => v is string);
    } & {
        delim?: undefined;
        multiple?: false;
    };
}>>

values read from the config file, if loaded

Accessors

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

    Returns string[]

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

    Returns string

Methods

  • 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<ConfigSetFromMetaSet<"string", true, {
        plugin: {
            default: string[];
            description: string;
            hint: string;
        };
    }> & ConfigSetFromMetaSet<"string", false, {
        reporter: {
            description: string;
            hint: string;
            short: string;
        };
        reporter-file: {
            description: string;
            hint: string;
            short: string;
        };
    }> & ConfigSetFromMetaSet<"string", true, {
        reporter-arg: {
            description: string;
            hint: string;
            short: string;
        };
    }> & ConfigSetFromMetaSet<"string", true, {
        coverage-report: {
            default: string[];
            description: string;
            hint: string;
        };
    }> & ConfigSetFromMetaSet<"boolean", false, {
        show-full-coverage: {
            description: string;
        };
    }> & ConfigSetFromMetaSet<"string", false, {
        coverage-map: {
            description: string;
            hint: string;
        };
    }> & ConfigSetFromMetaSet<"boolean", false, {
        allow-empty-coverage: {
            description: string;
        };
        allow-incomplete-coverage: {
            description: string;
        };
        disable-coverage: {
            description: string;
        };
    }> & ConfigSetFromMetaSet<"boolean", false, {
        bail: {
            description: string;
            short: string;
        };
        changed: {
            description: string;
            short: string;
        };
        color: {
            description: string;
            short: string;
        };
        comments: {
            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;
        };
    }> & ConfigSetFromMetaSet<"string", false, {
        save: {
            description: string;
            hint: string;
            short: string;
        };
    }> & ConfigSetFromMetaSet<"boolean", false, {
        diag: {
            description: string;
        };
        no-diag: {
            description: string;
        };
    }> & ConfigSetFromMetaSet<"number", false, {
        timeout: {
            default: number;
            description: string;
            hint: string;
            short: string;
        };
    }> & ConfigSetFromMetaSet<"string", true, {
        files: {
            description: string;
            hint: string;
        };
    }> & ConfigSetFromMetaSet<"number", false, {
        jobs: {
            default: number;
            description: string;
            hint: string;
            short: string;
        };
    }> & ConfigSetFromMetaSet<"string", false, {
        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;
        };
    }> & ConfigSetFromMetaSet<"string", true, {
        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;
        };
    }> & ConfigSetFromMetaSet<"boolean", false, {
        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;
        };
    }> & ConfigSetFromMetaSet<"boolean", false, {
        only: {
            description: string;
            nodeArgs: ((v) => string[]);
            short: string;
            type: string;
        } & {
            default?: boolean;
            description?: string;
            hint?: undefined;
            short?: string;
            type: "boolean";
            validate?: ((v) => v is boolean);
        } & {
            delim?: undefined;
            multiple?: false;
        };
    }> & ConfigSetFromMetaSet<"string", true, {
        grep: {
            description: string;
            hint: string;
            multiple: boolean;
            nodeArgs: ((value) => string[]);
            short: string;
            type: string;
        } & {
            default?: string[];
            description?: string;
            hint?: string;
            short?: string;
            type: "string";
            validate?: ((v) => v is string[]);
        } & {
            delim?: string;
            multiple: true;
        };
    }> & ConfigSetFromMetaSet<"boolean", false, {
        invert: {
            description: string;
            short: string;
            type: string;
        } & {
            default?: boolean;
            description?: string;
            hint?: undefined;
            short?: string;
            type: "boolean";
            validate?: ((v) => v is boolean);
        } & {
            delim?: undefined;
            multiple?: false;
        };
    }> & ConfigSetFromMetaSet<"boolean", false, {
        no-invert: {
            description: string;
            short: string;
            type: string;
        } & {
            default?: boolean;
            description?: string;
            hint?: undefined;
            short?: string;
            type: "boolean";
            validate?: ((v) => v is boolean);
        } & {
            delim?: undefined;
            multiple?: false;
        };
    }> & ConfigSetFromMetaSet<"boolean", false, {
        filter-quietly: {
            description: string;
            type: string;
        } & {
            default?: boolean;
            description?: string;
            hint?: undefined;
            short?: string;
            type: "boolean";
            validate?: ((v) => v is boolean);
        } & {
            delim?: undefined;
            multiple?: false;
        };
    }> & ConfigSetFromMetaSet<"boolean", false, {
        no-filter-quietly: {
            description: string;
            type: string;
        } & {
            default?: boolean;
            description?: string;
            hint?: undefined;
            short?: string;
            type: "boolean";
            validate?: ((v) => v is boolean);
        } & {
            delim?: undefined;
            multiple?: false;
        };
    }> & ConfigSetFromMetaSet<"boolean", false, {
        save-fixture: {
            description: string;
            short: string;
            type: string;
        } & {
            default?: boolean;
            description?: string;
            hint?: undefined;
            short?: string;
            type: "boolean";
            validate?: ((v) => v is boolean);
        } & {
            delim?: undefined;
            multiple?: false;
        };
    }> & ConfigSetFromMetaSet<"boolean", false, {
        snapshot: {
            description: string;
            short: string;
            type: string;
        } & {
            default?: boolean;
            description?: string;
            hint?: undefined;
            short?: string;
            type: "boolean";
            validate?: ((v) => v is boolean);
        } & {
            delim?: undefined;
            multiple?: false;
        };
    }> & ConfigSetFromMetaSet<"boolean", false, {
        snapshot-clean-cwd: {
            default: boolean;
            description: string;
            type: string;
        } & {
            default?: boolean;
            description?: string;
            hint?: undefined;
            short?: string;
            type: "boolean";
            validate?: ((v) => v is boolean);
        } & {
            delim?: undefined;
            multiple?: false;
        };
    }> & ConfigSetFromMetaSet<"boolean", false, {
        no-snapshot-clean-cwd: {
            description: string;
            type: string;
        } & {
            default?: boolean;
            description?: string;
            hint?: undefined;
            short?: string;
            type: "boolean";
            validate?: ((v) => v is boolean);
        } & {
            delim?: undefined;
            multiple?: false;
        };
    }> & ConfigSetFromMetaSet<"boolean", false, {
        typecheck: {
            description: string;
            type: string;
        } & {
            default?: boolean;
            description?: string;
            hint?: undefined;
            short?: string;
            type: "boolean";
            validate?: ((v) => v is boolean);
        } & {
            delim?: undefined;
            multiple?: false;
        };
    }> & ConfigSetFromMetaSet<"string", false, {
        tsconfig: {
            description: string;
            type: string;
        } & {
            default?: string;
            description?: string;
            hint?: string;
            short?: string;
            type: "string";
            validate?: ((v) => v is string);
        } & {
            delim?: undefined;
            multiple?: false;
        };
    }> & F>

  • load the file, and write the fields in data. If the file is not present, create it.

    Parameters

    • data: OptionsResults<ConfigSetFromMetaSet<"string", true, {
          plugin: {
              default: string[];
              description: string;
              hint: string;
          };
      }> & ConfigSetFromMetaSet<"string", false, {
          reporter: {
              description: string;
              hint: string;
              short: string;
          };
          reporter-file: {
              description: string;
              hint: string;
              short: string;
          };
      }> & ConfigSetFromMetaSet<"string", true, {
          reporter-arg: {
              description: string;
              hint: string;
              short: string;
          };
      }> & ConfigSetFromMetaSet<"string", true, {
          coverage-report: {
              default: string[];
              description: string;
              hint: string;
          };
      }> & ConfigSetFromMetaSet<"boolean", false, {
          show-full-coverage: {
              description: string;
          };
      }> & ConfigSetFromMetaSet<"string", false, {
          coverage-map: {
              description: string;
              hint: string;
          };
      }> & ConfigSetFromMetaSet<"boolean", false, {
          allow-empty-coverage: {
              description: string;
          };
          allow-incomplete-coverage: {
              description: string;
          };
          disable-coverage: {
              description: string;
          };
      }> & ConfigSetFromMetaSet<"boolean", false, {
          bail: {
              description: string;
              short: string;
          };
          changed: {
              description: string;
              short: string;
          };
          color: {
              description: string;
              short: string;
          };
          comments: {
              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;
          };
      }> & ConfigSetFromMetaSet<"string", false, {
          save: {
              description: string;
              hint: string;
              short: string;
          };
      }> & ConfigSetFromMetaSet<"boolean", false, {
          diag: {
              description: string;
          };
          no-diag: {
              description: string;
          };
      }> & ConfigSetFromMetaSet<"number", false, {
          timeout: {
              default: number;
              description: string;
              hint: string;
              short: string;
          };
      }> & ConfigSetFromMetaSet<"string", true, {
          files: {
              description: string;
              hint: string;
          };
      }> & ConfigSetFromMetaSet<"number", false, {
          jobs: {
              default: number;
              description: string;
              hint: string;
              short: string;
          };
      }> & ConfigSetFromMetaSet<"string", false, {
          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;
          };
      }> & ConfigSetFromMetaSet<"string", true, {
          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;
          };
      }> & ConfigSetFromMetaSet<"boolean", false, {
          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;
          };
      }> & ConfigSetFromMetaSet<"boolean", false, {
          only: {
              description: string;
              nodeArgs: ((v) => string[]);
              short: string;
              type: string;
          } & {
              default?: boolean;
              description?: string;
              hint?: undefined;
              short?: string;
              type: "boolean";
              validate?: ((v) => v is boolean);
          } & {
              delim?: undefined;
              multiple?: false;
          };
      }> & ConfigSetFromMetaSet<"string", true, {
          grep: {
              description: string;
              hint: string;
              multiple: boolean;
              nodeArgs: ((value) => string[]);
              short: string;
              type: string;
          } & {
              default?: string[];
              description?: string;
              hint?: string;
              short?: string;
              type: "string";
              validate?: ((v) => v is string[]);
          } & {
              delim?: string;
              multiple: true;
          };
      }> & ConfigSetFromMetaSet<"boolean", false, {
          invert: {
              description: string;
              short: string;
              type: string;
          } & {
              default?: boolean;
              description?: string;
              hint?: undefined;
              short?: string;
              type: "boolean";
              validate?: ((v) => v is boolean);
          } & {
              delim?: undefined;
              multiple?: false;
          };
      }> & ConfigSetFromMetaSet<"boolean", false, {
          no-invert: {
              description: string;
              short: string;
              type: string;
          } & {
              default?: boolean;
              description?: string;
              hint?: undefined;
              short?: string;
              type: "boolean";
              validate?: ((v) => v is boolean);
          } & {
              delim?: undefined;
              multiple?: false;
          };
      }> & ConfigSetFromMetaSet<"boolean", false, {
          filter-quietly: {
              description: string;
              type: string;
          } & {
              default?: boolean;
              description?: string;
              hint?: undefined;
              short?: string;
              type: "boolean";
              validate?: ((v) => v is boolean);
          } & {
              delim?: undefined;
              multiple?: false;
          };
      }> & ConfigSetFromMetaSet<"boolean", false, {
          no-filter-quietly: {
              description: string;
              type: string;
          } & {
              default?: boolean;
              description?: string;
              hint?: undefined;
              short?: string;
              type: "boolean";
              validate?: ((v) => v is boolean);
          } & {
              delim?: undefined;
              multiple?: false;
          };
      }> & ConfigSetFromMetaSet<"boolean", false, {
          save-fixture: {
              description: string;
              short: string;
              type: string;
          } & {
              default?: boolean;
              description?: string;
              hint?: undefined;
              short?: string;
              type: "boolean";
              validate?: ((v) => v is boolean);
          } & {
              delim?: undefined;
              multiple?: false;
          };
      }> & ConfigSetFromMetaSet<"boolean", false, {
          snapshot: {
              description: string;
              short: string;
              type: string;
          } & {
              default?: boolean;
              description?: string;
              hint?: undefined;
              short?: string;
              type: "boolean";
              validate?: ((v) => v is boolean);
          } & {
              delim?: undefined;
              multiple?: false;
          };
      }> & ConfigSetFromMetaSet<"boolean", false, {
          snapshot-clean-cwd: {
              default: boolean;
              description: string;
              type: string;
          } & {
              default?: boolean;
              description?: string;
              hint?: undefined;
              short?: string;
              type: "boolean";
              validate?: ((v) => v is boolean);
          } & {
              delim?: undefined;
              multiple?: false;
          };
      }> & ConfigSetFromMetaSet<"boolean", false, {
          no-snapshot-clean-cwd: {
              description: string;
              type: string;
          } & {
              default?: boolean;
              description?: string;
              hint?: undefined;
              short?: string;
              type: "boolean";
              validate?: ((v) => v is boolean);
          } & {
              delim?: undefined;
              multiple?: false;
          };
      }> & ConfigSetFromMetaSet<"boolean", false, {
          typecheck: {
              description: string;
              type: string;
          } & {
              default?: boolean;
              description?: string;
              hint?: undefined;
              short?: string;
              type: "boolean";
              validate?: ((v) => v is boolean);
          } & {
              delim?: undefined;
              multiple?: false;
          };
      }> & ConfigSetFromMetaSet<"string", false, {
          tsconfig: {
              description: string;
              type: string;
          } & {
              default?: string;
              description?: string;
              hint?: string;
              short?: string;
              type: "string";
              validate?: ((v) => v is string);
          } & {
              delim?: undefined;
              multiple?: false;
          };
      }>>
    • configFile: undefined | string = ...
    • overwrite: boolean = false

    Returns Promise<void>

  • Edit the "tap" section of a package.json file

    Parameters

    • data: OptionsResults<ConfigSetFromMetaSet<"string", true, {
          plugin: {
              default: string[];
              description: string;
              hint: string;
          };
      }> & ConfigSetFromMetaSet<"string", false, {
          reporter: {
              description: string;
              hint: string;
              short: string;
          };
          reporter-file: {
              description: string;
              hint: string;
              short: string;
          };
      }> & ConfigSetFromMetaSet<"string", true, {
          reporter-arg: {
              description: string;
              hint: string;
              short: string;
          };
      }> & ConfigSetFromMetaSet<"string", true, {
          coverage-report: {
              default: string[];
              description: string;
              hint: string;
          };
      }> & ConfigSetFromMetaSet<"boolean", false, {
          show-full-coverage: {
              description: string;
          };
      }> & ConfigSetFromMetaSet<"string", false, {
          coverage-map: {
              description: string;
              hint: string;
          };
      }> & ConfigSetFromMetaSet<"boolean", false, {
          allow-empty-coverage: {
              description: string;
          };
          allow-incomplete-coverage: {
              description: string;
          };
          disable-coverage: {
              description: string;
          };
      }> & ConfigSetFromMetaSet<"boolean", false, {
          bail: {
              description: string;
              short: string;
          };
          changed: {
              description: string;
              short: string;
          };
          color: {
              description: string;
              short: string;
          };
          comments: {
              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;
          };
      }> & ConfigSetFromMetaSet<"string", false, {
          save: {
              description: string;
              hint: string;
              short: string;
          };
      }> & ConfigSetFromMetaSet<"boolean", false, {
          diag: {
              description: string;
          };
          no-diag: {
              description: string;
          };
      }> & ConfigSetFromMetaSet<"number", false, {
          timeout: {
              default: number;
              description: string;
              hint: string;
              short: string;
          };
      }> & ConfigSetFromMetaSet<"string", true, {
          files: {
              description: string;
              hint: string;
          };
      }> & ConfigSetFromMetaSet<"number", false, {
          jobs: {
              default: number;
              description: string;
              hint: string;
              short: string;
          };
      }> & ConfigSetFromMetaSet<"string", false, {
          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;
          };
      }> & ConfigSetFromMetaSet<"string", true, {
          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;
          };
      }> & ConfigSetFromMetaSet<"boolean", false, {
          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;
          };
      }> & ConfigSetFromMetaSet<"boolean", false, {
          only: {
              description: string;
              nodeArgs: ((v) => string[]);
              short: string;
              type: string;
          } & {
              default?: boolean;
              description?: string;
              hint?: undefined;
              short?: string;
              type: "boolean";
              validate?: ((v) => v is boolean);
          } & {
              delim?: undefined;
              multiple?: false;
          };
      }> & ConfigSetFromMetaSet<"string", true, {
          grep: {
              description: string;
              hint: string;
              multiple: boolean;
              nodeArgs: ((value) => string[]);
              short: string;
              type: string;
          } & {
              default?: string[];
              description?: string;
              hint?: string;
              short?: string;
              type: "string";
              validate?: ((v) => v is string[]);
          } & {
              delim?: string;
              multiple: true;
          };
      }> & ConfigSetFromMetaSet<"boolean", false, {
          invert: {
              description: string;
              short: string;
              type: string;
          } & {
              default?: boolean;
              description?: string;
              hint?: undefined;
              short?: string;
              type: "boolean";
              validate?: ((v) => v is boolean);
          } & {
              delim?: undefined;
              multiple?: false;
          };
      }> & ConfigSetFromMetaSet<"boolean", false, {
          no-invert: {
              description: string;
              short: string;
              type: string;
          } & {
              default?: boolean;
              description?: string;
              hint?: undefined;
              short?: string;
              type: "boolean";
              validate?: ((v) => v is boolean);
          } & {
              delim?: undefined;
              multiple?: false;
          };
      }> & ConfigSetFromMetaSet<"boolean", false, {
          filter-quietly: {
              description: string;
              type: string;
          } & {
              default?: boolean;
              description?: string;
              hint?: undefined;
              short?: string;
              type: "boolean";
              validate?: ((v) => v is boolean);
          } & {
              delim?: undefined;
              multiple?: false;
          };
      }> & ConfigSetFromMetaSet<"boolean", false, {
          no-filter-quietly: {
              description: string;
              type: string;
          } & {
              default?: boolean;
              description?: string;
              hint?: undefined;
              short?: string;
              type: "boolean";
              validate?: ((v) => v is boolean);
          } & {
              delim?: undefined;
              multiple?: false;
          };
      }> & ConfigSetFromMetaSet<"boolean", false, {
          save-fixture: {
              description: string;
              short: string;
              type: string;
          } & {
              default?: boolean;
              description?: string;
              hint?: undefined;
              short?: string;
              type: "boolean";
              validate?: ((v) => v is boolean);
          } & {
              delim?: undefined;
              multiple?: false;
          };
      }> & ConfigSetFromMetaSet<"boolean", false, {
          snapshot: {
              description: string;
              short: string;
              type: string;
          } & {
              default?: boolean;
              description?: string;
              hint?: undefined;
              short?: string;
              type: "boolean";
              validate?: ((v) => v is boolean);
          } & {
              delim?: undefined;
              multiple?: false;
          };
      }> & ConfigSetFromMetaSet<"boolean", false, {
          snapshot-clean-cwd: {
              default: boolean;
              description: string;
              type: string;
          } & {
              default?: boolean;
              description?: string;
              hint?: undefined;
              short?: string;
              type: "boolean";
              validate?: ((v) => v is boolean);
          } & {
              delim?: undefined;
              multiple?: false;
          };
      }> & ConfigSetFromMetaSet<"boolean", false, {
          no-snapshot-clean-cwd: {
              description: string;
              type: string;
          } & {
              default?: boolean;
              description?: string;
              hint?: undefined;
              short?: string;
              type: "boolean";
              validate?: ((v) => v is boolean);
          } & {
              delim?: undefined;
              multiple?: false;
          };
      }> & ConfigSetFromMetaSet<"boolean", false, {
          typecheck: {
              description: string;
              type: string;
          } & {
              default?: boolean;
              description?: string;
              hint?: undefined;
              short?: string;
              type: "boolean";
              validate?: ((v) => v is boolean);
          } & {
              delim?: undefined;
              multiple?: false;
          };
      }> & ConfigSetFromMetaSet<"string", false, {
          tsconfig: {
              description: string;
              type: string;
          } & {
              default?: string;
              description?: string;
              hint?: string;
              short?: string;
              type: "string";
              validate?: ((v) => v is string);
          } & {
              delim?: undefined;
              multiple?: false;
          };
      }>>
    • configFile: string
    • overwrite: boolean = false

    Returns Promise<void>

  • Edit a yaml .taprc file

    Parameters

    • data: OptionsResults<ConfigSetFromMetaSet<"string", true, {
          plugin: {
              default: string[];
              description: string;
              hint: string;
          };
      }> & ConfigSetFromMetaSet<"string", false, {
          reporter: {
              description: string;
              hint: string;
              short: string;
          };
          reporter-file: {
              description: string;
              hint: string;
              short: string;
          };
      }> & ConfigSetFromMetaSet<"string", true, {
          reporter-arg: {
              description: string;
              hint: string;
              short: string;
          };
      }> & ConfigSetFromMetaSet<"string", true, {
          coverage-report: {
              default: string[];
              description: string;
              hint: string;
          };
      }> & ConfigSetFromMetaSet<"boolean", false, {
          show-full-coverage: {
              description: string;
          };
      }> & ConfigSetFromMetaSet<"string", false, {
          coverage-map: {
              description: string;
              hint: string;
          };
      }> & ConfigSetFromMetaSet<"boolean", false, {
          allow-empty-coverage: {
              description: string;
          };
          allow-incomplete-coverage: {
              description: string;
          };
          disable-coverage: {
              description: string;
          };
      }> & ConfigSetFromMetaSet<"boolean", false, {
          bail: {
              description: string;
              short: string;
          };
          changed: {
              description: string;
              short: string;
          };
          color: {
              description: string;
              short: string;
          };
          comments: {
              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;
          };
      }> & ConfigSetFromMetaSet<"string", false, {
          save: {
              description: string;
              hint: string;
              short: string;
          };
      }> & ConfigSetFromMetaSet<"boolean", false, {
          diag: {
              description: string;
          };
          no-diag: {
              description: string;
          };
      }> & ConfigSetFromMetaSet<"number", false, {
          timeout: {
              default: number;
              description: string;
              hint: string;
              short: string;
          };
      }> & ConfigSetFromMetaSet<"string", true, {
          files: {
              description: string;
              hint: string;
          };
      }> & ConfigSetFromMetaSet<"number", false, {
          jobs: {
              default: number;
              description: string;
              hint: string;
              short: string;
          };
      }> & ConfigSetFromMetaSet<"string", false, {
          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;
          };
      }> & ConfigSetFromMetaSet<"string", true, {
          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;
          };
      }> & ConfigSetFromMetaSet<"boolean", false, {
          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;
          };
      }> & ConfigSetFromMetaSet<"boolean", false, {
          only: {
              description: string;
              nodeArgs: ((v) => string[]);
              short: string;
              type: string;
          } & {
              default?: boolean;
              description?: string;
              hint?: undefined;
              short?: string;
              type: "boolean";
              validate?: ((v) => v is boolean);
          } & {
              delim?: undefined;
              multiple?: false;
          };
      }> & ConfigSetFromMetaSet<"string", true, {
          grep: {
              description: string;
              hint: string;
              multiple: boolean;
              nodeArgs: ((value) => string[]);
              short: string;
              type: string;
          } & {
              default?: string[];
              description?: string;
              hint?: string;
              short?: string;
              type: "string";
              validate?: ((v) => v is string[]);
          } & {
              delim?: string;
              multiple: true;
          };
      }> & ConfigSetFromMetaSet<"boolean", false, {
          invert: {
              description: string;
              short: string;
              type: string;
          } & {
              default?: boolean;
              description?: string;
              hint?: undefined;
              short?: string;
              type: "boolean";
              validate?: ((v) => v is boolean);
          } & {
              delim?: undefined;
              multiple?: false;
          };
      }> & ConfigSetFromMetaSet<"boolean", false, {
          no-invert: {
              description: string;
              short: string;
              type: string;
          } & {
              default?: boolean;
              description?: string;
              hint?: undefined;
              short?: string;
              type: "boolean";
              validate?: ((v) => v is boolean);
          } & {
              delim?: undefined;
              multiple?: false;
          };
      }> & ConfigSetFromMetaSet<"boolean", false, {
          filter-quietly: {
              description: string;
              type: string;
          } & {
              default?: boolean;
              description?: string;
              hint?: undefined;
              short?: string;
              type: "boolean";
              validate?: ((v) => v is boolean);
          } & {
              delim?: undefined;
              multiple?: false;
          };
      }> & ConfigSetFromMetaSet<"boolean", false, {
          no-filter-quietly: {
              description: string;
              type: string;
          } & {
              default?: boolean;
              description?: string;
              hint?: undefined;
              short?: string;
              type: "boolean";
              validate?: ((v) => v is boolean);
          } & {
              delim?: undefined;
              multiple?: false;
          };
      }> & ConfigSetFromMetaSet<"boolean", false, {
          save-fixture: {
              description: string;
              short: string;
              type: string;
          } & {
              default?: boolean;
              description?: string;
              hint?: undefined;
              short?: string;
              type: "boolean";
              validate?: ((v) => v is boolean);
          } & {
              delim?: undefined;
              multiple?: false;
          };
      }> & ConfigSetFromMetaSet<"boolean", false, {
          snapshot: {
              description: string;
              short: string;
              type: string;
          } & {
              default?: boolean;
              description?: string;
              hint?: undefined;
              short?: string;
              type: "boolean";
              validate?: ((v) => v is boolean);
          } & {
              delim?: undefined;
              multiple?: false;
          };
      }> & ConfigSetFromMetaSet<"boolean", false, {
          snapshot-clean-cwd: {
              default: boolean;
              description: string;
              type: string;
          } & {
              default?: boolean;
              description?: string;
              hint?: undefined;
              short?: string;
              type: "boolean";
              validate?: ((v) => v is boolean);
          } & {
              delim?: undefined;
              multiple?: false;
          };
      }> & ConfigSetFromMetaSet<"boolean", false, {
          no-snapshot-clean-cwd: {
              description: string;
              type: string;
          } & {
              default?: boolean;
              description?: string;
              hint?: undefined;
              short?: string;
              type: "boolean";
              validate?: ((v) => v is boolean);
          } & {
              delim?: undefined;
              multiple?: false;
          };
      }> & ConfigSetFromMetaSet<"boolean", false, {
          typecheck: {
              description: string;
              type: string;
          } & {
              default?: boolean;
              description?: string;
              hint?: undefined;
              short?: string;
              type: "boolean";
              validate?: ((v) => v is boolean);
          } & {
              delim?: undefined;
              multiple?: false;
          };
      }> & ConfigSetFromMetaSet<"string", false, {
          tsconfig: {
              description: string;
              type: string;
          } & {
              default?: string;
              description?: string;
              hint?: string;
              short?: string;
              type: "string";
              validate?: ((v) => v is string);
          } & {
              delim?: undefined;
              multiple?: false;
          };
      }>>
    • configFile: string
    • overwrite: boolean = false

    Returns Promise<void>

  • replace EXTENSIONS in a glob with the actual testFileExtensions

    Parameters

    • inc: string

    Returns string

  • Apply the extension from a resolved extends field in the config.

    Parameters

    • data: Record<string, any>
    • file: string

    Returns Promise<void>

  • Get a configuration value, as we currently know it

    Type Parameters

    • K extends "plugin" | "reporter" | "reporter-file" | "reporter-arg" | "coverage-report" | "show-full-coverage" | "coverage-map" | "allow-empty-coverage" | "allow-incomplete-coverage" | "disable-coverage" | "bail" | "no-bail" | "comments" | "passes" | "fail-todo" | "fail-skip" | "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"

    Parameters

    • k: K

    Returns OptionsResults<ConfigSetFromMetaSet<"string", true, {
        plugin: {
            default: string[];
            description: string;
            hint: string;
        };
    }> & ConfigSetFromMetaSet<"string", false, {
        reporter: {
            description: string;
            hint: string;
            short: string;
        };
        reporter-file: {
            description: string;
            hint: string;
            short: string;
        };
    }> & ConfigSetFromMetaSet<"string", true, {
        reporter-arg: {
            description: string;
            hint: string;
            short: string;
        };
    }> & ConfigSetFromMetaSet<"string", true, {
        coverage-report: {
            default: string[];
            description: string;
            hint: string;
        };
    }> & ConfigSetFromMetaSet<"boolean", false, {
        show-full-coverage: {
            description: string;
        };
    }> & ConfigSetFromMetaSet<"string", false, {
        coverage-map: {
            description: string;
            hint: string;
        };
    }> & ConfigSetFromMetaSet<"boolean", false, {
        allow-empty-coverage: {
            description: string;
        };
        allow-incomplete-coverage: {
            description: string;
        };
        disable-coverage: {
            description: string;
        };
    }> & ConfigSetFromMetaSet<"boolean", false, {
        bail: {
            description: string;
            short: string;
        };
        changed: {
            description: string;
            short: string;
        };
        color: {
            description: string;
            short: string;
        };
        comments: {
            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;
        };
    }> & ConfigSetFromMetaSet<"string", false, {
        save: {
            description: string;
            hint: string;
            short: string;
        };
    }> & ConfigSetFromMetaSet<"boolean", false, {
        diag: {
            description: string;
        };
        no-diag: {
            description: string;
        };
    }> & ConfigSetFromMetaSet<"number", false, {
        timeout: {
            default: number;
            description: string;
            hint: string;
            short: string;
        };
    }> & ConfigSetFromMetaSet<"string", true, {
        files: {
            description: string;
            hint: string;
        };
    }> & ConfigSetFromMetaSet<"number", false, {
        jobs: {
            default: number;
            description: string;
            hint: string;
            short: string;
        };
    }> & ConfigSetFromMetaSet<"string", false, {
        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;
        };
    }> & ConfigSetFromMetaSet<"string", true, {
        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;
        };
    }> & ConfigSetFromMetaSet<"boolean", false, {
        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;
        };
    }> & ConfigSetFromMetaSet<"boolean", false, {
        only: {
            description: string;
            nodeArgs: ((v) => string[]);
            short: string;
            type: string;
        } & {
            default?: boolean;
            description?: string;
            hint?: undefined;
            short?: string;
            type: "boolean";
            validate?: ((v) => v is boolean);
        } & {
            delim?: undefined;
            multiple?: false;
        };
    }> & ConfigSetFromMetaSet<"string", true, {
        grep: {
            description: string;
            hint: string;
            multiple: boolean;
            nodeArgs: ((value) => string[]);
            short: string;
            type: string;
        } & {
            default?: string[];
            description?: string;
            hint?: string;
            short?: string;
            type: "string";
            validate?: ((v) => v is string[]);
        } & {
            delim?: string;
            multiple: true;
        };
    }> & ConfigSetFromMetaSet<"boolean", false, {
        invert: {
            description: string;
            short: string;
            type: string;
        } & {
            default?: boolean;
            description?: string;
            hint?: undefined;
            short?: string;
            type: "boolean";
            validate?: ((v) => v is boolean);
        } & {
            delim?: undefined;
            multiple?: false;
        };
    }> & ConfigSetFromMetaSet<"boolean", false, {
        no-invert: {
            description: string;
            short: string;
            type: string;
        } & {
            default?: boolean;
            description?: string;
            hint?: undefined;
            short?: string;
            type: "boolean";
            validate?: ((v) => v is boolean);
        } & {
            delim?: undefined;
            multiple?: false;
        };
    }> & ConfigSetFromMetaSet<"boolean", false, {
        filter-quietly: {
            description: string;
            type: string;
        } & {
            default?: boolean;
            description?: string;
            hint?: undefined;
            short?: string;
            type: "boolean";
            validate?: ((v) => v is boolean);
        } & {
            delim?: undefined;
            multiple?: false;
        };
    }> & ConfigSetFromMetaSet<"boolean", false, {
        no-filter-quietly: {
            description: string;
            type: string;
        } & {
            default?: boolean;
            description?: string;
            hint?: undefined;
            short?: string;
            type: "boolean";
            validate?: ((v) => v is boolean);
        } & {
            delim?: undefined;
            multiple?: false;
        };
    }> & ConfigSetFromMetaSet<"boolean", false, {
        save-fixture: {
            description: string;
            short: string;
            type: string;
        } & {
            default?: boolean;
            description?: string;
            hint?: undefined;
            short?: string;
            type: "boolean";
            validate?: ((v) => v is boolean);
        } & {
            delim?: undefined;
            multiple?: false;
        };
    }> & ConfigSetFromMetaSet<"boolean", false, {
        snapshot: {
            description: string;
            short: string;
            type: string;
        } & {
            default?: boolean;
            description?: string;
            hint?: undefined;
            short?: string;
            type: "boolean";
            validate?: ((v) => v is boolean);
        } & {
            delim?: undefined;
            multiple?: false;
        };
    }> & ConfigSetFromMetaSet<"boolean", false, {
        snapshot-clean-cwd: {
            default: boolean;
            description: string;
            type: string;
        } & {
            default?: boolean;
            description?: string;
            hint?: undefined;
            short?: string;
            type: "boolean";
            validate?: ((v) => v is boolean);
        } & {
            delim?: undefined;
            multiple?: false;
        };
    }> & ConfigSetFromMetaSet<"boolean", false, {
        no-snapshot-clean-cwd: {
            description: string;
            type: string;
        } & {
            default?: boolean;
            description?: string;
            hint?: undefined;
            short?: string;
            type: "boolean";
            validate?: ((v) => v is boolean);
        } & {
            delim?: undefined;
            multiple?: false;
        };
    }> & ConfigSetFromMetaSet<"boolean", false, {
        typecheck: {
            description: string;
            type: string;
        } & {
            default?: boolean;
            description?: string;
            hint?: undefined;
            short?: string;
            type: "boolean";
            validate?: ((v) => v is boolean);
        } & {
            delim?: undefined;
            multiple?: false;
        };
    }> & ConfigSetFromMetaSet<"string", false, {
        tsconfig: {
            description: string;
            type: string;
        } & {
            default?: string;
            description?: string;
            hint?: string;
            short?: string;
            type: "string";
            validate?: ((v) => v is string);
        } & {
            delim?: undefined;
            multiple?: false;
        };
    }>>[K]

  • Load some configuration fields from a config file

    Parameters

    • data: any
    • configFile: string

    Returns Promise<LoadedConfig & {
        configFile: string;
        valuesFromConfigFile: OptionsResults<ConfigSetFromMetaSet<"string", true, {
            plugin: {
                default: string[];
                description: string;
                hint: string;
            };
        }> & ConfigSetFromMetaSet<"string", false, {
            reporter: {
                description: string;
                hint: string;
                short: string;
            };
            reporter-file: {
                description: string;
                hint: string;
                short: string;
            };
        }> & ConfigSetFromMetaSet<"string", true, {
            reporter-arg: {
                description: string;
                hint: string;
                short: string;
            };
        }> & ConfigSetFromMetaSet<"string", true, {
            coverage-report: {
                default: string[];
                description: string;
                hint: string;
            };
        }> & ConfigSetFromMetaSet<"boolean", false, {
            show-full-coverage: {
                description: string;
            };
        }> & ConfigSetFromMetaSet<"string", false, {
            coverage-map: {
                description: string;
                hint: string;
            };
        }> & ConfigSetFromMetaSet<"boolean", false, {
            allow-empty-coverage: {
                description: string;
            };
            allow-incomplete-coverage: {
                description: string;
            };
            disable-coverage: {
                description: string;
            };
        }> & ConfigSetFromMetaSet<"boolean", false, {
            bail: {
                description: string;
                short: string;
            };
            changed: {
                description: string;
                short: string;
            };
            color: {
                description: string;
                short: string;
            };
            comments: {
                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;
            };
        }> & ConfigSetFromMetaSet<"string", false, {
            save: {
                description: string;
                hint: string;
                short: string;
            };
        }> & ConfigSetFromMetaSet<"boolean", false, {
            diag: {
                description: string;
            };
            no-diag: {
                description: string;
            };
        }> & ConfigSetFromMetaSet<"number", false, {
            timeout: {
                default: number;
                description: string;
                hint: string;
                short: string;
            };
        }> & ConfigSetFromMetaSet<"string", true, {
            files: {
                description: string;
                hint: string;
            };
        }> & ConfigSetFromMetaSet<"number", false, {
            jobs: {
                default: number;
                description: string;
                hint: string;
                short: string;
            };
        }> & ConfigSetFromMetaSet<"string", false, {
            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;
            };
        }> & ConfigSetFromMetaSet<"string", true, {
            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;
            };
        }> & ConfigSetFromMetaSet<"boolean", false, {
            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;
            };
        }> & ConfigSetFromMetaSet<"boolean", false, {
            only: {
                description: string;
                nodeArgs: ((v) => string[]);
                short: string;
                type: string;
            } & {
                default?: boolean;
                description?: string;
                hint?: undefined;
                short?: string;
                type: "boolean";
                validate?: ((v) => v is boolean);
            } & {
                delim?: undefined;
                multiple?: false;
            };
        }> & ConfigSetFromMetaSet<"string", true, {
            grep: {
                description: string;
                hint: string;
                multiple: boolean;
                nodeArgs: ((value) => string[]);
                short: string;
                type: string;
            } & {
                default?: string[];
                description?: string;
                hint?: string;
                short?: string;
                type: "string";
                validate?: ((v) => v is string[]);
            } & {
                delim?: string;
                multiple: true;
            };
        }> & ConfigSetFromMetaSet<"boolean", false, {
            invert: {
                description: string;
                short: string;
                type: string;
            } & {
                default?: boolean;
                description?: string;
                hint?: undefined;
                short?: string;
                type: "boolean";
                validate?: ((v) => v is boolean);
            } & {
                delim?: undefined;
                multiple?: false;
            };
        }> & ConfigSetFromMetaSet<"boolean", false, {
            no-invert: {
                description: string;
                short: string;
                type: string;
            } & {
                default?: boolean;
                description?: string;
                hint?: undefined;
                short?: string;
                type: "boolean";
                validate?: ((v) => v is boolean);
            } & {
                delim?: undefined;
                multiple?: false;
            };
        }> & ConfigSetFromMetaSet<"boolean", false, {
            filter-quietly: {
                description: string;
                type: string;
            } & {
                default?: boolean;
                description?: string;
                hint?: undefined;
                short?: string;
                type: "boolean";
                validate?: ((v) => v is boolean);
            } & {
                delim?: undefined;
                multiple?: false;
            };
        }> & ConfigSetFromMetaSet<"boolean", false, {
            no-filter-quietly: {
                description: string;
                type: string;
            } & {
                default?: boolean;
                description?: string;
                hint?: undefined;
                short?: string;
                type: "boolean";
                validate?: ((v) => v is boolean);
            } & {
                delim?: