Package io.github.cdklabs.projen.javascript

Class Eslint.Builder

  • All Implemented Interfaces:
    software.amazon.jsii.Builder<Eslint>
    Enclosing class:
    Eslint
    @Stability(Experimental)
public static final class Eslint.Builder
extends Object
implements software.amazon.jsii.Builder<Eslint>
    (experimental) A fluent builder for Eslint.

    • Method Detail

      • dirs

        @Stability(Experimental)
public Eslint.Builder dirs​(List<String> dirs)
        (experimental) Files or glob patterns or directories with source files to lint (e.g. [ "src" ]).

        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 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(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(Experimental)
public Eslint.Builder devdirs​(List<String> devdirs)
        (experimental) 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.

        Default: []

        Parameters:
        devdirs - Files or glob patterns or directories with source files that include tests and build tools. This parameter is required.
        Returns:
        this

      • fileExtensions

        @Stability(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(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(Deprecated)
@Deprecated
public Eslint.Builder lintProjenRc​(Boolean lintProjenRc)
        Deprecated.
        set to false to remove any automatic rules and add manually
        (deprecated) Should we lint .projenrc.js.

        Default: true

        Parameters:
        lintProjenRc - Should we lint .projenrc.js. This parameter is required.
        Returns:
        this

      • lintProjenRcFile

        @Stability(Deprecated)
@Deprecated
public Eslint.Builder lintProjenRcFile​(String lintProjenRcFile)
        Deprecated.
        provide as devdirs
        (deprecated) Projenrc file to lint.

        Use empty string to disable.

        Default: "projenrc.js"

        Parameters:
        lintProjenRcFile - Projenrc file to lint. This parameter is required.
        Returns:
        this

      • prettier

        @Stability(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(Experimental)
public Eslint.Builder tsAlwaysTryTypes​(Boolean tsAlwaysTryTypes)
        (experimental) 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.

        Default: true

        Parameters:
        tsAlwaysTryTypes - Always try to resolve types under <root>@types directory even it doesn't contain any source code. This parameter is required.
        Returns:
        this

      • tsconfigPath

        @Stability(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

      • yaml

        @Stability(Experimental)
public Eslint.Builder yaml​(Boolean yaml)
        (experimental) Write eslint configuration as YAML instead of JSON.

        Default: false

        Parameters:
        yaml - Write eslint configuration as YAML instead of JSON. This parameter is required.
        Returns:
        this

      • build

        @Stability(Experimental)
public Eslint build()
        Specified by:
        build in interface software.amazon.jsii.Builder<Eslint>
        Returns:
        a newly built instance of Eslint.