import-js/eslint-plugin-import

`no-restricted-paths` should support negated glob pattern

Open

#2,800 opened on Jun 16, 2023

View on GitHub
 (6 comments) (4 reactions) (0 assignees)JavaScript (1,540 forks)batch import
help wanted

Repository metrics

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

Description

Bug Description

We cannot use a negated glob pattern (e.g. '!dir_to_exclude/**') in zone.target, zone.from, and zone.except.

Impact

This prevents us from specifying a target that matches anything except certain files or directories. Fixing the bug should help address the use case requested in #2497 as well.

Root Cause

This is due to path.resolve is used to resolve the glob patterns like a relative path (e.g. '!dir_to_exclude/**' becomes '/home/project_dir/!dir_to_exclude/**'), making it invalid.

Suggested Fix

I'd love to suggest the following fix:

  1. When constructing a minimatch matcher, instead of resolving the glob patterns as paths, the glob patterns shall be passed as is to minimatch, and
  2. When matching a path, instead of using the absolute path, the path should be resolved as a relative path to the base path specified in base.

Contributor guide

Research direction
Implement the suggested fix: avoid using path.resolve for glob patterns in minimatch matcher and use relative paths for matching.
Tech stack
javascriptnodejs
Domain
developer experiencetooling
Issue type
Bug
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
JavaScriptESLint
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75