import-js/eslint-plugin-import

[import/order] control over fix newlines

Open

#2391 opened on Mar 1, 2022

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

Description

With import/order, when using 'newlines-between': 'always-and-inside-groups' there seems to be no way to control how the fix happens.

Example problem:

import AddressTextField from './AddressTextField'
import CityField from './CityField'

import ContentLoader from 'components/ContentLoader/ContentLoader'
import SeparatedList from 'components/SeparatedList/SeparatedList'

Fix result:

import ContentLoader from 'components/ContentLoader/ContentLoader'

import SeparatedList from 'components/SeparatedList/SeparatedList'

import AddressTextField from './AddressTextField'
import CityField from './CityField'

Desired result:

import ContentLoader from 'components/ContentLoader/ContentLoader'
import SeparatedList from 'components/SeparatedList/SeparatedList'

import AddressTextField from './AddressTextField'
import CityField from './CityField'

Any chance to add support for some control over this?

Possible ways to control:

Contributor guide

Tech stack
javascripttypescriptnodejs
Domain
developer experiencetooling
Issue type
feature
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
ESLint rule developmentJavaScript/TypeScriptAutofix mechanism
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
The issue requests an option to control newline insertion in the import/order rule when using 'always and inside groups'. Investigate the rule implementation in `src/rules/order.js`, focusing on the fix function that adds newlines. Consider implementing a new option (e.g., `newlines between groups`) or modifying the existing behavior to infer from surrounding code. Review related issue #2292 for additional context.