import-js/eslint-plugin-import

Incorrect import group for npm module and local file with same name in same folder

Open

#1,027 opened on Feb 20, 2018

View on GitHub
 (0 comments) (2 reactions) (0 assignees)JavaScript (4,946 stars) (1,540 forks)batch import
bughelp wantedimport/export ordering

Description

When I have a local file in the same folder with the same name of an npm module, the import/order rule detects the import group incorrectly.

My eslint rule config

'import/order': [
  'error',
  {
    groups: [['builtin', 'external'], 'internal', 'parent', ['sibling', 'index']],
    'newlines-between': 'always',
  },
]

My folder structure:

api/ test,js join-monster.js

join-monster is also a package installed in package.json

test.js

import { merge } from 'lodash';
import joinMonster from 'join-monster';

eslint gives this error

E:\Dropbox\Programming\evercare\api\src\app\api\test.js
  1:1  error  There should be at least one empty line between import groups  import/order

I would expect that it should realize 'join-monster' refers to the npm module and './join-monster' refers to the local file.

Contributor guide

Tech stack
javascriptnodejs
Domain
toolingdeveloper experience
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.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
familiarity with eslint pluginsknowledge of node module resolutionunderstanding of import/order rule
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
The issue is in the 'import/order' rule's logic for determining import groups. Investigate how the plugin resolves module names, specifically in the context of npm modules vs local files with identical names. Look at the rule's source code (likely in 'rules/order.js') and the module resolution algorithm used. Examine existing tests for similar edge cases. Consider adding a test case with a local file and npm module sharing a name in the same directory.
Incorrect import group for npm module and local file with same name in same folder · import-js/eslint-plugin-import#1027 | Good First Issue