import-js/eslint-plugin-import

no-restricted-paths - absolute path expected where relative path is provided

Open

#1,890 opened on Aug 24, 2020

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

Repository metrics

Stars
 (4,946 stars)
PR merge metrics
 (Avg merge 5d 21h) (9 merged PRs in 30d)

Description

I am having trouble with the configuration for this rule and believe there is a bug in the way paths are resolved

// see https://github.com/benmosher/eslint-plugin-import/blob/master/src/rules/no-restricted-paths.js#L72
// it returns a relative path, are we sure thats what we want? 
const absoluteImportPath = resolve(importPath, context)

Here we use resolve which comes from utils/resolve and it returns a relative path

https://github.com/benmosher/eslint-plugin-import/blob/569d72688fa6ae5c038c51eafa4f6016fc1ee802/utils/resolve.js#L220

should we be using path.resolve to return an absolute path instead? I am happy to open a PR with the change once confirmed

to be clear the change I am proposing is

- const absoluteImportPath = resolve(basePath, context)
+ const absoluteImportPath = path.resolve(basePath, importPath);

Contributor guide

Research direction
Examine the files src/rules/no restricted paths.js line 72 and utils/resolve.js line 220. Confirm that the import path resolution should be absolute by checking the rule's expected behavior. If confirmed, change the resolve call to path.resolve, then run tests to ensure no regression. Also check if other rules use similar resolve calls that might need the same fix.
Tech stack
javascriptnodejs
Domain
toolingdeveloper 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.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Basic knowledge of Node.js path moduleFamiliarity with ESLint plugin rules
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70