import-js/eslint-plugin-import

Ensure packages are imported the same way (`import "react"` vs `import("react")`)

Open

#2,326 opened on Dec 12, 2021

View on GitHub
 (21 comments) (0 reactions) (0 assignees)JavaScript (4,946 stars) (1,540 forks)batch import
help wantedrule proposal

Description

import() is used as an indicator that the bundler can create an additional file (code splitting) instead of including the specified dependency in the main bundle.

Unfortunately it's possible that the same dependency is imported statically in another file, therefore either cancelling the effect or perhaps bundling it twice.

// index
import './a.js'
import './b.js'

// a.js
import { React } from 'react';

// b.js
const { React } = await import('react');

Rule request

Is it possible to ensure that a specific dependency is imported the same way across files automatically?

"import/consistent-import-style": "error"

If not automatically, I wish there was a way to enforce a certain import method per-dependency, for example:

"import/enforce-import-style": [
	"error",
	{
		static: ["react"],
		dynamic: ["my-little-heavy-dep"],
	}
]

Contributor guide

Tech stack
javascriptnodejs
Domain
toolingdeveloper experience
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.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
ESLint plugin developmentunderstanding of import styles
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Investigate how existing rules in eslint plugin import handle import styles, particularly the 'import/no dynamic require' and 'import/no unused modules' rules. Explore the ESLint rule API for creating a new rule that can enforce consistent import styles for specific packages. Look at the linked issue comments for user feedback and potential edge cases. Consider implementing a rule that accepts configuration for static and dynamic imports per dependency.
Ensure packages are imported the same way (`import "react"` vs `import("react")`) · import-js/eslint-plugin-import#2326 | Good First Issue