import/order group by prefix · import-js/eslint-plugin-import#795

(9 评论) (5 反应) (0 负责人)JavaScript (4,946 star) (1,540 fork)batch import

enhancementhelp wantedimport/export ordering

描述

I import from all over my app, with a mix of relative and root imports. The current order rule covers most of my cases, and with #629 fixing #389 (sorting alphabetically), that will cover more. But one case that won't be covered is that I prefer to have all my global functions imported first, which come from a /lib directory, followed by my components which come from a /client/modules directory.

Sorting alphabetically, I would have to do

import someComponent from '/client/modules/someComponent';
import someFunction from '/lib/someFunction';

But I'd rather do

import someFunction from '/lib/someFunction';
import someComponent from '/client/modules/someComponent';

Within the rule itself, there's one way I could see it being defined

Use the existing groups option, and anything that isn't currently an option (builtins, sibling, etc) would be considered a prefix "import/order": ["error", {"groups": ["builtins", "external", "/lib", "/client"]}]

This would also handle the concern in this comment that people will start to request a bunch of order types and exceptions to them

贡献者指南

技术栈: javascriptnodejs
领域: developer experiencetooling
议题类型: feature
难度: 3
预计时间: 1-3 hours
活动状态: stale
清晰度: mostly clear
前置要求: Understanding of ESLint plugin architectureFamiliarity with import/order rule configurationKnowledge of AST and import resolution
新手友好度: 30
研究方向: The issue requests adding prefix based grouping to the import/order rule. Referenced PRs: #629 (sorting alphabetically) and #389 (related discussion). The proposed solution modifies the 'groups' option to accept prefix strings. Investigate the current rule implementation in lib/rules/order.js, and review comments for constraints. The maintainers have not responded recently, so engaging the community for input may be necessary.