import-js/eslint-plugin-import

Proposal: Warn on importing from a filename for which a directory also exists

Open

#919 opened on Aug 22, 2017

View on GitHub
 (1 comment) (1 reaction) (0 assignees)JavaScript (4,946 stars) (1,540 forks)batch import
acceptedhelp wantedrule proposal

Description

For example, let's say I have the following files:

| something/
|-- index.js
| something.js
| main.js

Inside main.js, I have the following code:

import { helpfulFunction } from './something';

// do something with helpfulFunction()

This is a little dangerous, because did I mean ./something or ./something/? I don't think code should be split up like this—in this case, I would take the contents of something.js and move them to something/index.js and just import from there. A warning would be helpful to track down cases like this.

Contributor guide

Tech stack
javascriptnodejs
Domain
tooling
Issue type
feature
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Node.js module resolutionESLint rule developmentFamiliarity with eslint plugin import
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
Examine existing rules like 'no unresolved' in eslint plugin import to understand the plugin's rule structure. Look at the Node.js module resolution algorithm for handling directory vs file ambiguity. Check the plugin's test fixtures for similar scenarios. The issue is a proposal with no existing implementation.