Class ProjectJestConfig

Configuration of project tests utilizing Jest.

Hierarchy (view full)

ProjectDevTool
- ProjectJestConfig

Index

Constructors

constructor

new ProjectJestConfig(project): ProjectJestConfig
Constructs project tests configuration.
Parameters
- project: ProjectConfig
  Configured project.
Returns ProjectJestConfig
Overrides ProjectDevTool.constructor
- Defined in run-z/project-config/src/jest/project-jest-config.ts:72

Accessors

autogenerated

get autogenerated(): boolean
Whether options generated automatically prior to applying custom ones.

true by default.

Returns boolean
- Defined in run-z/project-config/src/jest/project-jest-config.ts:98

jest

get jest(): Promise<__module>
Jest API instance.

Returns Promise<__module>
- Defined in run-z/project-config/src/jest/project-jest-config.ts:89

options

get options(): Promise<Partial<{
    automock: boolean;
    bail: number | boolean;
    cache: boolean;
    cacheDirectory: string;
    changedFilesWithAncestor: boolean;
    changedSince: string;
    ci: boolean;
    clearMocks: boolean;
    collectCoverage: boolean;
    collectCoverageFrom: string[];
    coverageDirectory: string;
    coveragePathIgnorePatterns: string[];
    coverageProvider: CoverageProvider;
    coverageReporters: CoverageReporters;
    coverageThreshold: CoverageThreshold;
    dependencyExtractor: string;
    detectLeaks: boolean;
    detectOpenHandles: boolean;
    displayName: string | DisplayName;
    errorOnDeprecated: boolean;
    expand: boolean;
    extensionsToTreatAsEsm: string[];
    fakeTimers: FakeTimers;
    filter: string;
    findRelatedTests: boolean;
    forceCoverageMatch: string[];
    forceExit: boolean;
    globals: ConfigGlobals;
    globalSetup: undefined | null | string;
    globalTeardown: undefined | null | string;
    haste: HasteConfig;
    id: string;
    injectGlobals: boolean;
    json: boolean;
    lastCommit: boolean;
    listTests: boolean;
    logHeapUsage: boolean;
    maxConcurrency: number;
    maxWorkers: string | number;
    moduleDirectories: string[];
    moduleFileExtensions: string[];
    moduleNameMapper: {
        [key: string]: string | string[];
    };
    modulePathIgnorePatterns: string[];
    modulePaths: string[];
    noStackTrace: boolean;
    notify: boolean;
    notifyMode: string;
    onlyChanged: boolean;
    onlyFailures: boolean;
    openHandlesTimeout: number;
    outputFile: string;
    passWithNoTests: boolean;
    preset: undefined | null | string;
    prettierPath: undefined | null | string;
    projects: (string | InitialProjectOptions)[];
    randomize: boolean;
    replname: undefined | null | string;
    reporters: (string | ReporterConfig)[];
    resetMocks: boolean;
    resetModules: boolean;
    resolver: undefined | null | string;
    restoreMocks: boolean;
    rootDir: string;
    roots: string[];
    runner: string;
    runTestsByPath: boolean;
    runtime: string;
    sandboxInjectedGlobals: string[];
    setupFiles: string[];
    setupFilesAfterEnv: string[];
    showSeed: boolean;
    silent: boolean;
    skipFilter: boolean;
    skipNodeResolution: boolean;
    slowTestThreshold: number;
    snapshotFormat: {
        callToJSON?: boolean;
        compareKeys?: null;
        escapeRegex?: boolean;
        escapeString?: boolean;
        highlight?: boolean;
        indent?: number;
        maxDepth?: number;
        maxWidth?: number;
        min?: boolean;
        printBasicPrototype?: boolean;
        printFunctionName?: boolean;
        theme?: {
            comment?: string;
            content?: string;
            prop?: string;
            tag?: string;
            value?: string;
        };
    };
    snapshotResolver: string;
    snapshotSerializers: string[];
    testEnvironment: string;
    testEnvironmentOptions: Record<string, unknown>;
    testFailureExitCode: string | number;
    testLocationInResults: boolean;
    testMatch: string[];
    testNamePattern: string;
    testPathIgnorePatterns: string[];
    testRegex: string | string[];
    testResultsProcessor: string;
    testRunner: string;
    testSequencer: string;
    testTimeout: number;
    transform: {
        [regex: string]: string | TransformerConfig;
    };
    transformIgnorePatterns: string[];
    unmockedModulePathPatterns: string[];
    updateSnapshot: boolean;
    useStderr: boolean;
    verbose?: boolean;
    watch: boolean;
    watchAll: boolean;
    watchman: boolean;
    watchPathIgnorePatterns: string[];
    watchPlugins: (string | [string, Record<string, unknown>])[];
    workerIdleMemoryLimit: string | number;
    workerThreads: boolean;
}>>
Promise resolved to customized Jest options.

