import-js/eslint-plugin-import

Defining internal-regex and import/external-module-folders together yields unexpected errors

Open

#2,139 opened on Jun 25, 2021

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

Repository metrics

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

Description

In our monorepo we store our internal packages under ./packages

So we tried a config like this:

rules: {
  'import/order': 'warn',
},
settings: {
  'import/internal-regex': '^internal-', //  This makes importing monorepo packages get treated as though they were 'relative-parent-imports'
  'import/external-module-folders': ['node_modules', 'packages'],
}

But that makes a non-relative import throw this unexpected error

import { foo } from 'internal-utils';
                     ^--- // Relative imports from parent directories are not allowed.

Contributor guide

Research direction
Investigate how the combination of 'internal regex' and 'external module folders' settings affects import classification in eslint plugin import. Trace the code path where imports are classified as relative parent imports and determine why internal packages matching the regex are incorrectly treated as relative parent imports.
Tech stack
javascriptnodejs
Domain
developer experiencetooling
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
ESLintNode.js module system
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60