feat(sort-objects): add custom-ignore to enable customizable ignore rule

azat-io · Apr 22, 2024 · 81b978e · 81b978e
1 parent c2eac1c
commit 81b978e
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 9 deletions.
diff --git a/docs/rules/sort-objects.md b/docs/rules/sort-objects.md
@@ -87,7 +87,7 @@ interface Options {
   'custom-groups'?: { [key: string]: string[] | string }
   'styled-components'?: boolean
   'ignore-pattern'?: string[]
-  'ignore-function'?: { [key: string]: Function }
+  'custom-ignore'?: { [key: string]: Function }
   'partition-by-comment'?: string[] | string | boolean
   'partition-by-new-line'?: boolean
 }
@@ -150,7 +150,7 @@ If you need to ignore a rule for some interfaces, you can specify their names or
 
 The [minimatch](https://github.com/isaacs/minimatch) library is used for pattern matching.
 
-### ignore-function
+### custom-ignore
 
 <sub>(default: `{}`)</sub>
 
@@ -160,7 +160,7 @@ Example:
 
 ```
 {
-  "ignore-function": {
+  "custom-ignore": {
     ignoreButtonStyles: (node: TSESTree.ObjectExpression | TSESTree.ObjectPattern, filename: string) => {
       if (
         node.parent.type === 'VariableDeclarator' &&

diff --git a/rules/sort-objects.ts b/rules/sort-objects.ts
@@ -36,7 +36,7 @@ type SortingNodeWithPosition = SortingNode & {
 type Options = [
   Partial<{
     'custom-groups': { [key: string]: string[] | string }
-    'ignore-function': { [key: string]: Function }
+    'custom-ignore': { [key: string]: Function }
     'partition-by-comment': PartitionComment
     'partition-by-new-line': boolean
     groups: (string[] | string)[]
@@ -101,7 +101,7 @@ export default createEslintRule<Options, MESSAGE_ID>({
             },
             type: 'array',
           },
-          'ignore-function': {
+          'custom-ignore': {
             type: 'object',
           },
           groups: {
@@ -132,14 +132,14 @@ export default createEslintRule<Options, MESSAGE_ID>({
         'styled-components': true,
         'ignore-case': false,
         'ignore-pattern': [],
-        'ignore-function': {},
+        'custom-ignore': {},
         order: SortOrder.asc,
         'custom-groups': {},
         groups: [],
       })
 
       let shouldIgnore = false
-      let ignoreFunctions = Object.values(options['ignore-function'])
+      let ignoreFunctions = Object.values(options['custom-ignore'])
       if (
         ignoreFunctions.length &&
         ignoreFunctions.some(fn => fn(node, context.filename))

diff --git a/test/sort-objects.test.ts b/test/sort-objects.test.ts
@@ -2684,7 +2684,7 @@ describe(RULE_NAME, () => {
           `,
           options: [
             {
-              'ignore-function': {
+              'custom-ignore': {
                 ignoreButtonStyles: (node: TSESTree.ObjectExpression) => {
                   if (
                     node.parent.type === 'VariableDeclarator' &&
@@ -2773,7 +2773,7 @@ describe(RULE_NAME, () => {
           `,
           options: [
             {
-              'ignore-function': {
+              'custom-ignore': {
                 ignoreButtonStyles: () => false,
               },
             },