Returns Promise<Partial<{
    automock: boolean;
    bail: number | boolean;
    cache: boolean;
    cacheDirectory: string;
    changedFilesWithAncestor: boolean;
    changedSince: string;
    ci: boolean;
    clearMocks: boolean;
    collectCoverage: boolean;
    collectCoverageFrom: string[];
    coverageDirectory: string;
    coveragePathIgnorePatterns: string[];
    coverageProvider: CoverageProvider;
    coverageReporters: CoverageReporters;
    coverageThreshold: CoverageThreshold;
    dependencyExtractor: string;
    detectLeaks: boolean;
    detectOpenHandles: boolean;
    displayName: string | DisplayName;
    errorOnDeprecated: boolean;
    expand: boolean;
    extensionsToTreatAsEsm: string[];
    fakeTimers: FakeTimers;
    filter: string;
    findRelatedTests: boolean;
    forceCoverageMatch: string[];
    forceExit: boolean;
    globals: ConfigGlobals;
    globalSetup: undefined | null | string;
    globalTeardown: undefined | null | string;
    haste: HasteConfig;
    id: string;
    injectGlobals: boolean;
    json: boolean;
    lastCommit: boolean;
    listTests: boolean;
    logHeapUsage: boolean;
    maxConcurrency: number;
    maxWorkers: string | number;
    moduleDirectories: string[];
    moduleFileExtensions: string[];
    moduleNameMapper: {
        [key: string]: string | string[];
    };
    modulePathIgnorePatterns: string[];
    modulePaths: string[];
    noStackTrace: boolean;
    notify: boolean;
    notifyMode: string;
    onlyChanged: boolean;
    onlyFailures: boolean;
    openHandlesTimeout: number;
    outputFile: string;
    passWithNoTests: boolean;
    preset: undefined | null | string;
    prettierPath: undefined | null | string;
    projects: (string | InitialProjectOptions)[];
    randomize: boolean;
    replname: undefined | null | string;
    reporters: (string | ReporterConfig)[];
    resetMocks: boolean;
    resetModules: boolean;
    resolver: undefined | null | string;
    restoreMocks: boolean;
    rootDir: string;
    roots: string[];
    runner: string;
    runTestsByPath: boolean;
    runtime: string;
    sandboxInjectedGlobals: string[];
    setupFiles: string[];
    setupFilesAfterEnv: string[];
    showSeed: boolean;
    silent: boolean;
    skipFilter: boolean;
    skipNodeResolution: boolean;
    slowTestThreshold: number;
    snapshotFormat: {
        callToJSON?: boolean;
        compareKeys?: null;
        escapeRegex?: boolean;
        escapeString?: boolean;
        highlight?: boolean;
        indent?: number;
        maxDepth?: number;
        maxWidth?: number;
        min?: boolean;
        printBasicPrototype?: boolean;
        printFunctionName?: boolean;
        theme?: {
            comment?: string;
            content?: string;
            prop?: string;
            tag?: string;
            value?: string;
        };
    };
    snapshotResolver: string;
    snapshotSerializers: string[];
    testEnvironment: string;
    testEnvironmentOptions: Record<string, unknown>;
    testFailureExitCode: string | number;
    testLocationInResults: boolean;
    testMatch: string[];
    testNamePattern: string;
    testPathIgnorePatterns: string[];
    testRegex: string | string[];
    testResultsProcessor: string;
    testRunner: string;
    testSequencer: string;
    testTimeout: number;
    transform: {
        [regex: string]: string | TransformerConfig;
    };
    transformIgnorePatterns: string[];
    unmockedModulePathPatterns: string[];
    updateSnapshot: boolean;
    useStderr: boolean;
    verbose?: boolean;
    watch: boolean;
    watchAll: boolean;
    watchman: boolean;
    watchPathIgnorePatterns: string[];
    watchPlugins: (string | [string, Record<string, unknown>])[];
    workerIdleMemoryLimit: string | number;
    workerThreads: boolean;
}>>
- Defined in run-z/project-config/src/jest/project-jest-config.ts:153

