feat(sort-objects): add multiline and method groups

Author: hugop95

docs/content/rules/sort-objects.mdx

@@ -260,6 +260,8 @@ Allows you to specify a list of object keys groups for sorting. Groups help orga
 
 Predefined groups:
 
+- `'multiline'` — Properties with multiline definitions, such as methods or complex type declarations.
+- `'method'` - Members that are methods.
 - `'unknown'` — Properties 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.
@@ -293,17 +295,18 @@ Custom group matching takes precedence over predefined group matching.
 #### Example
 
 Put all properties starting with `id` and `name` at the top, put metadata at the bottom.
-Anything else is put in the middle.
+Regroup multiline and in the middle, above unknown-matched properties.
 
 ```ts
 const user = {
   id: 'id',                   // top
   name: 'John',               // top
-  age: 40,                    // unknown
-  isAdmin: false,             // unknown
-  localization: {             // unknown
+  getEmail: () => null,       // method
+  localization: {             // multiline
     // Stuff about localization
   },
+  age: 40,                    // unknown
+  isAdmin: false,             // unknown
   lastUpdated_metadata: null, // bottom
   version_metadata: '1'       // bottom
 }
@@ -314,14 +317,15 @@ const user = {
 ```js
  {
    groups: [
-+    'top',                  // [!code ++]
-     'unknown',
-     'bottom'                // [!code ++]
++    'top',                     // [!code ++]
+     ['multiline', 'method'],   // [!code ++]
+     ['unknown'],               // [!code ++]
+     'bottom'                   // [!code ++]
    ],
-+  customGroups: {           // [!code ++]
-+    top: ['id', 'name']     // [!code ++]
-+    bottom: '*_metadata'    // [!code ++]
-+  }                         // [!code ++]
++  customGroups: {              // [!code ++]
++    top: ['id', 'name']        // [!code ++]
++    bottom: '*_metadata'       // [!code ++]
++  }                            // [!code ++]
  }
 ```
 

rules/sort-objects.ts

@@ -30,15 +30,7 @@ type MESSAGE_ID =
   | 'unexpectedObjectsGroupOrder'
   | 'unexpectedObjectsOrder'
 
-export enum Position {
-  'exception' = 'exception',
-  'ignore' = 'ignore',
-}
-
-type Group = 'unknown' | string
-type SortingNodeWithPosition = SortingNodeWithDependencies & {
-  position: Position
-}
+type Group = 'multiline' | 'unknown' | 'method' | string
 
 type Options = [
   Partial<{
@@ -220,7 +212,7 @@ export default createEslintRule<Options, MESSAGE_ID>({
 
       validateGroupsConfiguration(
         options.groups,
-        ['unknown'],
+        ['multiline', 'method', 'unknown'],
         Object.keys(options.customGroups),
       )
 
@@ -383,9 +375,9 @@ export default createEslintRule<Options, MESSAGE_ID>({
             | TSESTree.RestElement
             | TSESTree.Property
           )[],
-        ): SortingNodeWithPosition[][] =>
+        ): SortingNodeWithDependencies[][] =>
           props.reduce(
-            (accumulator: SortingNodeWithPosition[][], prop) => {
+            (accumulator: SortingNodeWithDependencies[][], prop) => {
               if (
                 prop.type === 'SpreadElement' ||
                 prop.type === 'RestElement'
@@ -409,10 +401,10 @@ export default createEslintRule<Options, MESSAGE_ID>({
               }
 
               let name: string
-              let position: Position = Position.ignore
               let dependencies: string[] = []
 
-              let { getGroup, setCustomGroups } = useGroups(options)
+              let { getGroup, defineGroup, setCustomGroups } =
+                useGroups(options)
 
               if (prop.key.type === 'Identifier') {
                 ;({ name } = prop.key)
@@ -422,9 +414,28 @@ export default createEslintRule<Options, MESSAGE_ID>({
                 name = sourceCode.text.slice(...prop.key.range)
               }
 
-              let propSortingNode = {
+              if (prop.value.type === 'AssignmentPattern') {
+                dependencies = extractDependencies(prop.value)
+              }
+
+              setCustomGroups(options.customGroups, name)
+
+              if (
+                prop.value.type === 'ArrowFunctionExpression' ||
+                prop.value.type === 'FunctionExpression'
+              ) {
+                defineGroup('method')
+              }
+
+              if (prop.loc.start.line !== prop.loc.end.line) {
+                defineGroup('multiline')
+              }
+
+              let propSortingNode: SortingNodeWithDependencies = {
                 size: rangeToDiff(prop.range),
                 node: prop,
+                group: getGroup(),
+                dependencies,
                 name,
               }
 
@@ -436,20 +447,7 @@ export default createEslintRule<Options, MESSAGE_ID>({
                 accumulator.push([])
               }
 
-              if (prop.value.type === 'AssignmentPattern') {
-                dependencies = extractDependencies(prop.value)
-              }
-
-              setCustomGroups(options.customGroups, name)
-
-              let value = {
-                ...propSortingNode,
-                group: getGroup(),
-                dependencies,
-                position,
-              }
-
-              accumulator.at(-1)!.push(value)
+              accumulator.at(-1)!.push(propSortingNode)
 
               return accumulator
             },

test/sort-objects.test.ts

@@ -1617,6 +1617,35 @@ describe(ruleName, () => {
         invalid: [],
       },
     )
+
+    ruleTester.run(
+      `${ruleName}(${type}): allows to set groups for sorting`,
+      rule,
+      {
+        valid: [
+          {
+            code: dedent`
+              let obj = {
+                z: {
+                  // Some multiline stuff
+                },
+                f: 'a',
+                a1: () => {},
+                a2: function() {},
+                a3() {},
+              }
+            `,
+            options: [
+              {
+                ...options,
+                groups: ['multiline', 'unknown', 'method'],
+              },
+            ],
+          },
+        ],
+        invalid: [],
+      },
+    )
   })
 
   describe(`${ruleName}: sorting by natural order`, () => {