import-js/eslint-plugin-import

馃悶: [import/newline-after-import] False positively reports wrong empty line numbers between imports with comments

Open

#2913 opened on Oct 31, 2023

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

Description

Something like that:

import './index.scss';

// other imports
import { ErrorBoundary } from 'react-error-boundary';

And my setting is

'import/newline-after-import': [
  'error',
  {
    count: 2,
    exactCount: true,
    considerComments: true
  }
]

It reports like this: image

But this is not the correct behavior, as in the documentation it clearly says:

Enforces having one or more empty lines after the last top-level import statement or require call.

after the last top-level import statement

Note: the exactCount doesn't matter, as I've tried to remove it but it's still causing issue.

Package version: ALL LATEST

Contributor guide

Tech stack
typescriptjavascriptnodejs
Domain
tooling
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
Familiarity with ESLint
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
The bug is in the 'newline after import' rule, likely in 'src/rules/newline after import.js'. The rule needs to correctly identify the last top level import statement, ignoring comments. Investigate the 'considerComments' option and how it interacts with 'exactCount'. Check if there are existing tests for this scenario and consider adding a new test case.