Package 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.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.163Z")
@Stability(Experimental)
public interface EslintOptions
extends software.amazon.jsii.JsiiSerializable

    • Method Detail

      • getDirs

        @Stability(Experimental)
@NotNull
List<String> getDirs()
        (experimental) Files or glob patterns or directories with source files to lint (e.g. [ "src" ]).

      • getAliasExtensions

        @Stability(Experimental)
@Nullable
default List<String> getAliasExtensions()
        (experimental) Enable import alias for module paths.

        Default: undefined

      • getAliasMap

        @Stability(Experimental)
@Nullable
default Map<String,​String> getAliasMap()
        (experimental) Enable import alias for module paths.

        Default: undefined

      • getDevdirs

        @Stability(Experimental)
@Nullable
default List<String> getDevdirs()
        (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: []

      • getFileExtensions

        @Stability(Experimental)
@Nullable
default List<String> getFileExtensions()
        (experimental) File types that should be linted (e.g. [ ".js", ".ts" ]).

        Default: [".ts"]

      • getIgnorePatterns

        @Stability(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(Deprecated)
@Deprecated
@Nullable
default Boolean getLintProjenRc()
        Deprecated.
        set to false to remove any automatic rules and add manually
        (deprecated) Should we lint .projenrc.js.

        Default: true

      • getLintProjenRcFile

        @Stability(Deprecated)
@Deprecated
@Nullable
default String getLintProjenRcFile()
        Deprecated.
        provide as devdirs
        (deprecated) Projenrc file to lint.

        Use empty string to disable.

        Default: "projenrc.js"

      • getPrettier

        @Stability(Experimental)
@Nullable
default Boolean getPrettier()
        (experimental) Enable prettier for code formatting.

        Default: false

      • getTsAlwaysTryTypes

        @Stability(Experimental)
@Nullable
default Boolean getTsAlwaysTryTypes()
        (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

      • getTsconfigPath

        @Stability(Experimental)
@Nullable
default String getTsconfigPath()
        (experimental) Path to tsconfig.json which should be used by eslint.

        Default: "./tsconfig.json"

      • getYaml

        @Stability(Experimental)
@Nullable
default Boolean getYaml()
        (experimental) Write eslint configuration as YAML instead of JSON.

        Default: false