Class Eslint

Hierarchy

Eslint
- Eslint

Index

Constructors

constructor

new Eslint(project, options?): Eslint
Parameters
- project: GitHooksEnabledProject
- Optional options: EslintOptions
  Optional
Returns Eslint

Overrides javascript.Eslint.constructor

Properties

`Readonly` config

config: any

Direct access to the eslint configuration (escape hatch)

`Private` eslintExtendsOverride

eslintExtendsOverride: string[]

`Readonly` eslintTask

eslintTask: Task

eslint task.

`Readonly` ignorePatterns

ignorePatterns: string[]

File patterns that should not be linted

`Readonly` overrides

overrides: EslintOverride[]

eslint overrides.

project

project: GitHooksEnabledProject

`Readonly` rules

rules: {
[rule: string]: any[];
}

eslint rules.

Type declaration

[rule: string]: any[]

`Static` defaultOptions

defaultOptions: {
dirs: string[];
prettier: boolean;
} = ...

Type declaration

dirs: string[]
prettier: boolean

`Static` defaultRules

defaultRules: {
    @typescript-eslint/array-type: (string | {
        default: string;
    })[];
    @typescript-eslint/ban-types: (string | {
        extendDefaults: boolean;
        types: {
            {}: boolean;
        };
    })[];
    @typescript-eslint/no-empty-function: string[];
    @typescript-eslint/no-unused-vars: string[];
    @typescript-eslint/quotes: (string | {
        allowTemplateLiterals: boolean;
        avoidEscape: boolean;
    })[];
    dot-notation: string;
    import/no-extraneous-dependencies: (string | {
        devDependencies: string[];
        optionalDependencies: boolean;
        peerDependencies: boolean;
    })[];
    indent: (string | number | {
        SwitchCase: number;
    })[];
    linebreak-style: number;
    max-len: (string | {
        code: number;
        ignoreUrls: boolean;
        tabWidth: number;
    })[];
    no-empty-function: string;
    no-tabs: (string | {
        allowIndentationTabs: boolean;
    })[];
    no-unused-vars: string;
    quotes: (string | number | {
        avoidEscape: boolean;
    })[];
} = ...

Type declaration

@typescript-eslint/array-type: (string | {
default: string;
})[]
@typescript-eslint/ban-types: (string | {
    extendDefaults: boolean;
    types: {
        {}: boolean;
    };
})[]
@typescript-eslint/no-empty-function: string[]
@typescript-eslint/no-unused-vars: string[]
@typescript-eslint/quotes: (string | {
allowTemplateLiterals: boolean;
avoidEscape: boolean;
})[]
dot-notation: string
import/no-extraneous-dependencies: (string | {
    devDependencies: string[];
    optionalDependencies: boolean;
    peerDependencies: boolean;
})[]
indent: (string | number | {
SwitchCase: number;
})[]
linebreak-style: number
max-len: (string | {
    code: number;
    ignoreUrls: boolean;
    tabWidth: number;
})[]
no-empty-function: string
no-tabs: (string | {
allowIndentationTabs: boolean;
})[]
no-unused-vars: string
quotes: (string | number | {
avoidEscape: boolean;
})[]

Methods

addExtends

addExtends(...extendList): void
Adds an extends item to the eslint configuration.
Parameters
- Rest ...extendList: string[]
  
  The list of "extends" to add.
  
  Rest
Returns void

Inherited from javascript.Eslint.addExtends

addIgnorePattern

addIgnorePattern(pattern): void
Do not lint these files.
Parameters
- pattern: string
Returns void

Inherited from javascript.Eslint.addIgnorePattern

addLintPattern

addLintPattern(pattern): void
Add a file, glob pattern or directory with source files to lint (e.g. [ "src" ])
Parameters
- pattern: string
Returns void

Inherited from javascript.Eslint.addLintPattern

addOverride

addOverride(override): void
Add an eslint override.
Parameters
- override: EslintOverride
Returns void

Inherited from javascript.Eslint.addOverride

addPlugins

addPlugins(...plugins): void
Adds an eslint plugin
Parameters
- Rest ...plugins: string[]
  
  The names of plugins to add
  
  Rest
Returns void

