Package io.github.cdklabs.projen.javascript

Interface JestOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

JestOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.170Z")
@Stability(Experimental)
public interface JestOptions
extends software.amazon.jsii.JsiiSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	JestOptions.Builder	A builder for JestOptions
static class	JestOptions.Jsii$Proxy	An implementation for JestOptions

Method Summary

Modifier and Type	Method	Description
static JestOptions.Builder	builder()
default String	getConfigFilePath()	(experimental) Path to JSON config file for Jest.
default Boolean	getCoverage()	Deprecated. use jestConfig.collectCoverage
default Boolean	getCoverageText()	(experimental) Include the text coverage reporter, which means that coverage summary is printed at the end of the jest execution.
default List<String>	getExtraCliOptions()	(experimental) Additional options to pass to the Jest CLI invocation.
default List<String>	getIgnorePatterns()	Deprecated. use jestConfig.coveragePathIgnorePatterns or jestConfig.testPathIgnorePatterns respectively
default JestConfigOptions	getJestConfig()	(experimental) Jest configuration.
default String	getJestVersion()	(experimental) The version of jest to use.
default Boolean	getJunitReporting()	(experimental) Result processing with jest-junit.
default Boolean	getPreserveDefaultReporters()	(experimental) Preserve the default Jest reporter when additional reporters are added.
default UpdateSnapshot	getUpdateSnapshot()	(experimental) Whether to update snapshots in task "test" (which is executed in task "build" and build workflows), or create a separate task "test:update" for updating snapshots.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getConfigFilePath

@Stability(Experimental)
@Nullable
default String getConfigFilePath()

(experimental) Path to JSON config file for Jest.

Default: - No separate config file, jest settings are stored in package.json

getCoverage

@Stability(Deprecated)
@Deprecated
@Nullable
default Boolean getCoverage()

Deprecated.

use jestConfig.collectCoverage

(deprecated) Collect coverage.

Deprecated

Default: true

getCoverageText

@Stability(Experimental)
@Nullable
default Boolean getCoverageText()

(experimental) Include the text coverage reporter, which means that coverage summary is printed at the end of the jest execution.

Default: true

getExtraCliOptions

@Stability(Experimental)
@Nullable
default List<String> getExtraCliOptions()

(experimental) Additional options to pass to the Jest CLI invocation.

Default: - no extra options

getIgnorePatterns

@Stability(Deprecated)
@Deprecated
@Nullable
default List<String> getIgnorePatterns()

Deprecated.

use jestConfig.coveragePathIgnorePatterns or jestConfig.testPathIgnorePatterns respectively

(deprecated) Defines testPathIgnorePatterns and coveragePathIgnorePatterns.

Default: ["/node_modules/"]

getJestConfig

@Stability(Experimental)
@Nullable
default JestConfigOptions getJestConfig()

(experimental) Jest configuration.

Default: - default jest configuration

getJestVersion

@Stability(Experimental)
@Nullable
default String getJestVersion()

(experimental) The version of jest to use.

Note that same version is used as version of @types/jest and ts-jest (if Typescript in use), so given version should work also for those.

Default: - installs the latest jest version

getJunitReporting

@Stability(Experimental)
@Nullable
default Boolean getJunitReporting()

(experimental) Result processing with jest-junit.

Output directory is test-reports/.

Default: true

getPreserveDefaultReporters

@Stability(Experimental)
@Nullable
default Boolean getPreserveDefaultReporters()

(experimental) Preserve the default Jest reporter when additional reporters are added.

Default: true

getUpdateSnapshot

@Stability(Experimental)
@Nullable
default UpdateSnapshot getUpdateSnapshot()

(experimental) Whether to update snapshots in task "test" (which is executed in task "build" and build workflows), or create a separate task "test:update" for updating snapshots.

Default: - ALWAYS

builder

@Stability(Experimental)
static JestOptions.Builder builder()

Returns:

a JestOptions.Builder of JestOptions