Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sweepline/eslint-plugin-unused-imports
Package to separate no-unused-vars and no-unused-imports for eslint as well as providing an autofixer for the latter.
https://github.com/sweepline/eslint-plugin-unused-imports
Last synced: 12 days ago
JSON representation
Package to separate no-unused-vars and no-unused-imports for eslint as well as providing an autofixer for the latter.
- Host: GitHub
- URL: https://github.com/sweepline/eslint-plugin-unused-imports
- Owner: sweepline
- License: mit
- Created: 2019-09-18T08:29:17.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-30T14:52:53.000Z (7 months ago)
- Last Synced: 2024-05-17T10:02:47.692Z (6 months ago)
- Language: JavaScript
- Homepage:
- Size: 269 KB
- Stars: 427
- Watchers: 6
- Forks: 17
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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.
## _Versions_
- Version 4.1.x is for eslint 9 with @typescript-eslint/eslint-plugin 5 - 8
- Version 4.0.x is for eslint 9 with @typescript-eslint/eslint-plugin 8
- Version 3.x.x is for eslint 8 with @typescript-eslint/eslint-plugin 6 - 7
- Version 2.x.x is for eslint 8 with @typescript-eslint/eslint-plugin 5
- Version 1.x.x is for eslint 6 and 7.
## 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 `eslint.config.js` configuration file.
```js
import unusedImports from "eslint-plugin-unused-imports";
export default [{
plugins: {
"unused-imports": unusedImports,
},
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`