io.github.cdklabs.projen.javascript

Class Eslint

java.lang.Object

software.amazon.jsii.JsiiObject

io.github.cdklabs.projen.Component

io.github.cdklabs.projen.javascript.Eslint

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-20T00:39:28.833Z")
 @Stability(value=Experimental)
public class Eslint
extends Component

(experimental) Represents eslint configuration.

Nested Class Summary

Nested Classes

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

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

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Eslint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Eslint(software.amazon.jsii.JsiiObjectRef objRef)
	Eslint(NodeProject project, EslintOptions options)

Method Summary

Modifier and Type	Method and Description
void	addIgnorePattern(String pattern) (experimental) Do not lint these files.
void	addOverride(EslintOverride override) (experimental) Add an eslint override.
void	addRules(Map<String,Object> rules) (experimental) Add an eslint rule.
void	allowDevDeps(String pattern) (experimental) Add a glob file pattern which allows importing dev dependencies.
Object	getConfig() (experimental) Direct access to the eslint configuration (escape hatch).
List<String>	getIgnorePatterns() (experimental) File patterns that should not be linted.
List<EslintOverride>	getOverrides() (experimental) eslint overrides.
Map<String,List<Object>>	getRules() (experimental) eslint rules.
static Eslint	of(Project project) (experimental) Returns the singletone Eslint component of a project or undefined if there is none.

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

getProject, postSynthesize, preSynthesize, synthesize

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, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Eslint

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

Eslint

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

Eslint

@Stability(value=Experimental)
public Eslint(@NotNull
                                             NodeProject project,
                                             @NotNull
                                             EslintOptions options)

Parameters:

project - This parameter is required.

options - This parameter is required.

Method Detail

of

@Stability(value=Experimental)
 @Nullable
public static Eslint of(@NotNull
                                                                  Project project)

(experimental) Returns the singletone Eslint component of a project or undefined if there is none.

Parameters:

project - This parameter is required.

addIgnorePattern

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

(experimental) Do not lint these files.

Parameters:

pattern - This parameter is required.

addOverride

@Stability(value=Experimental)
public void addOverride(@NotNull
                                                       EslintOverride override)

(experimental) Add an eslint override.

Parameters:

override - This parameter is required.

addRules

@Stability(value=Experimental)
public void addRules(@NotNull
                                                    Map<String,Object> rules)

(experimental) Add an eslint rule.

Parameters:

rules - This parameter is required.

allowDevDeps

@Stability(value=Experimental)
public void allowDevDeps(@NotNull
                                                        String pattern)

(experimental) Add a glob file pattern which allows importing dev dependencies.

Parameters:

pattern - glob pattern. This parameter is required.

getConfig

@Stability(value=Experimental)
 @NotNull
public Object getConfig()

(experimental) Direct access to the eslint configuration (escape hatch).

getIgnorePatterns

@Stability(value=Experimental)
 @NotNull
public List<String> getIgnorePatterns()

(experimental) File patterns that should not be linted.

getOverrides

@Stability(value=Experimental)
 @NotNull
public List<EslintOverride> getOverrides()

(experimental) eslint overrides.

getRules

@Stability(value=Experimental)
 @NotNull
public Map<String,List<Object>> getRules()

(experimental) eslint rules.