eslint-plugin-unused-vars
v0.0.3
Published
Report and remove unused es6 modules
Downloads
2,356
Maintainers
Readme
eslint-plugin-unused-vars
Find and remove unused es6 module imports and vars. It works by splitting up the no-unused-vars
rule depending on it being an import statement in the AST and providing an autofix rule to remove the nodes if they are unused. This plugin composes the rule no-unused-vars
of either the typescript or js plugin so be aware that the other plugins needs to be installed and reporting correctly for this to do so.
Version 2.0
Version 2.x.x is for eslint 8 and version 1.x.x is for eslint 6 and 7.
Important for version 1.1
The -ts
rules are deprecated, the package now looks for @typescript-eslint/eslint-plugin
to exist to decide between the typescript and eslint version.
The -ts
rule will still work, but point to the new rule instead.
Typescript
If running typescript with @typescript-eslint make sure to use both @typescript-eslint/eslint-plugin
and @typescript-eslint/parser
.
React
If writing react code you need to install eslint-plugin-react
and enable the two rules react/jsx-uses-react
and react/jsx-uses-vars
. Otherwise all imports for components will be reported unused.
Installation
You'll first need to install ESLint (and @typescript-eslint if using typescript):
npm i eslint --save-dev
Next, install eslint-plugin-unused-vars
:
npm install eslint-plugin-unused-vars --save-dev
Note: If you installed ESLint globally (using the -g
flag) then you must also install eslint-plugin-unused-vars
globally.
Usage
Add unused-vars
to the plugins section of your .eslintrc
configuration file. You can omit the eslint-plugin-
prefix:
{
"plugins": ["unused-vars"]
}
Then configure the rules you want to use under the rules section. I can recommend adding a check for underscores, e.g.
{
"rules": {
"no-unused-vars": "off", // or "@typescript-eslint/no-unused-vars": "off",
"unused-vars/no-unused-imports": "error",
"unused-vars/no-unused-vars": [
"warn",
{
"autoFix": false, // disable auto fix
"vars": "all",
"varsIgnorePattern": "^_",
"args": "after-used",
"argsIgnorePattern": "^_"
}
]
}
}