feat: add method group in sort-interfaces

azat-io · Oct 10, 2024 · b797371 · b797371
1 parent 28f65a6
commit b797371
Show file tree

Hide file tree

Showing 3 changed files with 79 additions and 2 deletions.
diff --git a/docs/content/rules/sort-interfaces.mdx b/docs/content/rules/sort-interfaces.mdx
@@ -236,6 +236,7 @@ Allows you to specify a list of interface member groups for sorting. Groups help
 Predefined groups:
 
 - `'multiline'` — Members with multiline definitions, such as methods or properties with complex types.
+- `'method'` - Members that are methods.
 - `'unknown'` — Interface members that don’t fit into any group specified in the `groups` option.
 
 If the `unknown` group is not specified in the `groups` option, it will automatically be added to the end of the list.
@@ -270,6 +271,7 @@ interface User {
 {
   groups: [
     'unknown',
+    'method',
     'multiline',
   ]
 }

diff --git a/rules/sort-interfaces.ts b/rules/sort-interfaces.ts
@@ -22,7 +22,7 @@ type MESSAGE_ID =
   | 'unexpectedInterfacePropertiesGroupOrder'
   | 'unexpectedInterfacePropertiesOrder'
 
-type Group<T extends string[]> = 'multiline' | 'unknown' | T[number]
+type Group<T extends string[]> = 'multiline' | 'unknown' | T[number] | 'method'
 
 type Options<T extends string[]> = [
   Partial<{
@@ -195,7 +195,7 @@ export default createEslintRule<Options<string[]>, MESSAGE_ID>({
 
         validateGroupsConfiguration(
           options.groups,
-          ['multiline', 'unknown'],
+          ['multiline', 'method', 'unknown'],
           Object.keys(options.customGroups),
         )
 
@@ -246,6 +246,15 @@ export default createEslintRule<Options<string[]>, MESSAGE_ID>({
 
               setCustomGroups(options.customGroups, name)
 
+              if (
+                element.type === 'TSMethodSignature' ||
+                (element.type === 'TSPropertySignature' &&
+                  element.typeAnnotation?.typeAnnotation.type ===
+                    'TSFunctionType')
+              ) {
+                defineGroup('method')
+              }
+
               if (element.loc.start.line !== element.loc.end.line) {
                 defineGroup('multiline')
               }

diff --git a/test/sort-interfaces.test.ts b/test/sort-interfaces.test.ts
@@ -1025,6 +1025,28 @@ describe(ruleName, () => {
         invalid: [],
       },
     )
+
+    ruleTester.run(`${ruleName}(${type}): allows to use method group`, rule, {
+      valid: [
+        {
+          code: dedent`
+              interface Interface {
+                b(): void
+                c: () => void
+                a: string
+                d: string
+              }
+            `,
+          options: [
+            {
+              ...options,
+              groups: ['method', 'unknown'],
+            },
+          ],
+        },
+      ],
+      invalid: [],
+    })
   })
 
   describe(`${ruleName}: sorting by natural order`, () => {
@@ -1782,6 +1804,28 @@ describe(ruleName, () => {
         ],
       },
     )
+
+    ruleTester.run(`${ruleName}(${type}): allows to use method group`, rule, {
+      valid: [
+        {
+          code: dedent`
+              interface Interface {
+                b(): void
+                c: () => void
+                a: string
+                d: string
+              }
+            `,
+          options: [
+            {
+              ...options,
+              groups: ['method', 'unknown'],
+            },
+          ],
+        },
+      ],
+      invalid: [],
+    })
   })
 
   describe(`${ruleName}: sorting by line length`, () => {
@@ -2746,6 +2790,28 @@ describe(ruleName, () => {
         ],
       },
     )
+
+    ruleTester.run(`${ruleName}(${type}): allows to use method group`, rule, {
+      valid: [
+        {
+          code: dedent`
+              interface Interface {
+                c: () => void
+                b(): void
+                a: string
+                d: string
+              }
+            `,
+          options: [
+            {
+              ...options,
+              groups: ['method', 'unknown'],
+            },
+          ],
+        },
+      ],
+      invalid: [],
+    })
   })
 
   describe(`${ruleName}: validating group configuration`, () => {