import-js/eslint-plugin-import

import/newline-after-import: allow disable newline after required in block

Open

#2,458 opened on May 19, 2022

View on GitHubContributor guide
 (11 comments) (0 reactions) (0 assignees)JavaScript (1,549 forks)batch import
enhancementhelp wantedtypescript

Repository metrics

Stars
 (5,940 stars)
PR merge metrics
 (Avg merge 138d 22h) (3 merged PRs in 30d)

Description

Expected:

import { foo } from 'bar'
// newline required here

declare module '*.foo' {
  import { type Foo } from 'bar'
  // no newline required here
  const content: Foo<{}>
  export default content
}

An option like topLevelOnly or disabledInBlockScope would be nice.

Contributor guide

Research direction
Modify the import/newline after import rule to support a new option that disables the newline requirement inside block scopes (e.g., declare module). Look at how existing options like 'considerComments' are implemented. Add logic to detect if the import is inside a block (e.g., using AST node types like BlockStatement, TSModuleBlock).
Tech stack
javascripttypescript
Domain
toolingdeveloper experience
Issue type
Feature
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
JavaScriptNode.jsESLint
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75