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 (1,540 forks)batch import
acceptedhelp wantedrule proposal

Repository metrics

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

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

Research direction
Implement a new ESLint rule that warns when a module resolves to a file that has a sibling directory with the same name, causing ambiguity.
Tech stack
javascript
Domain
tooling
Issue type
Feature
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
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75