project

get project(): ProjectConfig
Configured project.

Returns ProjectConfig
Inherited from ProjectDevTool.project
- Defined in run-z/project-config/src/project-dev-tool.ts:31

runner

get runner(): Promise<"ts-jest" | "swc">
Test runner.

Test may be run either with swc, or with ts-jest.

Returns Promise<"ts-jest" | "swc">
Default Value
Promise resolved to auto-detected test runner, unless overridden by RUNZ_TEST_RUNNER environment variable.
- Defined in run-z/project-config/src/jest/project-jest-config.ts:110

Methods

autogenerateOptions

autogenerateOptions(options): this
Replaces custom Rollup options with autogenerated ones.

Clears custom options, and forces automatic generation.
Parameters
- options: Partial<{
      automock: boolean;
      bail: number | boolean;
      cache: boolean;
      cacheDirectory: string;
      changedFilesWithAncestor: boolean;
      changedSince: string;
      ci: boolean;
      clearMocks: boolean;
      collectCoverage: boolean;
      collectCoverageFrom: string[];
      coverageDirectory: string;
      coveragePathIgnorePatterns: string[];
      coverageProvider: CoverageProvider;
      coverageReporters: CoverageReporters;
      coverageThreshold: CoverageThreshold;
      dependencyExtractor: string;
      detectLeaks: boolean;
      detectOpenHandles: boolean;
      displayName: string | DisplayName;
      errorOnDeprecated: boolean;
      expand: boolean;
      extensionsToTreatAsEsm: string[];
      fakeTimers: FakeTimers;
      filter: string;
      findRelatedTests: boolean;
      forceCoverageMatch: string[];
      forceExit: boolean;
      globals: ConfigGlobals;
      globalSetup: undefined | null | string;
      globalTeardown: undefined | null | string;
      haste: HasteConfig;
      id: string;
      injectGlobals: boolean;
      json: boolean;
      lastCommit: boolean;
      listTests: boolean;
      logHeapUsage: boolean;
      maxConcurrency: number;
      maxWorkers: string | number;
      moduleDirectories: string[];
      moduleFileExtensions: string[];
      moduleNameMapper: {
          [key: string]: string | string[];
      };
      modulePathIgnorePatterns: string[];
      modulePaths: string[];
      noStackTrace: boolean;
      notify: boolean;
      notifyMode: string;
      onlyChanged: boolean;
      onlyFailures: boolean;
      openHandlesTimeout: number;
      outputFile: string;
      passWithNoTests: boolean;
      preset: undefined | null | string;
      prettierPath: undefined | null | string;
      projects: (string | InitialProjectOptions)[];
      randomize: boolean;
      replname: undefined | null | string;
      reporters: (string | ReporterConfig)[];
      resetMocks: boolean;
      resetModules: boolean;
      resolver: undefined | null | string;
      restoreMocks: boolean;
      rootDir: string;
      roots: string[];
      runner: string;
      runTestsByPath: boolean;
      runtime: string;
      sandboxInjectedGlobals: string[];
      setupFiles: string[];
      setupFilesAfterEnv: string[];
      showSeed: boolean;
      silent: boolean;
      skipFilter: boolean;
      skipNodeResolution: boolean;
      slowTestThreshold: number;
      snapshotFormat: {
          callToJSON?: boolean;
          compareKeys?: null;
          escapeRegex?: boolean;
          escapeString?: boolean;
          highlight?: boolean;
          indent?: number;
          maxDepth?: number;
          maxWidth?: number;
          min?: boolean;
          printBasicPrototype?: boolean;
          printFunctionName?: boolean;
          theme?: {
              comment?: string;
              content?: string;
              prop?: string;
              tag?: string;
              value?: string;
          };
      };
      snapshotResolver: string;
      snapshotSerializers: string[];
      testEnvironment: string;
      testEnvironmentOptions: Record<string, unknown>;
      testFailureExitCode: string | number;
      testLocationInResults: boolean;
      testMatch: string[];
      testNamePattern: string;
      testPathIgnorePatterns: string[];
      testRegex: string | string[];
      testResultsProcessor: string;
      testRunner: string;
      testSequencer: string;
      testTimeout: number;
      transform: {
          [regex: string]: string | TransformerConfig;
      };
      transformIgnorePatterns: string[];
      unmockedModulePathPatterns: string[];
      updateSnapshot: boolean;
      useStderr: boolean;
      verbose?: boolean;
      watch: boolean;
      watchAll: boolean;
      watchman: boolean;
      watchPathIgnorePatterns: string[];
      watchPlugins: (string | [string, Record<string, unknown>])[];
      workerIdleMemoryLimit: string | number;
      workerThreads: boolean;
  }>
  Jest options extending autogenerated ones.
