import-js / import-js/eslint-plugin-import

core modules docs are misleading

Open
#2,986 1 comment 0 reactions 0 assignees View on GitHub
docs
Dominant language
JavaScript
Stars
5.9k
Forks
1.5k
PR merge metrics
No merged PRs in 30d

Description

related: https://github.com/import-js/eslint-plugin-import/issues/1390

https://github.com/import-js/eslint-plugin-import?tab=readme-ov-file#importcore-modules

The docs definitely imply that all you need for `import/core-modules` is a list of modules to import. But it should be

```
import/core-modules: [2, electron ]
```

as far as I can tell.

Contributor guide

Open the contributing guide

Research direction

Open the README's import/core-modules section and compare its documented configuration with the syntax shown in the issue and the related issue. Update the example or wording so the required severity and module list are clear, then verify the rendered README reflects the intended configuration.

Written by the indexing model from the issue text.

Assessment

Tech stack
eslint, javascript
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.