import-js/eslint-plugin-import

In `import/order`, modules starting with `@/` are always treated as `unknown`

Open

#2249 opened on Oct 7, 2021

View on GitHub
 (3 comments) (6 reactions) (0 assignees)JavaScript (4,946 stars) (1,540 forks)batch import
help wantedimport/export ordering

Description

If you run yarn lint on https://github.com/ykzts-sandbox/nextjs-with-module-path-aliases, you will get the following output.

$ yarn lint
yarn run v1.22.11
$ next lint
info  - Using webpack 5. Reason: Enabled by default https://nextjs.org/docs/messages/webpack5

./pages/index.tsx
5:1  Error: `../styles/Home.module.css` import should occur before import of `@/components/hello`  import/order

info  - Need to disable some ESLint rules? Learn more here: https://nextjs.org/docs/basic-features/eslint#disabling-rules
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

regression from #2146

Contributor guide

Tech stack
javascripttypescriptnodejs
Domain
backenddeveloper experiencetooling
Issue type
bug
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Node.jsESLint plugin developmentModule resolution
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
Start by examining PR #2146, which introduced the regression. Look at the `rules/order.js` file to understand how import types are determined, especially for path aliases. The issue provides a reproduction repo, so clone it and run the linter to see the error. Investigate the logic that classifies imports as 'unknown' and adjust it to recognize `@/` paths properly.