feat: add ignore-pattern option for sort-objects rule

Author: azat-io

docs/rules/sort-objects.md

@@ -86,6 +86,7 @@ interface Options {
   groups?: (string | string[])[]
   'custom-groups'?: { [key: string]: string[] | string }
   'styled-components'?: boolean
+  'ignore-pattern'?: string[]
   'partition-by-comment'?: string[] | string | boolean
   'partition-by-new-line'?: boolean
 }
@@ -140,6 +141,14 @@ Example:
 
 When `false`, this rule will be disabled for the styled-components like libraries.
 
+### ignore-pattern
+
+<sub>(default: `[]`)</sub>
+
+If you need to ignore a rule for some interfaces, you can specify their names or a pattern to ignore, for example: `'Component*'` to ignore all interfaces whose names begin with the word Component.
+
+The [minimatch](https://github.com/isaacs/minimatch) library is used for pattern matching.
+
 ### partition-by-comment
 
 <sub>(default: `false`)</sub>

rules/sort-objects.ts

@@ -1,6 +1,8 @@
 import type { TSESTree } from '@typescript-eslint/types'
 import type { TSESLint } from '@typescript-eslint/utils'
 
+import { minimatch } from 'minimatch'
+
 import type { PartitionComment, SortingNode } from '../typings'
 
 import { isPartitionComment } from '../utils/is-partition-comment'
@@ -37,6 +39,7 @@ type Options = [
     'partition-by-new-line': boolean
     groups: (string[] | string)[]
     'styled-components': boolean
+    'ignore-pattern': string[]
     'ignore-case': boolean
     order: SortOrder
     type: SortType
@@ -90,6 +93,12 @@ export default createEslintRule<Options, MESSAGE_ID>({
             type: 'boolean',
             default: false,
           },
+          'ignore-pattern': {
+            items: {
+              type: 'string',
+            },
+            type: 'array',
+          },
           groups: {
             type: 'array',
           },
@@ -111,18 +120,35 @@ export default createEslintRule<Options, MESSAGE_ID>({
     let sortObject = (
       node: TSESTree.ObjectExpression | TSESTree.ObjectPattern,
     ) => {
-      if (node.properties.length > 1) {
-        let options = complete(context.options.at(0), {
-          'partition-by-new-line': false,
-          'partition-by-comment': false,
-          type: SortType.alphabetical,
-          'styled-components': true,
-          'ignore-case': false,
-          order: SortOrder.asc,
-          'custom-groups': {},
-          groups: [],
-        })
-
+      let options = complete(context.options.at(0), {
+        'partition-by-new-line': false,
+        'partition-by-comment': false,
+        type: SortType.alphabetical,
+        'styled-components': true,
+        'ignore-case': false,
+        'ignore-pattern': [],
+        order: SortOrder.asc,
+        'custom-groups': {},
+        groups: [],
+      })
+
+      let variableIdentifier =
+        node.parent.type === 'VariableDeclarator' &&
+        node.parent.id.type === 'Identifier'
+          ? node.parent.id.name
+          : null
+
+      let shouldIgnore =
+        options['ignore-pattern'].length &&
+        typeof variableIdentifier === 'string'
+          ? options['ignore-pattern'].some(pattern =>
+              minimatch(variableIdentifier!, pattern, {
+                nocomment: true,
+              }),
+            )
+          : false
+
+      if (!shouldIgnore && node.properties.length > 1) {
         let isStyledCallExpression = (identifier: TSESTree.Expression) =>
           identifier.type === 'Identifier' && identifier.name === 'styled'
 

test/sort-objects.test.ts

@@ -2651,5 +2651,27 @@ describe(RULE_NAME, () => {
         invalid: [],
       },
     )
+
+    ruleTester.run(`${RULE_NAME}: allow to ignore pattern`, rule, {
+      valid: [
+        {
+          code: dedent`
+            const buttonStyles = {
+              background: "palevioletred",
+              display: 'flex',
+              flexDirection: 'column',
+              width: "50px",
+              height: "50px",
+            }
+          `,
+          options: [
+            {
+              'ignore-pattern': ['*Styles'],
+            },
+          ],
+        },
+      ],
+      invalid: [],
+    })
   })
 })