feat(sort-objects): add ignore-function to enable customizable ignore…

… rule

rules/sort-objects.ts

@@ -97,6 +97,9 @@ export default createEslintRule<Options, MESSAGE_ID>({
             },
             type: 'array',
           },
+          'ignore-function': {
+            type: 'object',
+          },
           groups: {
             type: 'array',
           },
@@ -136,7 +139,6 @@ export default createEslintRule<Options, MESSAGE_ID>({
 
       let shouldIgnore = false
 
-      let ignoreFunctions = Object.values(options.customIgnore)
       if (
         ignoreFunctions.length &&
         ignoreFunctions.some(fn => fn(node, context.filename))

test/sort-objects.test.ts

@@ -1,3 +1,5 @@
+import type { TSESTree } from '@typescript-eslint/types'
+
 import { RuleTester } from '@typescript-eslint/rule-tester'
 import { afterAll, describe, it } from 'vitest'
 import { dedent } from 'ts-dedent'
@@ -2866,6 +2868,32 @@ describe(RULE_NAME, () => {
             },
           ],
         },
+        {
+          code: dedent`
+            const buttonStyles = {
+              background: "palevioletred",
+              display: 'flex',
+              flexDirection: 'column',
+              width: "50px",
+              height: "50px",
+            }
+          `,
+          options: [
+            {
+              'ignore-function': {
+                ignoreButtonStyles: (node: TSESTree.ObjectExpression) => {
+                  if (
+                    node.parent.type === 'VariableDeclarator' &&
+                    node.parent.id.type === 'Identifier'
+                  ) {
+                    return node.parent.id.name === 'buttonStyles'
+                  }
+                  return false
+                },
+              },
+            },
+          ],
+        },
       ],
       invalid: [
         {
@@ -2920,6 +2948,42 @@ describe(RULE_NAME, () => {
             },
           ],
         },
+        {
+          code: dedent`
+            const buttonStyles = {
+              background: "palevioletred",
+              display: 'flex',
+              flexDirection: 'column',
+              width: "50px",
+              height: "50px",
+            }
+          `,
+          output: dedent`
+            const buttonStyles = {
+              background: "palevioletred",
+              display: 'flex',
+              flexDirection: 'column',
+              height: "50px",
+              width: "50px",
+            }
+          `,
+          options: [
+            {
+              'ignore-function': {
+                ignoreButtonStyles: () => false,
+              },
+            },
+          ],
+          errors: [
+            {
+              messageId: 'unexpectedObjectsOrder',
+              data: {
+                left: 'width',
+                right: 'height',
+              },
+            },
+          ],
+        },
       ],
     })
   })