io.github.cdklabs.projen.javascript

Class Eslint.Builder

java.lang.Object

io.github.cdklabs.projen.javascript.Eslint.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<Eslint>

Enclosing class:

Eslint

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

(experimental) A fluent builder for Eslint.

Method Summary

Modifier and Type	Method and Description
Eslint.Builder	aliasExtensions(List<String> aliasExtensions) (experimental) Enable import alias for module paths.
Eslint.Builder	aliasMap(Map<String,String> aliasMap) (experimental) Enable import alias for module paths.
Eslint	build()
static Eslint.Builder	create(NodeProject project)
Eslint.Builder	devdirs(List<String> devdirs) (experimental) Directories with source files that include tests and build tools.
Eslint.Builder	dirs(List<String> dirs) (experimental) Directories with source files to lint (e.g.
Eslint.Builder	fileExtensions(List<String> fileExtensions) (experimental) File types that should be linted (e.g.
Eslint.Builder	ignorePatterns(List<String> ignorePatterns) (experimental) List of file patterns that should not be linted, using the same syntax as .gitignore patterns.
Eslint.Builder	lintProjenRc(Boolean lintProjenRc) (experimental) Should we lint .projenrc.js.
Eslint.Builder	prettier(Boolean prettier) (experimental) Enable prettier for code formatting.
Eslint.Builder	tsAlwaysTryTypes(Boolean tsAlwaysTryTypes) (experimental) Always try to resolve types under `@types` directory even it doesn't contain any source code.
Eslint.Builder	tsconfigPath(String tsconfigPath) (experimental) Path to `tsconfig.json` which should be used by eslint.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Experimental)
public static Eslint.Builder create(NodeProject project)

Parameters:

project - This parameter is required.

Returns:

a new instance of Eslint.Builder.

dirs

@Stability(value=Experimental)
public Eslint.Builder dirs(List<String> dirs)

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

Parameters:

dirs - Directories with source files to lint (e.g. [ "src" ]). This parameter is required.

Returns:

this

aliasExtensions

@Stability(value=Experimental)
public Eslint.Builder aliasExtensions(List<String> aliasExtensions)

(experimental) Enable import alias for module paths.

Default: undefined

Parameters:

aliasExtensions - Enable import alias for module paths. This parameter is required.

Returns:

this

aliasMap

@Stability(value=Experimental)
public Eslint.Builder aliasMap(Map<String,String> aliasMap)

(experimental) Enable import alias for module paths.

Default: undefined

Parameters:

aliasMap - Enable import alias for module paths. This parameter is required.

Returns:

this

devdirs

@Stability(value=Experimental)
public Eslint.Builder devdirs(List<String> devdirs)

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

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

Default: []

Parameters:

devdirs - Directories with source files that include tests and build tools. This parameter is required.

Returns:

this

fileExtensions

@Stability(value=Experimental)
public Eslint.Builder fileExtensions(List<String> fileExtensions)

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

Default: [".ts"]

Parameters:

fileExtensions - File types that should be linted (e.g. [ ".js", ".ts" ]). This parameter is required.

Returns:

this

ignorePatterns

@Stability(value=Experimental)
public Eslint.Builder ignorePatterns(List<String> ignorePatterns)

(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' ]

Parameters:

ignorePatterns - List of file patterns that should not be linted, using the same syntax as .gitignore patterns. This parameter is required.

Returns:

this

lintProjenRc

@Stability(value=Experimental)
public Eslint.Builder lintProjenRc(Boolean lintProjenRc)

(experimental) Should we lint .projenrc.js.

Default: true

Parameters:

lintProjenRc - Should we lint .projenrc.js. This parameter is required.

Returns:

this

prettier

@Stability(value=Experimental)
public Eslint.Builder prettier(Boolean prettier)

(experimental) Enable prettier for code formatting.

Default: false

Parameters:

prettier - Enable prettier for code formatting. This parameter is required.

Returns:

this

tsAlwaysTryTypes

@Stability(value=Experimental)
public Eslint.Builder tsAlwaysTryTypes(Boolean tsAlwaysTryTypes)

(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

Parameters:

tsAlwaysTryTypes - Always try to resolve types under `@types` directory even it doesn't contain any source code. This parameter is required.

Returns:

this

tsconfigPath

@Stability(value=Experimental)
public Eslint.Builder tsconfigPath(String tsconfigPath)

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

Default: "./tsconfig.json"

Parameters:

tsconfigPath - Path to `tsconfig.json` which should be used by eslint. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public Eslint build()

Specified by:

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