import-js/eslint-plugin-import

Add 'allow' option to the no-relative-parent-imports rule or 'ignoreChildren' option to no-internal-modules rule.

Open

#1,118 建立於 2018年6月7日

在 GitHub 查看
 (4 留言) (7 反應) (0 負責人)JavaScript (4,946 star) (1,540 fork)batch import
acceptedenhancementhelp wantedquestion

描述

Our use case is to have some util classes/functions in a folder on top and then always import using relative path. Eg.

src/
 utils/
   util1.js
 comp1/
   index.js
 comp2/
   index.js

From src/comp1/index.js i'd like to be able to import from ../utils/util1 but prohibit import from ../comp2

To achieve this, I see two options:

  1. add 'allow' option to no-relative-parent-imports rule (in the same form as no-internal-modules 'allow'), eg.
"import/no-relative-parent-imports": [ "error", { "allow": ["**/src/utils/**"] } ]
  1. add 'ignoreChildren' option to no-internal-modules to only inspect parent's internal modules, eg.
"import/no-internal-modules": [ "error", { "allow": ["**/src/utils/**"], "ignoreChildren": true  } ]

I'm willing to provide a PR to any of the rules.

貢獻者指南

技術棧
javascriptnodejs
領域
developer experiencetooling
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
half day
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
fresh
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Familiarity with ESLint plugin architectureBasic JavaScriptUnderstanding of import rule configuration
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
60
研究方向
Review the implementation of no relative parent imports and no internal modules rules in the eslint plugin import repository (https://github.com/import js/eslint plugin import). Focus on how the 'allow' option is implemented for no internal modules in src/rules/no internal modules.js. Consider adding a similar 'allow' option to no relative parent imports in src/rules/no relative parent imports.js, or alternatively, add an 'ignoreChildren' option to no internal modules. Examine the existing test files for these rules to understand patterns and ensure compatibility.