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 opened on Jun 7, 2018

View on GitHub
 (4 comments) (7 reactions) (0 assignees)JavaScript (4,946 stars) (1,540 forks)batch import
acceptedenhancementhelp wantedquestion

Description

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.

Contributor guide

Tech stack
javascriptnodejs
Domain
developer experiencetooling
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.
half day
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
Familiarity with ESLint plugin architectureBasic JavaScriptUnderstanding of import rule configuration
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
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.
Add 'allow' option to the no-relative-parent-imports rule or 'ignoreChildren' option to no-internal-modules rule. · import-js/eslint-plugin-import#1118 | Good First Issue