Inherited from javascript.Eslint.addPlugins

addRules

addRules(rules): void
Add an eslint rule.
Parameters
- rules: {
  [rule: string]: any;
  }
  - [rule: string]: any
Returns void

Inherited from javascript.Eslint.addRules

allowDevDeps

allowDevDeps(pattern): void
Add a glob file pattern which allows importing dev dependencies.
Parameters
- pattern: string
  
  glob pattern.
Returns void

Inherited from javascript.Eslint.allowDevDeps

postSynthesize

postSynthesize(): void
Called after synthesis. Order is not guaranteed.

Returns void

Inherited from javascript.Eslint.postSynthesize

preSynthesize

preSynthesize(): void
Returns void

Overrides javascript.Eslint.preSynthesize

synthesize

synthesize(): void
Synthesizes files to the project output directory.

Returns void

Inherited from javascript.Eslint.synthesize

`Static` of

of(project): undefined | Eslint
Returns the singletone component of a project or undefined if there is none.
Parameters
- project: GitHooksEnabledProject
Returns undefined | Eslint

Overrides javascript.Eslint.of

Class Eslint

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

project: GitHooksEnabledProject

Optional options: EslintOptions

Returns Eslint

Properties

Readonly config

Private eslintExtendsOverride

Readonly eslintTask

Readonly ignorePatterns

Readonly overrides

project

Readonly rules

Type declaration

[rule: string]: any[]

Static defaultOptions

Type declaration

dirs: string[]

prettier: boolean

Static defaultRules

Type declaration

@typescript-eslint/array-type: (string | { default: string; })[]

@typescript-eslint/ban-types: (string | { extendDefaults: boolean; types: { {}: boolean; }; })[]

@typescript-eslint/no-empty-function: string[]

@typescript-eslint/no-unused-vars: string[]

@typescript-eslint/quotes: (string | { allowTemplateLiterals: boolean; avoidEscape: boolean; })[]

dot-notation: string

import/no-extraneous-dependencies: (string | { devDependencies: string[]; optionalDependencies: boolean; peerDependencies: boolean; })[]

indent: (string | number | { SwitchCase: number; })[]

linebreak-style: number

max-len: (string | { code: number; ignoreUrls: boolean; tabWidth: number; })[]

no-empty-function: string

no-tabs: (string | { allowIndentationTabs: boolean; })[]

no-unused-vars: string

quotes: (string | number | { avoidEscape: boolean; })[]

Methods

addExtends

Parameters

Rest ...extendList: string[]

Returns void

addIgnorePattern

Parameters

pattern: string

Returns void

addLintPattern

Parameters

pattern: string

Returns void

addOverride

Parameters

override: EslintOverride

Returns void

addPlugins

Parameters

Rest ...plugins: string[]

Returns void

addRules

Parameters

rules: { [rule: string]: any; }

[rule: string]: any

Returns void

allowDevDeps

Parameters

pattern: string

Returns void

postSynthesize

Returns void

preSynthesize

Returns void

synthesize

Returns void

Static of

Parameters

`Optional` options: EslintOptions

`Readonly` config

`Private` eslintExtendsOverride

`Readonly` eslintTask

`Readonly` ignorePatterns

`Readonly` overrides

`Readonly` rules

`Static` defaultOptions

`Static` defaultRules

@typescript-eslint/array-type: (string | {
default: string;
})[]

@typescript-eslint/ban-types: (string | {
extendDefaults: boolean;
types: {
{}: boolean;
};
})[]

@typescript-eslint/quotes: (string | {
allowTemplateLiterals: boolean;
avoidEscape: boolean;
})[]

import/no-extraneous-dependencies: (string | {
devDependencies: string[];
optionalDependencies: boolean;
peerDependencies: boolean;
})[]

indent: (string | number | {
SwitchCase: number;
})[]

max-len: (string | {
code: number;
ignoreUrls: boolean;
tabWidth: number;
})[]

no-tabs: (string | {
allowIndentationTabs: boolean;
})[]

quotes: (string | number | {
avoidEscape: boolean;
})[]

`Rest` ...extendList: string[]

`Rest` ...plugins: string[]

rules: {
[rule: string]: any;
}

`Static` of