import-js/eslint-plugin-import

import/order group by prefix

Open

#795 建立於 2017年4月6日

在 GitHub 查看
 (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
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
mostly clear
前置要求
Understanding of ESLint plugin architectureFamiliarity with import/order rule configurationKnowledge of AST and import resolution
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
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.