Returns this
Updated instance.
- Defined in run-z/project-config/src/jest/project-jest-config.ts:184

`Protected`clone

clone(): this
Creates dev tool clone.

Returns this
Project clone created with its constructor.
Overrides ProjectDevTool.clone
- Defined in run-z/project-config/src/jest/project-jest-config.ts:77

extendOptions

extendOptions(extension): this
Extends Jest options.
Parameters
- extension: Partial<{
      automock: boolean;
      bail: number | boolean;
      cache: boolean;
      cacheDirectory: string;
      changedFilesWithAncestor: boolean;
      changedSince: string;
      ci: boolean;
      clearMocks: boolean;
      collectCoverage: boolean;
      collectCoverageFrom: string[];
      coverageDirectory: string;
      coveragePathIgnorePatterns: string[];
      coverageProvider: CoverageProvider;
      coverageReporters: CoverageReporters;
      coverageThreshold: CoverageThreshold;
      dependencyExtractor: string;
      detectLeaks: boolean;
      detectOpenHandles: boolean;
      displayName: string | DisplayName;
      errorOnDeprecated: boolean;
      expand: boolean;
      extensionsToTreatAsEsm: string[];
      fakeTimers: FakeTimers;
      filter: string;
      findRelatedTests: boolean;
      forceCoverageMatch: string[];
      forceExit: boolean;
      globals: ConfigGlobals;
      globalSetup: undefined | null | string;
      globalTeardown: undefined | null | string;
      haste: HasteConfig;
      id: string;
      injectGlobals: boolean;
      json: boolean;
      lastCommit: boolean;
      listTests: boolean;
      logHeapUsage: boolean;
      maxConcurrency: number;
      maxWorkers: string | number;
      moduleDirectories: string[];
      moduleFileExtensions: string[];
      moduleNameMapper: {
          [key: string]: string | string[];
      };
      modulePathIgnorePatterns: string[];
      modulePaths: string[];
      noStackTrace: boolean;
      notify: boolean;
      notifyMode: string;
      onlyChanged: boolean;
      onlyFailures: boolean;
      openHandlesTimeout: number;
      outputFile: string;
      passWithNoTests: boolean;
      preset: undefined | null | string;
      prettierPath: undefined | null | string;
      projects: (string | InitialProjectOptions)[];
      randomize: boolean;
      replname: undefined | null | string;
      reporters: (string | ReporterConfig)[];
      resetMocks: boolean;
      resetModules: boolean;
      resolver: undefined | null | string;
      restoreMocks: boolean;
      rootDir: string;
      roots: string[];
      runner: string;
      runTestsByPath: boolean;
      runtime: string;
      sandboxInjectedGlobals: string[];
      setupFiles: string[];
      setupFilesAfterEnv: string[];
      showSeed: boolean;
      silent: boolean;
      skipFilter: boolean;
      skipNodeResolution: boolean;
      slowTestThreshold: number;
      snapshotFormat: {
          callToJSON?: boolean;
          compareKeys?: null;
          escapeRegex?: boolean;
          escapeString?: boolean;
          highlight?: boolean;
          indent?: number;
          maxDepth?: number;
          maxWidth?: number;
          min?: boolean;
          printBasicPrototype?: boolean;
          printFunctionName?: boolean;
          theme?: {
              comment?: string;
              content?: string;
              prop?: string;
              tag?: string;
              value?: string;
          };
      };
      snapshotResolver: string;
      snapshotSerializers: string[];
      testEnvironment: string;
      testEnvironmentOptions: Record<string, unknown>;
      testFailureExitCode: string | number;
      testLocationInResults: boolean;
      testMatch: string[];
      testNamePattern: string;
      testPathIgnorePatterns: string[];
      testRegex: string | string[];
      testResultsProcessor: string;
      testRunner: string;
      testSequencer: string;
      testTimeout: number;
      transform: {
          [regex: string]: string | TransformerConfig;
      };
      transformIgnorePatterns: string[];
      unmockedModulePathPatterns: string[];
      updateSnapshot: boolean;
      useStderr: boolean;
      verbose?: boolean;
      watch: boolean;
      watchAll: boolean;
      watchman: boolean;
      watchPathIgnorePatterns: string[];
      watchPlugins: (string | [string, Record<string, unknown>])[];
      workerIdleMemoryLimit: string | number;
      workerThreads: boolean;
  }>
  Jest options extending previous ones.
