import-js/eslint-plugin-import

import/no-self-import incorrectly identifies self.

Open

#1,247 opened on Dec 18, 2018

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

Description

The issue seems to be when you have a local directory that has the same name as a global import. For example, I have a project that uses redis, and the code that uses it sits in a redis directory.

e.g. File: redis/index.js

const redis = require('redis'); // <-- import/no-self-import error here

Contributor guide

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.
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.
mostly clear
Prerequisites
Understanding of ESLint plugin developmentNode.js module resolution
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Investigate the rule implementation in the eslint plugin import repository, likely in src/rules/no self import.js. Understand how the rule currently determines if an import is a self import. The issue occurs when a local directory has the same name as a global package (e.g., 'redis'). The rule should differentiate based on whether the import resolves to the local file or the node modules package. Check existing test cases in tests/src/rules/no self import.js. Look at the module resolution logic (e.g., using eslint module utils/resolve). Consider adding a check to see if the resolved path is within the same project directory.