63 lines
2.2 KiB
Markdown
63 lines
2.2 KiB
Markdown
|
# eslint-plugin-unused-imports
|
||
|
|
|
||
|
|
Find and remove unused es6 module imports. 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 imports. 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.
|
||
|
|
|
||
|
|
## _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](https://github.com/typescript-eslint/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](http://eslint.org) (and [@typescript-eslint](https://github.com/typescript-eslint/typescript-eslint) if using typescript):
|
||
|
|
|
||
|
|
```bash
|
||
|
|
npm i eslint --save-dev
|
||
|
|
```
|
||
|
|
|
||
|
|
Next, install `eslint-plugin-unused-imports`:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
npm install eslint-plugin-unused-imports --save-dev
|
||
|
|
```
|
||
|
|
|
||
|
|
**Note:** If you installed ESLint globally (using the `-g` flag) then you must also install `eslint-plugin-unused-imports` globally.
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
Add `unused-imports` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:
|
||
|
|
|
||
|
|
```json
|
||
|
|
{
|
||
|
|
"plugins": ["unused-imports"]
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
Then configure the rules you want to use under the rules section. I can recommend adding a check for underscores, e.g.
|
||
|
|
|
||
|
|
```json
|
||
|
|
{
|
||
|
|
"rules": {
|
||
|
|
"no-unused-vars": "off", // or "@typescript-eslint/no-unused-vars": "off",
|
||
|
|
"unused-imports/no-unused-imports": "error",
|
||
|
|
"unused-imports/no-unused-vars": [
|
||
|
|
"warn",
|
||
|
|
{ "vars": "all", "varsIgnorePattern": "^_", "args": "after-used", "argsIgnorePattern": "^_" }
|
||
|
|
]
|
||
|
|
}
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
## Supported Rules
|
||
|
|
|
||
|
|
- `no-unused-imports`
|
||
|
|
- `no-unused-vars`
|