feat: support annotation-based config

Author: hugop95

docs/content/rules/sort-interfaces.mdx

@@ -319,6 +319,7 @@ This option is only applicable when [`partitionByNewLine`](#partitionbynewline)
   {
     allNamesMatchPattern?: string | string[] | { pattern: string; flags: string } | { pattern: string; flags: string }[]
     declarationMatchesPattern?: string | string[] | { pattern: string; flags: string } | { pattern: string; flags: string }[]
+    declarationCommentMatchesPattern?: string | string[] | { pattern: string; flags: string } | { pattern: string; flags: string }[]
   }
   ```
 </sub>
@@ -381,6 +382,26 @@ Example configuration:
 }
 ```
 
+- `declarationCommentMatchesPattern` — A regexp pattern to specify which comments above the interface declaration should match.
+
+Example configuration:
+```ts
+{
+  'perfectionist/sort-interfaces': [
+    'error',
+    {
+      type: 'unsorted', // Don't sort interfaces with a "do not sort" comment
+      useConfigurationIf: {
+        declarationCommentMatchesPattern: '^do not sort$',
+      },
+    },
+    {
+      type: 'alphabetical' // Fallback configuration
+    }
+  ],
+}
+```
+
 ### groups
 
 <sub>

docs/content/rules/sort-object-types.mdx

@@ -284,6 +284,7 @@ This option is only applicable when [`partitionByNewLine`](#partitionbynewline)
   {
     allNamesMatchPattern?: string | string[] | { pattern: string; flags: string } | { pattern: string; flags: string }[]
     declarationMatchesPattern?: string | string[] | { pattern: string; flags: string } | { pattern: string; flags: string }[]
+    declarationCommentMatchesPattern?: string | string[] | { pattern: string; flags: string } | { pattern: string; flags: string }[]
   }
   ```
 </sub>
@@ -347,6 +348,26 @@ Example configuration:
 }
 ```
 
+- `declarationCommentMatchesPattern` — A regexp pattern to specify which comments above the type declaration should match.
+
+Example configuration:
+```ts
+{
+  'perfectionist/sort-object-types': [
+    'error',
+    {
+      type: 'unsorted', // Don't sort object types with a "do not sort" comment
+      useConfigurationIf: {
+        declarationCommentMatchesPattern: '^do not sort$',
+      },
+    },
+    {
+      type: 'alphabetical' // Fallback configuration
+    }
+  ],
+}
+```
+
 ### groups
 
 <sub>

docs/content/rules/sort-objects.mdx

@@ -304,9 +304,7 @@ Specifies whether this rule should be applied to styled-components like librarie
 <sub>
   type:
   ```
-  {
-    allNamesMatchPattern?: string | string[] | { pattern: string; flags: string } | { pattern: string; flags: string }[]
-  }
+    string | string[] | { pattern: string; flags: string } | { pattern: string; flags: string }[]
   ```
 </sub>
 <sub>default: `[]`</sub>
@@ -349,6 +347,7 @@ The `groups` attribute specifies whether to use groups to sort destructured obje
   {
     allNamesMatchPattern?: string | string[] | { pattern: string; flags: string } | { pattern: string; flags: string }[]
     callingFunctionNamePattern?: string | string[] | { pattern: string; flags: string } | { pattern: string; flags: string }[]
+    declarationCommentMatchesPattern?: string | string[] | { pattern: string; flags: string } | { pattern: string; flags: string }[]
   }
   ```
 </sub>
@@ -394,6 +393,7 @@ Example configuration:
 
 - `callingFunctionNamePattern` — A regexp pattern for matching objects that are passed as arguments to a function with a specific name.
 
+Example configuration:
 ```ts
 {
   'perfectionist/sort-objects': [
@@ -411,6 +411,26 @@ Example configuration:
 }
 ```
 
+- `declarationCommentMatchesPattern` — A regexp pattern to specify which comments above the object declaration should match.
+
+Example configuration:
+```ts
+{
+  'perfectionist/sort-objects': [
+    'error',
+    {
+      type: 'unsorted', // Don't sort objects with a "do not sort" comment
+      useConfigurationIf: {
+        declarationCommentMatchesPattern: '^do not sort$',
+      },
+    },
+    {
+      type: 'alphabetical' // Fallback configuration
+    }
+  ],
+}
+```
+
 ### groups
 
 <sub>

rules/sort-array-includes.ts

@@ -29,7 +29,7 @@ import {
   singleCustomGroupJsonSchema,
   allSelectors,
 } from './sort-array-includes/types'
-import { getMatchingContextOptions } from '../utils/get-matching-context-options'
+import { filterOptionsByAllNamesMatch } from '../utils/filter-options-by-all-names-match'
 import { generatePredefinedGroups } from '../utils/generate-predefined-groups'
 import { getEslintDisabledLines } from '../utils/get-eslint-disabled-lines'
 import { isNodeEslintDisabled } from '../utils/is-node-eslint-disabled'
@@ -57,7 +57,7 @@ type SortArrayIncludesSortingNode = SortingNode<
   TSESTree.SpreadElement | TSESTree.Expression
 >
 
-export let defaultOptions: Required<Options[0]> = {
+export let defaultOptions: Required<Options[number]> = {
   fallbackSort: { type: 'unsorted' },
   specialCharacters: 'keep',
   partitionByComment: false,
@@ -162,7 +162,7 @@ export function sortArray<MessageIds extends string>({
   let { sourceCode, id } = context
   let settings = getSettings(context.settings)
 
-  let matchedContextOptions = getMatchingContextOptions({
+  let matchedContextOptions = filterOptionsByAllNamesMatch({
     nodeNames: elements
       .filter(element => element !== null)
       .map(element => getNodeName({ sourceCode, element })),

rules/sort-classes.ts

@@ -62,7 +62,7 @@ type MessageId =
   | 'unexpectedClassesGroupOrder'
   | 'unexpectedClassesOrder'
 
-let defaultOptions: Required<SortClassesOptions[0]> = {
+let defaultOptions: Required<SortClassesOptions[number]> = {
   groups: [
     'index-signature',
     ['static-property', 'static-accessor-property'],

rules/sort-decorators.ts

@@ -46,7 +46,7 @@ type MessageId =
   | 'extraSpacingBetweenDecorators'
   | 'unexpectedDecoratorsOrder'
 
-let defaultOptions: Required<Options[0]> = {
+let defaultOptions: Required<Options[number]> = {
   fallbackSort: { type: 'unsorted' },
   specialCharacters: 'keep',
   partitionByComment: false,
@@ -190,7 +190,7 @@ export default createEslintRule<Options, MessageId>({
 
 function sortDecorators(
   context: Readonly<RuleContext<MessageId, Options>>,
-  options: Required<Options[0]>,
+  options: Required<Options[number]>,
   decorators: TSESTree.Decorator[],
 ): void {
   if (!isSortable(decorators)) {

rules/sort-enums.ts

@@ -53,7 +53,7 @@ interface SortEnumsSortingNode
   value: string | null
 }
 
-let defaultOptions: Required<Options[0]> = {
+let defaultOptions: Required<Options[number]> = {
   fallbackSort: { type: 'unsorted' },
   partitionByComment: false,
   partitionByNewLine: false,
@@ -364,7 +364,7 @@ function computeNodeValueGetter({
   isNumericEnum,
   options,
 }: {
-  options: Pick<Required<Options[0]>, 'forceNumericSort' | 'sortByValue'>
+  options: Pick<Required<Options[number]>, 'forceNumericSort' | 'sortByValue'>
   isNumericEnum: boolean
 }): NodeValueGetterFunction<SortEnumsSortingNode> | null {
   return options.sortByValue || (isNumericEnum && options.forceNumericSort)
@@ -382,7 +382,7 @@ function computeOptionType({
   options,
 }: {
   options: Pick<
-    Required<Options[0]>,
+    Required<Options[number]>,
     'forceNumericSort' | 'sortByValue' | 'type'
   >
   isNumericEnum: boolean

rules/sort-exports.ts

@@ -51,7 +51,7 @@ type SortExportsSortingNode = SortingNode<
   TSESTree.ExportNamedDeclarationWithSource | TSESTree.ExportAllDeclaration
 >
 
-let defaultOptions: Required<Options[0]> = {
+let defaultOptions: Required<Options[number]> = {
   fallbackSort: { type: 'unsorted' },
   specialCharacters: 'keep',
   partitionByComment: false,

rules/sort-heritage-clauses.ts

@@ -42,7 +42,7 @@ type MessageId =
   | 'extraSpacingBetweenHeritageClauses'
   | 'unexpectedHeritageClausesOrder'
 
-let defaultOptions: Required<Options[0]> = {
+let defaultOptions: Required<Options[number]> = {
   fallbackSort: { type: 'unsorted' },
   specialCharacters: 'keep',
   newlinesBetween: 'ignore',
@@ -116,7 +116,7 @@ export default createEslintRule<Options, MessageId>({
 
 function sortHeritageClauses(
   context: Readonly<RuleContext<MessageId, Options>>,
-  options: Required<Options[0]>,
+  options: Required<Options[number]>,
   heritageClauses:
     | TSESTree.TSInterfaceHeritage[]
     | TSESTree.TSClassImplements[]

rules/sort-imports.ts

@@ -64,8 +64,10 @@ export type MessageId =
   | 'missedCommentAboveImport'
   | 'unexpectedImportsOrder'
 
-let defaultOptions: Required<Omit<Options[0], 'maxLineLength' | 'tsconfig'>> &
-  Pick<Options[0], 'maxLineLength' | 'tsconfig'> = {
+let defaultOptions: Required<
+  Omit<Options[number], 'maxLineLength' | 'tsconfig'>
+> &
+  Pick<Options[number], 'maxLineLength' | 'tsconfig'> = {
   groups: [
     'type-import',
     ['value-builtin', 'value-external'],
@@ -533,7 +535,7 @@ function computeGroupExceptUnknown({
   options,
   name,
 }: {
-  options: Omit<Required<Options[0]>, 'maxLineLength' | 'tsconfig'>
+  options: Omit<Required<Options[number]>, 'maxLineLength' | 'tsconfig'>
   selectors: Selector[]
   modifiers: Modifier[]
   name: string