import-js/eslint-plugin-import

no-unused-modules: ignore imports in files listed in ignoreExports

Open

#2,976 opened on Mar 6, 2024

View on GitHub
 (7 comments) (2 reactions) (0 assignees)JavaScript (1,540 forks)batch import
enhancementhelp wanted

Repository metrics

Stars
 (4,946 stars)
PR merge metrics
 (Avg merge 103d 23h) (3 merged PRs in 30d)

Description

Hello,

I've faced with a problem that it's impossible to warn about unused modules in case the module has imports only to test files, for instance.

Example

Suppose, we have a simple file structure like:

.
├── src/
│   └── do-something/
│       ├── do-something.js
│       └── do-something.test.js
└── .eslintrc.js

do-something.js imported only inside do-something.test.js for tests, obviously.

At the same time files with name *.test.js are ignored by import/no-unused-modules rule in .eslintrc.js:

// .eslintrc.js
module.exports = {
  ...
  settings: {
    "import/extensions": [".js"]
  },
  plugins: ['import'],
  rules: {
    'import/no-unused-modules': [
      2,
      {
        src: ['src'],
        unusedExports: true,
        ignoreExports: ['**/*.test.js'],
      },
    ],
  },
}

Finally, do-something.js has no imports anywhere, except in ignored file with tests of itself. So, it's better to delete do-something.js file and everything related to it.

Is there any way to do something like that in the current version?

Contributor guide

Research direction
Investigate the current implementation of the `no unused modules` rule in `src/rules/no unused modules.js`. Analyze how `ignoreExports` configuration is currently used and where imports from ignored files could be considered. Review existing tests for the rule to understand test patterns. Check the issue comments for any maintainer guidance or community discussion on feasibility.
Tech stack
javascript
Domain
toolingdeveloper experience
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Needs maintainer response
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Basic knowledge of ESLint plugin developmentFamiliarity with eslint plugin import
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45