Package io.github.cdklabs.projen.javascript

Interface PrettierOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

PrettierOptions.Jsii$Proxy

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

(experimental) Options for Prettier.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static PrettierOptions.Builder	builder()
default Boolean	getIgnoreFile()	(experimental) Defines an .prettierIgnore file.
default IgnoreFileOptions	getIgnoreFileOptions()	(experimental) Configuration options for .prettierignore file.
default List<PrettierOverride>	getOverrides()	(experimental) Provide a list of patterns to override prettier configuration.
default PrettierSettings	getSettings()	(experimental) Prettier settings.
default Boolean	getYaml()	(experimental) Write prettier configuration as YAML instead of JSON.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getIgnoreFile

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

(experimental) Defines an .prettierIgnore file.

Default: true

getIgnoreFileOptions

@Stability(Experimental)
@Nullable
default IgnoreFileOptions getIgnoreFileOptions()

(experimental) Configuration options for .prettierignore file.

getOverrides

@Stability(Experimental)
@Nullable
default List<PrettierOverride> getOverrides()

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

Default: []

See Also:

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

getSettings

@Stability(Experimental)
@Nullable
default PrettierSettings getSettings()

(experimental) Prettier settings.

Default: - default settings

getYaml

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

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

Default: false

builder

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

Returns:

a PrettierOptions.Builder of PrettierOptions