Returns this
Updated instance instance.
- Defined in run-z/project-config/src/jest/project-jest-config.ts:200

host

host(): ProjectConfig
Gains actual development tools host from the project.

Returns ProjectConfig
Inherited from ProjectDevTool.host
- Defined in run-z/project-config/src/project-dev-tool.ts:38

replaceOptions

replaceOptions(options): this
Replaces Jest options with custom ones.

Clears custom options, and prevents automatic generation.
Parameters
- options: Partial<{
      automock: boolean;
      bail: number | boolean;
      cache: boolean;
      cacheDirectory: string;
      changedFilesWithAncestor: boolean;
      changedSince: string;
      ci: boolean;
      clearMocks: boolean;
      collectCoverage: boolean;
      collectCoverageFrom: string[];
      coverageDirectory: string;
      coveragePathIgnorePatterns: string[];
      coverageProvider: CoverageProvider;
      coverageReporters: CoverageReporters;
      coverageThreshold: CoverageThreshold;
      dependencyExtractor: string;
      detectLeaks: boolean;
      detectOpenHandles: boolean;
      displayName: string | DisplayName;
      errorOnDeprecated: boolean;
      expand: boolean;
      extensionsToTreatAsEsm: string[];
      fakeTimers: FakeTimers;
      filter: string;
      findRelatedTests: boolean;
      forceCoverageMatch: string[];
      forceExit: boolean;
      globals: ConfigGlobals;
      globalSetup: undefined | null | string;
      globalTeardown: undefined | null | string;
      haste: HasteConfig;
      id: string;
      injectGlobals: boolean;
      json: boolean;
      lastCommit: boolean;
      listTests: boolean;
      logHeapUsage: boolean;
      maxConcurrency: number;
      maxWorkers: string | number;
      moduleDirectories: string[];
      moduleFileExtensions: string[];
      moduleNameMapper: {
          [key: string]: string | string[];
      };
      modulePathIgnorePatterns: string[];
      modulePaths: string[];
      noStackTrace: boolean;
      notify: boolean;
      notifyMode: string;
      onlyChanged: boolean;
      onlyFailures: boolean;
      openHandlesTimeout: number;
      outputFile: string;
      passWithNoTests: boolean;
      preset: undefined | null | string;
      prettierPath: undefined | null | string;
      projects: (string | InitialProjectOptions)[];
      randomize: boolean;
      replname: undefined | null | string;
      reporters: (string | ReporterConfig)[];
      resetMocks: boolean;
      resetModules: boolean;
      resolver: undefined | null | string;
      restoreMocks: boolean;
      rootDir: string;
      roots: string[];
      runner: string;
      runTestsByPath: boolean;
      runtime: string;
      sandboxInjectedGlobals: string[];
      setupFiles: string[];
      setupFilesAfterEnv: string[];
      showSeed: boolean;
      silent: boolean;
      skipFilter: boolean;
      skipNodeResolution: boolean;
      slowTestThreshold: number;
      snapshotFormat: {
          callToJSON?: boolean;
          compareKeys?: null;
          escapeRegex?: boolean;
          escapeString?: boolean;
          highlight?: boolean;
          indent?: number;
          maxDepth?: number;
          maxWidth?: number;
          min?: boolean;
          printBasicPrototype?: boolean;
          printFunctionName?: boolean;
          theme?: {
              comment?: string;
              content?: string;
              prop?: string;
              tag?: string;
              value?: string;
          };
      };
      snapshotResolver: string;
      snapshotSerializers: string[];
      testEnvironment: string;
      testEnvironmentOptions: Record<string, unknown>;
      testFailureExitCode: string | number;
      testLocationInResults: boolean;
      testMatch: string[];
      testNamePattern: string;
      testPathIgnorePatterns: string[];
      testRegex: string | string[];
      testResultsProcessor: string;
      testRunner: string;
      testSequencer: string;
      testTimeout: number;
      transform: {
          [regex: string]: string | TransformerConfig;
      };
      transformIgnorePatterns: string[];
      unmockedModulePathPatterns: string[];
      updateSnapshot: boolean;
      useStderr: boolean;
      verbose?: boolean;
      watch: boolean;
      watchAll: boolean;
      watchman: boolean;
      watchPathIgnorePatterns: string[];
      watchPlugins: (string | [string, Record<string, unknown>])[];
      workerIdleMemoryLimit: string | number;
      workerThreads: boolean;
  }>
  Jest options to apply.
