TypeScriptESLintPlugin
A plugin for TypeScript which provides eslint-reports to your IDE.
Getting Started
First you need to have eslint
installed.
You can install it by invoking this command:
npm install -D eslint
Next go ahead and install this plugin:
npm install -D @manuth/typescript-eslint-plugin
As a last step open up your project's tsconfig.json
-file and add this plugin to the settings:
{
"compilerOptions": {
"plugins": [
{
"name": "@manuth/typescript-eslint-plugin",
"configFile": "./my.eslintrc.js"
}
]
}
}
Configuration
You might want to change the behaviour of this plugin to your likings. Following settings are supported:
-
ignoreJavaScript
:
Allows you to disable eslint-reports in JavaScript files (default isfalse
) -
ignoreTypeScript
:
Allows you to disable eslint-reports in TypeScript files (default isfalse
) -
allowInlineConfig
:
Allows you to disable eslint configuration-comments (default istrue
) -
reportUnusedDisableDirectives
:
Use this setting to disable errors when uselesseslint-disable-next-line
-comments are reported (default istrue
). -
useEslintrc
:
You can disable the processing of.eslintrc.*
-files by setting this tofalse
(default istrue
) -
configFile
:
Allows you to specify a custom config-file to use (default isundefined
) -
alwaysShowRuleFailuresAsWarnings
:
By setting this totrue
all rule-failures, regardless whether you setwarn
orerror
are represented as warnings (default isfalse
) -
suppressWhileTypeErrorsPresent
:
Allows you to disableeslint
while there are other errors present (default isfalse
) -
suppressDeprecationWarnings
:
Usually this plugin reports warnings when deprecated rules are in use. Use this setting to disable this feature. (default isfalse
) -
suppressConfigNotFoundError
:
By setting this option totrue
you can enable errors if no eslint-configuration could be found (defaulttrue
) -
packageManager
:
Set this option either tonpm
,pnpm
oryarn
to load global modules correctly and get proper commands in error messages. (default isnpm
) -
logLevel
:
Allows you to set the verbosity of this plugin in theTS Server log
either tonone
,normal
orverbose
. (default isnone
)
Note
When updating the configuration of the plugin using a ConfigurePluginRequest
, the settings made in tsconfig.json
will persist, as tsconfig.json
-settings have a higher priority than the dynamic settings sent using a ConfigurePluginRequest
.
Please let me know if this is not the behaviour you'd expect.