Package io.github.cdklabs.projen.javascript

Class Prettier.Builder

java.lang.Object

io.github.cdklabs.projen.javascript.Prettier.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<Prettier>

Enclosing class:

Prettier

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

(experimental) A fluent builder for Prettier.

Method Summary

Modifier and Type	Method	Description
Prettier	build()
static Prettier.Builder	create(NodeProject project)
Prettier.Builder	ignoreFile(Boolean ignoreFile)	(experimental) Defines an .prettierIgnore file.
Prettier.Builder	ignoreFileOptions(IgnoreFileOptions ignoreFileOptions)	(experimental) Configuration options for .prettierignore file.
Prettier.Builder	overrides(List<? extends PrettierOverride> overrides)	(experimental) Provide a list of patterns to override prettier configuration.
Prettier.Builder	settings(PrettierSettings settings)	(experimental) Prettier settings.
Prettier.Builder	yaml(Boolean yaml)	(experimental) Write prettier configuration as YAML instead of JSON.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(Experimental)
public static Prettier.Builder create(NodeProject project)

Parameters:

project - This parameter is required.

Returns:

a new instance of Prettier.Builder.

ignoreFile

@Stability(Experimental)
public Prettier.Builder ignoreFile(Boolean ignoreFile)

(experimental) Defines an .prettierIgnore file.

Default: true

Parameters:

ignoreFile - Defines an .prettierIgnore file. This parameter is required.

Returns:

this

ignoreFileOptions

@Stability(Experimental)
public Prettier.Builder ignoreFileOptions(IgnoreFileOptions ignoreFileOptions)

(experimental) Configuration options for .prettierignore file.

Parameters:

ignoreFileOptions - Configuration options for .prettierignore file. This parameter is required.

Returns:

this

overrides

@Stability(Experimental)
public Prettier.Builder overrides(List<? extends PrettierOverride> overrides)

(experimental) Provide a list of patterns to override prettier configuration.

Default: []

Parameters:

overrides - Provide a list of patterns to override prettier configuration. This parameter is required.

Returns:

this

See Also:

https://prettier.io/docs/en/configuration.html#configuration-overrides

settings

@Stability(Experimental)
public Prettier.Builder settings(PrettierSettings settings)

(experimental) Prettier settings.

Default: - default settings

Parameters:

settings - Prettier settings. This parameter is required.

Returns:

this

yaml

@Stability(Experimental)
public Prettier.Builder yaml(Boolean yaml)

(experimental) Write prettier configuration as YAML instead of JSON.

Default: false

Parameters:

yaml - Write prettier configuration as YAML instead of JSON. This parameter is required.

Returns:

this

build

@Stability(Experimental)
public Prettier build()

Specified by:

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

Returns:

a newly built instance of Prettier.