Returns this
Updated instance.
- Defined in run-z/project-config/src/jest/project-jest-config.ts:166

run

run(args?): Promise<void>
Configures and run project tests with Jest.
Parameters
- Optionalargs: string[]
  Array of Jest command line arguments. Defaults to arguments from process.argv.
Returns Promise<void>
Promise resolved when tests executed.
- Defined in run-z/project-config/src/jest/project-jest-config.ts:362

useRunner

useRunner(runner): this
Assigns test runner to use.
Parameters
- runner: "ts-jest" | "swc"
  Test runner to use.
Returns this
Updated instance.
- Defined in run-z/project-config/src/jest/project-jest-config.ts:142

`Static`load

load(project, url?): Promise<ProjectJestConfig>
Loads Jest configuration from ESM module.

If configuration file found, its options replace the default ones. Default configuration returned otherwise.
Parameters
- project: ProjectConfig
  Configured project.
- url: string = './jest.config.js'
  Jest configuration URL relative to project root. Defaults to ./jest.config.js.
Returns Promise<ProjectJestConfig>
Loaded configuration.
- Defined in run-z/project-config/src/jest/project-jest-config.ts:53

`Static`of

of(project): ProjectJestConfig
Gains Jest configuration of the project.

Respects defaults.
Parameters
- project: ProjectConfig
  Configured project.
Returns ProjectJestConfig
Jest configuration instance.
- Defined in run-z/project-config/src/jest/project-jest-config.ts:38

Class ProjectJestConfig

Hierarchy (view full)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns ProjectJestConfig

Accessors

autogenerated

Returns boolean

jest

Returns Promise<__module>

options

project

Returns ProjectConfig

runner

Returns Promise<"ts-jest" | "swc">

Default Value

Methods

autogenerateOptions

Parameters

Returns this

Protectedclone

Returns this

extendOptions

Parameters

Returns this

host

Returns ProjectConfig

replaceOptions

Parameters

Returns this

run

Parameters

Returns Promise<void>

useRunner

Parameters

Returns this

Staticload

Parameters

Returns Promise<ProjectJestConfig>

Staticof

Parameters

Returns ProjectJestConfig

Settings

On This Page

`Protected`clone

`Static`load

`Static`of