feat(sort-objects): adds `useConfigurationIf.callingFunctionNamePatte…

…rn` option
azat-io · Dec 14, 2024 · 4184e70 · 4184e70
1 parent 574e2cc
commit 4184e70
Show file tree

Hide file tree

Showing 2 changed files with 44 additions and 3 deletions.
diff --git a/docs/content/rules/sort-objects.mdx b/docs/content/rules/sort-objects.mdx
@@ -336,6 +336,25 @@ Example configuration:
 }
 ```
 
+- `callingFunctionNamePattern` — A regexp pattern for matching objects that are passed as arguments to a function with a specific name.
+
+```ts
+{
+  'perfectionist/sort-objects': [
+    'error',
+    {
+      type: 'unsorted', // Don't sort objects passed to createSlice
+      useConfigurationIf: {
+        callingFunctionNamePattern: '^createSlice$',
+      },
+    },
+    {
+      type: 'alphabetical' // Fallback configuration
+    }
+  ],
+}
+```
+
 ### groups
 
 <sub>

diff --git a/rules/sort-objects.ts b/rules/sort-objects.ts
@@ -47,10 +47,11 @@ import { pairwise } from '../utils/pairwise'
 import { matches } from '../utils/matches'
 
 type Options = Partial<{
-  type: 'alphabetical' | 'line-length' | 'unsorted' | 'natural' | 'custom'
   useConfigurationIf: {
+    callingFunctionNamePattern?: string
     allNamesMatchPattern?: string
   }
+  type: 'alphabetical' | 'line-length' | 'unsorted' | 'natural' | 'custom'
   destructuredObjects: { groups: boolean } | boolean
   customGroups: Record<string, string[] | string>
   partitionByComment: string[] | boolean | string
@@ -119,9 +120,24 @@ export default createEslintRule<Options, MESSAGE_ID>({
           .map(property => getNodeName({ sourceCode, property }))
           .filter(nodeName => nodeName !== null),
         contextOptions: context.options,
+      }).find(options => {
+        if (!options.useConfigurationIf?.callingFunctionNamePattern) {
+          return true
+        }
+        if (
+          objectParent?.type === 'VariableDeclarator' ||
+          !objectParent?.name
+        ) {
+          return false
+        }
+        return matches(
+          objectParent.name,
+          options.useConfigurationIf.callingFunctionNamePattern,
+        )
       })
+
       let completeOptions = complete(
-        matchedContextOptions[0],
+        matchedContextOptions,
         settings,
         defaultOptions,
       )
@@ -512,6 +528,13 @@ export default createEslintRule<Options, MESSAGE_ID>({
             },
             type: 'array',
           },
+          useConfigurationIf: buildUseConfigurationIfJsonSchema({
+            additionalProperties: {
+              callingFunctionNamePattern: {
+                type: 'string',
+              },
+            },
+          }),
           partitionByComment: {
             ...partitionByCommentJsonSchema,
             description:
@@ -529,7 +552,6 @@ export default createEslintRule<Options, MESSAGE_ID>({
             description: 'Controls whether to sort styled components.',
             type: 'boolean',
           },
-          useConfigurationIf: buildUseConfigurationIfJsonSchema(),
           type: builtTypeJsonSchema({ withUnsorted: true }),
           partitionByNewLine: partitionByNewLineJsonSchema,
           specialCharacters: specialCharactersJsonSchema,