import-js/eslint-plugin-import

Allow to disable default resolver

Open

#3095 opened on Nov 6, 2024

View on GitHub
 (1 comment) (1 reaction) (0 assignees)JavaScript (4,946 stars) (1,540 forks)batch import
help wanted

Description

By default eslint merges the config, making it impossible to use a custom resolver with option without the default resolver node being added.

Try 1

settings: {
  'import/resolver': {
    [path.resolve(__dirname, './resolver')]: { /* some options */ },
  },
},

Then the following resolvers are used:

{
  '/home/.../eslint-config/resolver': {},
  node: { extensions: [ '.js', '.jsx', '.json' ] }
}

Try 2:

settings: {
  'import/resolver': {
    [path.resolve(__dirname, './resolver')]: { /* some options */ },
    node: false,
  },
},

Then the following resolvers are used:

{
  '/home/.../eslint-config/resolver': {},
  node: false,
}

And the node resolver is still used, same with null, undefined or other

Try 3:

I can only disable resolver node by doing this, but I can't pass any options:

settings: {
  'import/resolver': path.resolve(__dirname, './resolver'),
},

I propose as a solution not to use a resolver if its configuration is equal to false.

Contributor guide

Tech stack
javascriptnodejs
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.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
ESLint configuration basicsunderstanding of resolver plugin architecture
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Investigate how eslint plugin import merges resolver configs. Look at the 'import/resolver' settings handling in the plugin's source code. The issue suggests that setting a resolver to false should disable it; currently false is ignored. Consider modifying the merge logic to skip resolvers with false values. Check the main resolver setup function and the config merge step.