import-js/eslint-plugin-import

Webpack config function executing multiple times when using `resolve.alias` and `eslint-import-resolver-webpack`

Open

#1,178 opened on Oct 8, 2018

View on GitHub
 (1 comment) (7 reactions) (1 assignee)JavaScript (1,540 forks)batch import
help wantedpackage: resolver/webpack

Repository metrics

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

Description

Description

If webpack.config.js represents config as a function with resolve.alias defined, and when we import/require this alias later in the code while using eslint-import-resolver-webpack for resolving imports in eslint, then webpack config function executing additionally multiple times: one time for each import with alias. I.e. it happens when .eslintrc.js uses eslint-config-airbnb-base and defines wepback import resolver as follows:

module.exports = {
  'extends': ['airbnb-base'],
  'settings': {
    'import/resolver': {
      'webpack': {
        'config': path.join(__dirname, 'webpack.config.js')
      }
    }
  }
};

How to reproduce

  1. Clone a test repo: https://github.com/andreyvolokitin/testcase1
  2. Run npm i && npm run build. The webpack build log in the console will contain multiple additional execute config strings, one for each usage of resolve.alias in src/js/index.js:
test
execute config
execute config
execute config
  1. Remove 'import/resolver' setting from .eslintrc.js and run npm run build again. The build log in console will contain only one instance of execute config:
test
execute config

Contributor guide

Research direction
Investigate how eslint import resolver webpack loads the webpack config and identify why the config function is invoked multiple times. Look for caching or singleton patterns in the resolver's config loading logic. Check if the resolver re executes the config for each import resolution and consider adding memoization.
Tech stack
javascriptnodejs
Domain
build systemdeveloper experiencetooling
Issue type
Bug
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-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Node.jsnpmESLintwebpack
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60