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

C extends ConfigSet = BaseConfigSet

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, {
      browser: {
          default: true;
          description: string;
      };
      no-browser: {
          description: string;
      };
      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-only: {
          description: string;
      };
      fail-skip: {
          description: string;
      };
      fail-todo: {
          description: string;
      };
      no-bail: {
          description: string;
          short: string;
      };
      no-color: {
          description: string;
          short: string;
      };
      passes: {
          description: string;
      };
  }> & 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> = ...
Returns TapConfig<C>
- Defined in config/src/index.ts:90

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.

jack

jack: Jack<C>

The JackSpeak object representing TAP's configuration

`Optional`positionals

positionals?: string[]

positional arguments to the TAP process

projectRoot

projectRoot: string = cwd

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

testFileExtensions

testFileExtensions: Set<string> = testFileExtensions

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

`Optional`values

values?: OptionsResults<C>

Parsed values in effect

`Optional`valuesFromConfigFile

valuesFromConfigFile?: OptionsResults<C>

values read from the config file, if loaded

Accessors

pluginList

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

Returns string[]
- Defined in config/src/index.ts:489

pluginSignature

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

Returns string
- Defined in config/src/index.ts:479

Methods

addFields

addFields<F>(fields): TapConfig<C & F>
Add fields to the config set. Used when loading plugins that export a config object.
Type Parameters
- F extends ConfigSet
Parameters
- fields: F
Returns TapConfig<C & F>
- Defined in config/src/index.ts:149

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>
- Defined in config/src/index.ts:164

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>
- Defined in config/src/index.ts:213

editYAMLConfig

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

expandInclude

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

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>
- Defined in config/src/index.ts:365

get

get<K>(k): OptionsResults<C>[K]
Get a configuration value, as we currently know it
Type Parameters
- K extends string | number | symbol
Parameters
- k: K
Returns OptionsResults<C>[K]
- Defined in config/src/index.ts:134

loadColor

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

Returns Promise<TapConfig<C>>
- Defined in config/src/index.ts:508

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>;
}>
- Defined in config/src/index.ts:343

loadConfigFile

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

Returns Promise<TapConfig<C> & {
configFile: string;
valuesFromConfigFile: OptionsResults<C>;
}>
- Defined in config/src/index.ts:411

loadPluginConfigFields

