Package io.github.cdklabs.projen.javascript

Class Prettier

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

io.github.cdklabs.projen.Component

io.github.cdklabs.projen.javascript.Prettier

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.199Z")
@Stability(Experimental)
public class Prettier
extends Component

(experimental) Represents prettier configuration.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Prettier.Builder	(experimental) A fluent builder for Prettier.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
	Prettier(NodeProject project, PrettierOptions options)
protected	Prettier(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Prettier(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	addIgnorePattern(String pattern)	(experimental) Defines Prettier ignore Patterns these patterns will be added to the file .prettierignore.
void	addOverride(PrettierOverride override)	(experimental) Add a prettier override.
IgnoreFile	getIgnoreFile()	(experimental) The .prettierIgnore file.
List<PrettierOverride>	getOverrides()	(experimental) Returns all Prettier overrides.
PrettierSettings	getSettings()	(experimental) Direct access to the prettier settings.
static Prettier	of(Project project)
void	preSynthesize()	(experimental) Called before synthesis.

Methods inherited from class io.github.cdklabs.projen.Component

getProject, isComponent, postSynthesize, synthesize

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Prettier

protected Prettier(software.amazon.jsii.JsiiObjectRef objRef)

Prettier

protected Prettier(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Prettier

@Stability(Experimental)
public Prettier(@NotNull
                NodeProject project,
                @NotNull
                PrettierOptions options)

Parameters:

project - This parameter is required.

options - This parameter is required.

Method Detail

of

@Stability(Experimental)
@Nullable
public static Prettier of(@NotNull
                          Project project)

Parameters:

project - This parameter is required.

addIgnorePattern

@Stability(Experimental)
public void addIgnorePattern(@NotNull
                             String pattern)

(experimental) Defines Prettier ignore Patterns these patterns will be added to the file .prettierignore.

Parameters:

pattern - filepatterns so exclude from prettier formatting. This parameter is required.

addOverride

@Stability(Experimental)
public void addOverride(@NotNull
                        PrettierOverride override)

(experimental) Add a prettier override.

Parameters:

override - This parameter is required.

See Also:

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

preSynthesize

@Stability(Experimental)
public void preSynthesize()

(experimental) Called before synthesis.

Overrides:

preSynthesize in class Component

getOverrides

@Stability(Experimental)
@NotNull
public List<PrettierOverride> getOverrides()

(experimental) Returns all Prettier overrides.

getSettings

@Stability(Experimental)
@NotNull
public PrettierSettings getSettings()

(experimental) Direct access to the prettier settings.

getIgnoreFile

@Stability(Experimental)
@Nullable
public IgnoreFile getIgnoreFile()

(experimental) The .prettierIgnore file.