import-js/eslint-plugin-import

[no-restricted-paths] Add options to ignore type imports

Open

#1,899 opened on Sep 14, 2020

View on GitHub
 (7 comments) (9 reactions) (0 assignees)JavaScript (1,540 forks)batch import
enhancementhelp wantedtypescript

Repository metrics

Stars
 (4,946 stars)
PR merge metrics
 (Avg merge 138d 22h) (3 merged PRs in 30d)

Description

Can an option be added to the no-restricted-paths rule to ignore TypeScript's type imports?

// Allow this.
import type { T } from 'some/restricted/path';

// While still disallowing this.
import { foo } from 'some/restricted/path';

My proposal is to add an option at the top level of the config called something along the lines of allowedImportKinds which can be set to any number of the following options: "type" or "value". Additionally, this option could be available in each "zone" so that individual zones can override this behavior (but this may not be needed).

I haven't touched this project's code base before but I can probably whip up a PR for this.

Contributor guide

Research direction
Study the existing `no restricted paths` rule implementation and its configuration options. Identify where import kind can be detected (likely using the AST node's `importKind` property). Implement a new option `allowedImportKinds`.
Tech stack
javascripttypescript
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.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitESLintTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75