loadPluginConfigFields(): TapConfig<C & ConfigSetFromMetaSet<"boolean", false, {
    only: {
        description: string;
        nodeArgs: ((v: boolean) => string[]);
        short: string;
        type: string;
    } & {
        default?: boolean;
        description?: string;
        hint?: undefined;
        short?: string;
        type: "boolean";
        validOptions?: undefined;
        validate?: ((v: unknown) => v is boolean);
    } & {
        delim?: undefined;
        multiple?: false;
    };
}> & ConfigSetFromMetaSet<"string", true, {
    grep: {
        description: string;
        hint: string;
        multiple: boolean;
        nodeArgs: ((value: string[]) => string[]);
        short: string;
        type: string;
    } & {
        default?: string[];
        description?: string;
        hint?: string;
        short?: string;
        type: "string";
        validOptions?: readonly string[];
        validate?: ((v: unknown) => 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";
        validOptions?: undefined;
        validate?: ((v: unknown) => 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";
        validOptions?: undefined;
        validate?: ((v: unknown) => 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";
        validOptions?: undefined;
        validate?: ((v: unknown) => 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";
        validOptions?: undefined;
        validate?: ((v: unknown) => 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";
        validOptions?: undefined;
        validate?: ((v: unknown) => 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";
        validOptions?: undefined;
        validate?: ((v: unknown) => 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";
        validOptions?: undefined;
        validate?: ((v: unknown) => 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";
        validOptions?: undefined;
        validate?: ((v: unknown) => 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";
        validOptions?: undefined;
        validate?: ((v: unknown) => 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";
        validOptions?: readonly string[];
        validate?: ((v: unknown) => 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: boolean) => string[]);
        short: string;
        type: string;
    } & {
        default?: boolean;
        description?: string;
        hint?: undefined;
        short?: string;
        type: "boolean";
        validOptions?: undefined;
        validate?: ((v: unknown) => v is boolean);
    } & {
        delim?: undefined;
        multiple?: false;
    };
}> & ConfigSetFromMetaSet<"string", true, {
    grep: {
        description: string;
        hint: string;
        multiple: boolean;
        nodeArgs: ((value: string[]) => string[]);
        short: string;
        type: string;
    } & {
        default?: string[];
        description?: string;
        hint?: string;
        short?: string;
        type: "string";
        validOptions?: readonly string[];
        validate?: ((v: unknown) => 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";
        validOptions?: undefined;
        validate?: ((v: unknown) => 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";
        validOptions?: undefined;
        validate?: ((v: unknown) => 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";
        validOptions?: undefined;
        validate?: ((v: unknown) => 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";
        validOptions?: undefined;
        validate?: ((v: unknown) => 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";
        validOptions?: undefined;
        validate?: ((v: unknown) => 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";
        validOptions?: undefined;
        validate?: ((v: unknown) => 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";
        validOptions?: undefined;
        validate?: ((v: unknown) => 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";
        validOptions?: undefined;
        validate?: ((v: unknown) => 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";
        validOptions?: undefined;
        validate?: ((v: unknown) => 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";
        validOptions?: readonly string[];
        validate?: ((v: unknown) => v is string);
    } & {
        delim?: undefined;
        multiple?: false;
    };
}>>
- Defined in config/src/index.ts:156

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>
- Defined in config/src/index.ts:537

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>;
}
- Defined in config/src/index.ts:97

readDepConfig

readDepConfig(file): Promise<undefined | OptionsResults<C>>
Read the configuration from a dependency
Parameters
- file: string
Returns Promise<undefined | OptionsResults<C>>
- Defined in config/src/index.ts:306

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>;
}>
- Defined in config/src/index.ts:254

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>>
- Defined in config/src/index.ts:277

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>>
- Defined in config/src/index.ts:233

resolveExtension

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

resolvePathOptions

resolvePathOptions(conf, file): undefined | OptionsResults<C>
Parameters
- conf: undefined | OptionsResults<C>
- file: string
Returns undefined | OptionsResults<C>
- Defined in config/src/index.ts:288

`Static`load

load(): Promise<LoadedConfig>
Load the configuration and return a Promise to a @tapjs/config!index.TapConfig object

Returns Promise<LoadedConfig>
- Defined in config/src/index.ts:555

Class TapConfig<C>

Type Parameters

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns TapConfig<C>

Properties

OptionalconfigFile

jack

Optionalpositionals

projectRoot

testFileExtensions

Optionalvalues

OptionalvaluesFromConfigFile

Accessors

pluginList

Returns string[]

pluginSignature

Returns string

Methods

addFields

Type Parameters

Parameters

Returns TapConfig<C & F>

editConfigFile

Parameters

Returns Promise<void>

editPackageJsonConfig

Parameters

Returns Promise<void>

editYAMLConfig

Parameters

Returns Promise<void>

expandInclude

Parameters

Returns string

extendConfigData

Parameters

Returns Promise<void>

get

Type Parameters

Parameters

Returns OptionsResults<C>[K]

loadColor

Returns Promise<TapConfig<C>>

loadConfigData

Parameters

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

loadConfigFile

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

loadPluginConfigFields

loadReporter

Returns TapConfig<C>

parse

Parameters

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

readDepConfig

Parameters

Returns Promise<undefined | OptionsResults<C>>

readPackageJson

Parameters

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

readPackageJsonConfig

Parameters

Returns Promise<undefined | OptionsResults<C>>

readYAMLConfig

Parameters

Returns Promise<undefined | OptionsResults<C>>

resolveExtension

Parameters

Returns Promise<string>

resolvePathOptions

Parameters

Returns undefined | OptionsResults<C>

`Optional`configFile

`Optional`positionals

`Optional`values

`Optional`valuesFromConfigFile

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

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

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

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

`Static`load