import-js/eslint-plugin-import

[newline-after-import] Ignore comments between imports

Open

#2,673 opened on Jan 13, 2023

View on GitHub
 (1 comment) (3 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

Ignore comments between imports when option considerComments is actived in import/newline-after-import.

  • index.js

    import foo from "foo";
// Bar.
// Baz.
import qux from "qux";

// Quux.

  • package.json

    {
    "name": "testcase",
    "version": "1.0.0",
    "type": "module",
    "devDependencies": {
        "eslint": "9.12.0",
        "eslint-plugin-import": "2.31.0"
    }
}

  • eslint.config.js

    import pluginImport from "eslint-plugin-import";

export default [{
    plugins: { "import": pluginImport },

    rules: {
        "import/newline-after-import": ["error", { considerComments: true }]
    }
}];

  1. npm install

  2. npx eslint

    /home/regseb/testcase/index.js
  1:1  error  Expected 1 empty line after import statement not followed by another import  import/newline-after-import

✖ 1 problem (1 error, 0 warnings)
  1 error and 0 warnings potentially fixable with the `--fix` option.

Contributor guide

Research direction
Inspect the rule implementation for 'newline after import' and trace how the 'considerComments' option is handled, especially regarding comments between import statements.
Tech stack
javascript
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitNode.js
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75