io.github.cdklabs.projen.javascript

Interface EslintOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

EslintOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-20T00:39:28.834Z")
 @Stability(value=Experimental)
public interface EslintOptions
extends software.amazon.jsii.JsiiSerializable

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static EslintOptions.Builder	builder()
default List<String>	getAliasExtensions() (experimental) Enable import alias for module paths.
default Map<String,String>	getAliasMap() (experimental) Enable import alias for module paths.
default List<String>	getDevdirs() (experimental) Directories with source files that include tests and build tools.
List<String>	getDirs() (experimental) Directories with source files to lint (e.g.
default List<String>	getFileExtensions() (experimental) File types that should be linted (e.g.
default List<String>	getIgnorePatterns() (experimental) List of file patterns that should not be linted, using the same syntax as .gitignore patterns.
default Boolean	getLintProjenRc() (experimental) Should we lint .projenrc.js.
default Boolean	getPrettier() (experimental) Enable prettier for code formatting.
default Boolean	getTsAlwaysTryTypes() (experimental) Always try to resolve types under `@types` directory even it doesn't contain any source code.
default String	getTsconfigPath() (experimental) Path to `tsconfig.json` which should be used by eslint.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDirs

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

(experimental) Directories with source files to lint (e.g. [ "src" ]).

getAliasExtensions

@Stability(value=Experimental)
 @Nullable
default List<String> getAliasExtensions()

(experimental) Enable import alias for module paths.

Default: undefined

getAliasMap

@Stability(value=Experimental)
 @Nullable
default Map<String,String> getAliasMap()

(experimental) Enable import alias for module paths.

Default: undefined

getDevdirs

@Stability(value=Experimental)
 @Nullable
default List<String> getDevdirs()

(experimental) Directories with source files that include tests and build tools.

These sources are linted but may also import packages from devDependencies.

Default: []

getFileExtensions

@Stability(value=Experimental)
 @Nullable
default List<String> getFileExtensions()

(experimental) File types that should be linted (e.g. [ ".js", ".ts" ]).

Default: [".ts"]

getIgnorePatterns

@Stability(value=Experimental)
 @Nullable
default List<String> getIgnorePatterns()

(experimental) List of file patterns that should not be linted, using the same syntax as .gitignore patterns.

Default: [ '*.js', '*.d.ts', 'node_modules/', '*.generated.ts', 'coverage' ]

getLintProjenRc

@Stability(value=Experimental)
 @Nullable
default Boolean getLintProjenRc()

(experimental) Should we lint .projenrc.js.

Default: true

getPrettier

@Stability(value=Experimental)
 @Nullable
default Boolean getPrettier()

(experimental) Enable prettier for code formatting.

Default: false

getTsAlwaysTryTypes

@Stability(value=Experimental)
 @Nullable
default Boolean getTsAlwaysTryTypes()

(experimental) Always try to resolve types under `@types` directory even it doesn't contain any source code.

This prevents import/no-unresolved eslint errors when importing a @types/* module that would otherwise remain unresolved.

Default: true

getTsconfigPath

@Stability(value=Experimental)
 @Nullable
default String getTsconfigPath()

(experimental) Path to `tsconfig.json` which should be used by eslint.

Default: "./tsconfig.json"

builder

@Stability(value=Experimental)
static EslintOptions.Builder builder()

Returns:

a EslintOptions.Builder of EslintOptions