import-js/eslint-plugin-import

Unexpected behavior when using `no-restricted-paths`

Open

#2,773 opened on Apr 28, 2023

View on GitHub
 (3 comments) (0 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

I want a certain directory to only be able to import from one other directory or child directories.

I have the following config:

    "import/no-restricted-paths": ["warn", {
      "zones": [
        {
          "target": "./src/blah/scripts/*",
          "from": "./src/**",
          "except": [
            "**/src/sdk/*",
            "**/src/blah/scripts/**/*"
          ],
          "message": "Scripts must only use the \"sdk\" module."
        }
      ]
    }],

I wouldn't expect to need the ** at the front of the except rules. Am I doing something wrong?

Contributor guide

Research direction
Investigate the glob pattern matching behavior in eslint plugin import's no restricted paths rule. The user expects except patterns to match relative to the from path without needing leading '**/'. Check the documentation and source code to understand how the rule resolves glob patterns.
Tech stack
javascript
Domain
developer experience
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.
Mostly clear
Prerequisites
JavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65