Package io.github.cdklabs.projen.javascript

Class EslintOptions.Builder

java.lang.Object

io.github.cdklabs.projen.javascript.EslintOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<EslintOptions>

Enclosing interface:

EslintOptions

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

A builder for EslintOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
EslintOptions.Builder	aliasExtensions(List<String> aliasExtensions)	Sets the value of EslintOptions.getAliasExtensions()
EslintOptions.Builder	aliasMap(Map<String,String> aliasMap)	Sets the value of EslintOptions.getAliasMap()
EslintOptions	build()	Builds the configured instance.
EslintOptions.Builder	devdirs(List<String> devdirs)	Sets the value of EslintOptions.getDevdirs()
EslintOptions.Builder	dirs(List<String> dirs)	Sets the value of EslintOptions.getDirs()
EslintOptions.Builder	fileExtensions(List<String> fileExtensions)	Sets the value of EslintOptions.getFileExtensions()
EslintOptions.Builder	ignorePatterns(List<String> ignorePatterns)	Sets the value of EslintOptions.getIgnorePatterns()
EslintOptions.Builder	lintProjenRc(Boolean lintProjenRc)	Deprecated. set to `false` to remove any automatic rules and add manually
EslintOptions.Builder	lintProjenRcFile(String lintProjenRcFile)	Deprecated. provide as `devdirs`
EslintOptions.Builder	prettier(Boolean prettier)	Sets the value of EslintOptions.getPrettier()
EslintOptions.Builder	tsAlwaysTryTypes(Boolean tsAlwaysTryTypes)	Sets the value of EslintOptions.getTsAlwaysTryTypes()
EslintOptions.Builder	tsconfigPath(String tsconfigPath)	Sets the value of EslintOptions.getTsconfigPath()
EslintOptions.Builder	yaml(Boolean yaml)	Sets the value of EslintOptions.getYaml()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

dirs

@Stability(Experimental)
public EslintOptions.Builder dirs(List<String> dirs)

Sets the value of EslintOptions.getDirs()

Parameters:

dirs - Files or glob patterns or directories with source files to lint (e.g. [ "src" ]). This parameter is required.

Returns:

this

aliasExtensions

@Stability(Experimental)
public EslintOptions.Builder aliasExtensions(List<String> aliasExtensions)

Sets the value of EslintOptions.getAliasExtensions()

Parameters:

aliasExtensions - Enable import alias for module paths.

Returns:

this

aliasMap

@Stability(Experimental)
public EslintOptions.Builder aliasMap(Map<String,String> aliasMap)

Sets the value of EslintOptions.getAliasMap()

Parameters:

aliasMap - Enable import alias for module paths.

Returns:

this

devdirs

@Stability(Experimental)
public EslintOptions.Builder devdirs(List<String> devdirs)

Sets the value of EslintOptions.getDevdirs()

Parameters:

devdirs - Files or glob patterns or directories with source files that include tests and build tools. These sources are linted but may also import packages from devDependencies.

Returns:

this

fileExtensions

@Stability(Experimental)
public EslintOptions.Builder fileExtensions(List<String> fileExtensions)

Sets the value of EslintOptions.getFileExtensions()

Parameters:

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

Returns:

this

ignorePatterns

@Stability(Experimental)
public EslintOptions.Builder ignorePatterns(List<String> ignorePatterns)

Sets the value of EslintOptions.getIgnorePatterns()

Parameters:

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

Returns:

this

lintProjenRc

@Stability(Deprecated)
@Deprecated
public EslintOptions.Builder lintProjenRc(Boolean lintProjenRc)

Deprecated.

set to `false` to remove any automatic rules and add manually

Sets the value of EslintOptions.getLintProjenRc()

Parameters:

lintProjenRc - Should we lint .projenrc.js.

Returns:

this

lintProjenRcFile

@Stability(Deprecated)
@Deprecated
public EslintOptions.Builder lintProjenRcFile(String lintProjenRcFile)

Deprecated.

provide as `devdirs`

Sets the value of EslintOptions.getLintProjenRcFile()

Parameters:

lintProjenRcFile - Projenrc file to lint. Use empty string to disable.

Returns:

this

prettier

@Stability(Experimental)
public EslintOptions.Builder prettier(Boolean prettier)

Sets the value of EslintOptions.getPrettier()

Parameters:

prettier - Enable prettier for code formatting.

Returns:

this

tsAlwaysTryTypes

@Stability(Experimental)
public EslintOptions.Builder tsAlwaysTryTypes(Boolean tsAlwaysTryTypes)

Sets the value of EslintOptions.getTsAlwaysTryTypes()

Parameters:

tsAlwaysTryTypes - Always try to resolve types under <root>@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.

Returns:

this

tsconfigPath

@Stability(Experimental)
public EslintOptions.Builder tsconfigPath(String tsconfigPath)

Sets the value of EslintOptions.getTsconfigPath()

Parameters:

tsconfigPath - Path to tsconfig.json which should be used by eslint.

Returns:

this

yaml

@Stability(Experimental)
public EslintOptions.Builder yaml(Boolean yaml)

Sets the value of EslintOptions.getYaml()

Parameters:

yaml - Write eslint configuration as YAML instead of JSON.

Returns:

this

build

@Stability(Experimental)
public EslintOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of EslintOptions

Throws:

NullPointerException - if any required attribute was not provided