eslint-plugin-unused-imports

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 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-imports:

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.

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

Similar packages

Other packages similar to eslint-plugin-unused-imports

eslint-plugin-import

This package includes a variety of linting rules for import/export syntax, including a rule to detect unused imports. It is more comprehensive than eslint-plugin-unused-imports, offering a wider range of import-related linting features.

eslint-plugin-tree-shaking

This package provides linting rules to help ensure that tree shaking is effective by marking side-effectful module imports. It is similar in its goal to reduce bundle size but focuses more on the side effects rather than just unused imports.