io.github.cdklabs.projen.javascript

Class JestOptions.Builder

java.lang.Object

io.github.cdklabs.projen.javascript.JestOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<JestOptions>

Enclosing interface:

JestOptions

@Stability(value=Experimental)
public static final class JestOptions.Builder
extends Object
implements software.amazon.jsii.Builder<JestOptions>

A builder for JestOptions

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
JestOptions	build() Builds the configured instance.
JestOptions.Builder	configFilePath(String configFilePath) Sets the value of JestOptions.getConfigFilePath()
JestOptions.Builder	coverage(Boolean coverage) Deprecated. use jestConfig.collectCoverage
JestOptions.Builder	coverageText(Boolean coverageText) Sets the value of JestOptions.getCoverageText()
JestOptions.Builder	ignorePatterns(List<String> ignorePatterns) Deprecated. use jestConfig.coveragePathIgnorePatterns or jestConfig.testPathIgnorePatterns respectively
JestOptions.Builder	jestConfig(JestConfigOptions jestConfig) Sets the value of JestOptions.getJestConfig()
JestOptions.Builder	jestVersion(String jestVersion) Sets the value of JestOptions.getJestVersion()
JestOptions.Builder	junitReporting(Boolean junitReporting) Sets the value of JestOptions.getJunitReporting()
JestOptions.Builder	preserveDefaultReporters(Boolean preserveDefaultReporters) Sets the value of JestOptions.getPreserveDefaultReporters()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

configFilePath

@Stability(value=Experimental)
public JestOptions.Builder configFilePath(String configFilePath)

Sets the value of JestOptions.getConfigFilePath()

Parameters:

configFilePath - Path to JSON config file for Jest.

Returns:

this

coverage

@Stability(value=Deprecated)
 @Deprecated
public JestOptions.Builder coverage(Boolean coverage)

Deprecated. use jestConfig.collectCoverage

Sets the value of JestOptions.getCoverage()

Parameters:

coverage - Collect coverage. Deprecated

Returns:

this

coverageText

@Stability(value=Experimental)
public JestOptions.Builder coverageText(Boolean coverageText)

Sets the value of JestOptions.getCoverageText()

Parameters:

coverageText - Include the `text` coverage reporter, which means that coverage summary is printed at the end of the jest execution.

Returns:

this

ignorePatterns

@Stability(value=Deprecated)
 @Deprecated
public JestOptions.Builder ignorePatterns(List<String> ignorePatterns)

Deprecated. use jestConfig.coveragePathIgnorePatterns or jestConfig.testPathIgnorePatterns respectively

Sets the value of JestOptions.getIgnorePatterns()

Parameters:

ignorePatterns - Defines `testPathIgnorePatterns` and `coveragePathIgnorePatterns`.

Returns:

this

jestConfig

@Stability(value=Experimental)
public JestOptions.Builder jestConfig(JestConfigOptions jestConfig)

Sets the value of JestOptions.getJestConfig()

Parameters:

jestConfig - Jest configuration.

Returns:

this

jestVersion

@Stability(value=Experimental)
public JestOptions.Builder jestVersion(String jestVersion)

Sets the value of JestOptions.getJestVersion()

Parameters:

jestVersion - The version of jest to use.

Returns:

this

junitReporting

@Stability(value=Experimental)
public JestOptions.Builder junitReporting(Boolean junitReporting)

Sets the value of JestOptions.getJunitReporting()

Parameters:

junitReporting - Result processing with jest-junit. Output directory is test-reports/.

Returns:

this

preserveDefaultReporters

@Stability(value=Experimental)
public JestOptions.Builder preserveDefaultReporters(Boolean preserveDefaultReporters)

Sets the value of JestOptions.getPreserveDefaultReporters()

Parameters:

preserveDefaultReporters - Preserve the default Jest reporter when additional reporters are added.

Returns:

this

build

@Stability(value=Experimental)
public JestOptions build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<JestOptions>

Returns:

a new instance of JestOptions

Throws:

NullPointerException - if any required attribute was not provided