Is any way for use Webpack alias like internal path? · import-js/eslint-plugin-import#1306

(9 comments) (9 reactions) (0 assignees)JavaScript (4,946 stars) (1,540 forks)batch import

help wantedimport/export ordering

Description

https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/order.md

Seems that only paths like 'src/foo' interpretated like internal. But if you use Webpack, you can define some "path alias" (in 90% ways it's like '@/....', or '~/....'. It used in many boilerplates). Is there any ways for use Webpack alias as internal? I found only one solutions:

node_modules/eslint-plugin-import/lib/core/importType.js
// change
const externalModuleRegExp = /^\w/;
// to
const externalModuleRegExp = /^(\w)|(@+\/)|(~+\/)/;

Contributor guide

Tech stack: javascriptnodejs
Domain: toolingdeveloper experience
Issue type: feature
Difficulty: 2
Estimated time: under 1 hour
Activity status: needs maintainer response
Clarity: clear
Prerequisites: knowledge of eslint plugin import configurationunderstanding of webpack path aliasesbasic regex for modifying module resolution
Newbie friendliness: 55
Research direction: Investigate the source code at `lib/core/importType.js` to understand the regex for external identifiers. The issue suggests modifying `externalModuleRegExp` to include webpack aliases, but a more robust solution would be to add a configuration option in the `import/order` rule. Check existing comments in the issue for prior discussion on implementation approaches.