import-js/eslint-plugin-import

webpackExports: ["namedExport"] is not supported for dynamic imports

Open

#2,306 opened on Nov 18, 2021

View on GitHub
 (1 comment) (0 reactions) (0 assignees)JavaScript (4,946 stars) (1,540 forks)batch import
enhancementhelp wanted

Description

Webpack 5 has some new magic comments allowing better tree-shaking. https://webpack.js.org/api/module-methods/#magic-comments

Currently, if a comment in the form /* webpackExports: ["namedExport"] */ is added to a dynamic import, eslint shows an error when checking with the import/dynamic-import-chunkname rule.

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-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
knowledge of webpack magic commentsfamiliarity with ESLint rulesJavaScriptNode.js
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
The issue is about adding support for the `webpackExports` magic comment in the `import/dynamic import chunkname` rule. Start by examining the rule implementation in the repository, likely in `src/rules/dynamic import chunkname.js`. Look at how existing magic comments (like `webpackChunkName`) are parsed in the rule's handler. Then, extend the logic to also recognize `webpackExports`. Review the test file for this rule to understand the test patterns and add cases for the new feature. The Webpack documentation at https://webpack.js.org/api/module methods/#magic comments provides the specification. Consider also checking if there are any existing comments or linked PRs for guidance.