Class TapConfig<C>

Class that handles configuration for TAP.

Typically, @tapjs/config!index.TapConfig.load is the way to get one of these.

Type Parameters

Constructors

constructor

Properties

configFile? globCwd jack positionals? testFileExtensions values? valuesFromConfigFile? #loaded

Accessors

pluginList pluginSignature

Methods

addFields editConfigFile editPackageJsonConfig editYAMLConfig expandInclude extendConfigData get loadColor loadConfigData loadConfigFile loadPluginConfigFields loadReporter parse readDepConfig readPackageJson readPackageJsonConfig readYAMLConfig resolveExtension load

Constructors

constructor

  • new TapConfig<C>(jack?): TapConfig<C>

  • Type Parameters

    • C extends ConfigSet = 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;
          };
      }>

    Parameters

    • jack: Jack<C> = baseConfig

    Returns TapConfig<C>

Properties

Optional 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.

globCwd

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: Jack<C>

The JackSpeak object representing TAP's configuration

Optional positionals

positionals?: string[]

positional arguments to the TAP process

testFileExtensions

testFileExtensions: Set<string> = testFileExtensions

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

Optional values

values?: OptionsResults<C>

Parsed values in effect

Optional valuesFromConfigFile

valuesFromConfigFile?: OptionsResults<C>

values read from the config file, if loaded

Private Static #loaded

#loaded: undefined | LoadedConfig

cache of the loaded config

Accessors

pluginList

  • get pluginList(): string[]

  • The list of all plugins that ought to be loaded.

    Returns string[]

pluginSignature

  • get pluginSignature(): string

  • The signature of all plugin modules that ought to be loaded.

    Returns string

Methods

addFields

editConfigFile

  • editConfigFile(data, configFile?, overwrite?): Promise<void>

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

    Parameters

    • data: OptionsResults<C>
    • configFile: undefined | string = ...
    • overwrite: boolean = false

    Returns Promise<void>

editPackageJsonConfig

  • editPackageJsonConfig(data, configFile, overwrite?): Promise<void>

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

    Parameters

    • data: OptionsResults<C>
    • configFile: string
    • overwrite: boolean = false

    Returns Promise<void>

editYAMLConfig

  • editYAMLConfig(data, configFile, overwrite?): Promise<void>

  • Edit a yaml .taprc file

    Parameters

    • data: OptionsResults<C>
    • configFile: string
    • overwrite: boolean = false

    Returns Promise<void>

expandInclude

  • expandInclude(inc): string

  • replace EXTENSIONS in a glob with the actual testFileExtensions

    Parameters

    • inc: string

    Returns string

extendConfigData

  • extendConfigData(data, file): Promise<void>

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

    Parameters

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

    Returns Promise<void>

get

  • get<K>(k): OptionsResults<C>[K]

  • Get a configuration value, as we currently know it

    Type Parameters

    • K extends string | number | symbol

    Parameters

    Returns OptionsResults<C>[K]

loadColor

loadConfigData

  • loadConfigData(data, configFile): Promise<TapConfig<C> & {
        configFile: string;
        valuesFromConfigFile: OptionsResults<C>;
    }>

  • Load some configuration fields from a config file

    Parameters

    • data: any
    • configFile: string

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

loadConfigFile

  • loadConfigFile(): Promise<TapConfig<C> & {
        configFile: string;
        valuesFromConfigFile: OptionsResults<C>;
    }>

  • Load configuration from a file

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

loadPluginConfigFields

  • loadPluginConfigFields(): TapConfig<C & 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;
        };
    }>>

  • Load configuration fields exported by active plugins

    Returns TapConfig<C & 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;
        };
    }>>

loadReporter

  • loadReporter(): TapConfig<C>

  • 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 TapConfig<C>

parse

  • parse(args?): TapConfig<C> & {
        positionals: string[];
        values: OptionsResults<C>;
    }

  • Parse the arguments and set configuration and positionals accordingly.

    Parameters

    • args: string[] = argv

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

readDepConfig

  • readDepConfig(file): Promise<undefined | OptionsResults<C>>

  • Read the configuration from a dependency

    Parameters

    • file: string

    Returns Promise<undefined | OptionsResults<C>>

readPackageJson

  • readPackageJson(pj, silent?): Promise<undefined | {
        tap?: OptionsResults<C>;
    }>

  • Read a package.json file

    Parameters

    • pj: string
    • silent: boolean = false

    Returns Promise<undefined | {
        tap?: OptionsResults<C>;
    }>

readPackageJsonConfig

  • readPackageJsonConfig(pj): Promise<undefined | OptionsResults<C>>

  • Read the configuration from the "tap" object in a package.json file

    Parameters

    • pj: string

    Returns Promise<undefined | OptionsResults<C>>

readYAMLConfig

  • readYAMLConfig(rc, silent?): Promise<undefined | OptionsResults<C>>

  • Read configuration from a yaml .taprc file

    Parameters

    • rc: string
    • silent: boolean = false

    Returns Promise<undefined | OptionsResults<C>>

resolveExtension

  • resolveExtension(ext, file): Promise<string>

  • Resolve the source of an extends field in TAP configs

    Parameters

    • ext: string
    • file: string

    Returns Promise<string>

Static load

Settings

Member Visibility

Theme

On This Page

constructorconfigFileglobCwdjackpositionalstestFileExtensionsvaluesvaluesFromConfigFile#loadedpluginListpluginSignatureaddFieldseditConfigFileeditPackageJsonConfigeditYAMLConfigexpandIncludeextendConfigDatagetloadColorloadConfigDataloadConfigFileloadPluginConfigFieldsloadReporterparsereadDepConfigreadPackageJsonreadPackageJsonConfigreadYAMLConfigresolveExtensionload

Generated using TypeDoc