feat(sort-imports): add multiline and singleline modifiers

Author: hugop95

docs/content/rules/sort-imports.mdx

@@ -345,6 +345,8 @@ The list of modifiers is sorted from most to least important:
 - `'default'` — Imports containing the `default` specifier.
 - `'wildcard'` — Imports containing the wildcard (`* as`) specifier.
 - `'named'` — Imports containing at least one named specifier.
+- `'multiline'` — Imports on multiple lines.
+- `'singleline'` — Imports on a single line.
 
 #### Important notes
 

rules/sort-imports.ts

@@ -40,6 +40,7 @@ import { sortNodesByDependencies } from '../utils/sort-nodes-by-dependencies'
 import { getEslintDisabledLines } from '../utils/get-eslint-disabled-lines'
 import { isNodeEslintDisabled } from '../utils/is-node-eslint-disabled'
 import { doesCustomGroupMatch } from '../utils/does-custom-group-match'
+import { isNodeOnSingleLine } from '../utils/is-node-on-single-line'
 import { singleCustomGroupJsonSchema } from './sort-imports/types'
 import { sortNodesByGroups } from '../utils/sort-nodes-by-groups'
 import { allModifiers, allSelectors } from './sort-imports/types'
@@ -219,6 +220,12 @@ export default createEslintRule<Options, MessageId>({
         modifiers.push('named')
       }
 
+      if (isNodeOnSingleLine(node)) {
+        modifiers.push('singleline')
+      } else {
+        modifiers.push('multiline')
+      }
+
       group ??=
         computeGroupExceptUnknown({
           selectors,

rules/sort-imports/types.ts

@@ -211,6 +211,8 @@ export interface SortImportsSortingNode extends SortingNodeWithDependencies {
  */
 export type Modifier =
   | SideEffectModifier
+  | SinglelineModifier
+  | MultilineModifier
   | WildcardModifier
   | TsEqualsModifier
   | RequireModifier
@@ -264,9 +266,15 @@ type ParentTypeSelector = 'parent-type'
 /** Modifier for side-effect imports. */
 type SideEffectModifier = 'side-effect'
 
+/** Modifier for single-line imports. */
+type SinglelineModifier = 'singleline'
+
 /** @deprecated Since v4.12.0. Will be removed in v5.0.0. */
 type IndexTypeSelector = 'index-type'
 
+/** Modifier for multiline imports. */
+type MultilineModifier = 'multiline'
+
 /** Modifier for TypeScript import-equals declarations. */
 type TsEqualsModifier = 'ts-equals'
 
@@ -366,9 +374,11 @@ export let allDeprecatedSelectors: Selector[] = [
  */
 export let allModifiers: Modifier[] = [
   'default',
+  'multiline',
   'named',
   'require',
   'side-effect',
+  'singleline',
   'ts-equals',
   'type',
   'value',

rules/sort-jsx-props.ts

@@ -31,6 +31,7 @@ import { getEslintDisabledLines } from '../utils/get-eslint-disabled-lines'
 import { isNodeEslintDisabled } from '../utils/is-node-eslint-disabled'
 import { doesCustomGroupMatch } from '../utils/does-custom-group-match'
 import { singleCustomGroupJsonSchema } from './sort-jsx-props/types'
+import { isNodeOnSingleLine } from '../utils/is-node-on-single-line'
 import { allModifiers, allSelectors } from './sort-jsx-props/types'
 import { sortNodesByGroups } from '../utils/sort-nodes-by-groups'
 import { createEslintRule } from '../utils/create-eslint-rule'
@@ -115,7 +116,7 @@ export default createEslintRule<Options, MessageId>({
             if (attribute.value === null) {
               modifiers.push('shorthand')
             }
-            if (attribute.loc.start.line !== attribute.loc.end.line) {
+            if (!isNodeOnSingleLine(attribute)) {
               modifiers.push('multiline')
             }
             selectors.push('prop')

rules/sort-object-types.ts

@@ -45,6 +45,7 @@ import { getEslintDisabledLines } from '../utils/get-eslint-disabled-lines'
 import { isMemberOptional } from './sort-object-types/is-member-optional'
 import { isNodeEslintDisabled } from '../utils/is-node-eslint-disabled'
 import { doesCustomGroupMatch } from '../utils/does-custom-group-match'
+import { isNodeOnSingleLine } from '../utils/is-node-on-single-line'
 import { isNodeFunctionType } from '../utils/is-node-function-type'
 import { sortNodesByGroups } from '../utils/sort-nodes-by-groups'
 import { createEslintRule } from '../utils/create-eslint-rule'
@@ -225,7 +226,7 @@ export function sortObjectTypeElements<MessageIds extends string>({
       selectors.push('method')
     }
 
-    if (typeElement.loc.start.line !== typeElement.loc.end.line) {
+    if (!isNodeOnSingleLine(typeElement)) {
       modifiers.push('multiline')
     }
 

rules/sort-objects.ts

@@ -41,6 +41,7 @@ import { getEslintDisabledLines } from '../utils/get-eslint-disabled-lines'
 import { isNodeEslintDisabled } from '../utils/is-node-eslint-disabled'
 import { doesCustomGroupMatch } from '../utils/does-custom-group-match'
 import { UnreachableCaseError } from '../utils/unreachable-case-error'
+import { isNodeOnSingleLine } from '../utils/is-node-on-single-line'
 import { sortNodesByGroups } from '../utils/sort-nodes-by-groups'
 import { createEslintRule } from '../utils/create-eslint-rule'
 import { reportAllErrors } from '../utils/report-all-errors'
@@ -266,7 +267,7 @@ export default createEslintRule<Options, MessageId>({
 
             selectors.push('member')
 
-            if (property.loc.start.line !== property.loc.end.line) {
+            if (!isNodeOnSingleLine(property)) {
               modifiers.push('multiline')
             }
 

test/rules/sort-imports.test.ts

@@ -2635,6 +2635,76 @@ describe('sort-imports', () => {
       })
     })
 
+    it('prioritizes named imports over named multiline imports', async () => {
+      await invalid({
+        errors: [
+          {
+            data: {
+              rightGroup: 'named-import',
+              leftGroup: 'external',
+              right: './z',
+              left: 'f',
+            },
+            messageId: 'unexpectedImportsGroupOrder',
+          },
+        ],
+        options: [
+          {
+            ...options,
+            groups: ['named-import', 'external', 'multiline-import'],
+          },
+        ],
+        output: dedent`
+          import {
+            a,
+            b,
+          } from "./z"
+
+          import f from 'f'
+        `,
+        code: dedent`
+          import f from 'f'
+
+          import {
+            a,
+            b,
+          } from "./z"
+        `,
+      })
+    })
+
+    it('prioritizes named imports over named singleline imports', async () => {
+      await invalid({
+        errors: [
+          {
+            data: {
+              rightGroup: 'named-import',
+              leftGroup: 'external',
+              right: './z',
+              left: 'f',
+            },
+            messageId: 'unexpectedImportsGroupOrder',
+          },
+        ],
+        options: [
+          {
+            ...options,
+            groups: ['named-import', 'external', 'singleline-import'],
+          },
+        ],
+        output: dedent`
+          import { a } from "./z"
+
+          import f from 'f'
+        `,
+        code: dedent`
+          import f from 'f'
+
+          import { a } from "./z"
+        `,
+      })
+    })
+
     it.each([
       ['filters on element name pattern with string', 'hello'],
       ['filters on element name pattern with array', ['noMatch', 'hello']],

test/utils/is-node-on-single-line.test.ts

@@ -0,0 +1,44 @@
+import type { TSESTree } from '@typescript-eslint/types'
+
+import { describe, expect, it } from 'vitest'
+
+import { isNodeOnSingleLine } from '../../utils/is-node-on-single-line'
+
+describe('isNodeOnSingleLine', () => {
+  it('should return true if the node is on a single line', () => {
+    let node = createNode({
+      startLine: 1,
+      endLine: 1,
+    })
+
+    let result = isNodeOnSingleLine(node)
+
+    expect(result).toBeTruthy()
+  })
+
+  it('should return false if the node is on multiple lines', () => {
+    let node = createNode({
+      startLine: 1,
+      endLine: 2,
+    })
+
+    let result = isNodeOnSingleLine(node)
+
+    expect(result).toBeFalsy()
+  })
+
+  function createNode({
+    startLine,
+    endLine,
+  }: {
+    startLine: number
+    endLine: number
+  }): TSESTree.Node {
+    return {
+      loc: {
+        start: { line: startLine, column: 0 },
+        end: { line: endLine, column: 0 },
+      },
+    } as TSESTree.Node
+  }
+})

utils/is-node-on-single-line.ts

@@ -0,0 +1,11 @@
+import type { TSESTree } from '@typescript-eslint/types'
+
+/**
+ * Returns if a node is on a single line.
+ *
+ * @param node - The node to check.
+ * @returns True if the node is on a single line, false otherwise.
+ */
+export function isNodeOnSingleLine(node: TSESTree.Node): boolean {
+  return node.loc.start.line === node.loc.end.line
+}