feat(sort-classes): add custom-group to sort-classes rule

Author: gustavopedroni

docs/rules/sort-classes.md

@@ -139,6 +139,7 @@ interface Options {
   order?: 'asc' | 'desc'
   'ignore-case'?: boolean
   groups?: (Group | Group[])[]
+  'custom-groups'?: { [key: string]: string[] | string }
 }
 ```
 
@@ -189,6 +190,22 @@ If you use [one of the configs](/configs/) exported by this plugin, you get the
 }
 ```
 
+### custom-groups
+
+<sub>(default: `{}`)</sub>
+
+You can define your own groups for object keys. The [minimatch](https://github.com/isaacs/minimatch) library is used for pattern matching.
+
+Example:
+
+```
+{
+  "custom-groups": {
+    "top": "id"
+  }
+}
+```
+
 ## ⚙️ Usage
 
 ::: code-group

package.json

@@ -16,6 +16,7 @@
     "docs:dev": "vitepress dev docs",
     "docs:generate": "eslint-doc-generator --rule-list-columns name,description,fixable,hasSuggestions,deprecated --path-rule-list readme.md --url-rule-doc https://eslint-plugin-perfectionist.azat.io/rules/{name} --url-configs https://eslint-plugin-perfectionist.azat.io/configs && eslint-doc-generator --rule-list-columns name,description,fixable,hasSuggestions,deprecated --rule-doc-title-format name --path-rule-list ./docs/rules/index.md --url-rule-doc /rules/{name} --url-configs /configs/ && prettier --write readme.md ./docs/rules/index.md",
     "docs:build": "vitepress build docs",
+    "format:fix": "prettier --write \"**/*.{js,ts,json,md,yml}\"",
     "release": "pnpm release:check && pnpm release:version && pnpm release:publish",
     "release:check": "pnpm test && pnpm run build",
     "release:publish": "clean-publish",

rules/sort-classes.ts

@@ -37,9 +37,11 @@ type Group =
   | 'property'
   | 'unknown'
   | 'method'
+  | string
 
 type Options = [
   Partial<{
+    'custom-groups': { [key: string]: string[] | string }
     groups: (Group[] | Group)[]
     'ignore-case': boolean
     order: SortOrder
@@ -61,6 +63,9 @@ export default createEslintRule<Options, MESSAGE_ID>({
       {
         type: 'object',
         properties: {
+          'custom-groups': {
+            type: 'object',
+          },
           type: {
             enum: [
               SortType.alphabetical,
@@ -105,11 +110,14 @@ export default createEslintRule<Options, MESSAGE_ID>({
           order: SortOrder.asc,
           'ignore-case': false,
           groups: ['property', 'constructor', 'method', 'unknown'],
+          'custom-groups': {},
         })
 
         let nodes: SortingNode[] = node.body.map(member => {
           let name: string
-          let { getGroup, defineGroup } = useGroups(options.groups)
+          let { getGroup, defineGroup, setCustomGroups } = useGroups(
+            options.groups,
+          )
 
           if (member.type === 'StaticBlock') {
             name = 'static'
@@ -127,7 +135,6 @@ export default createEslintRule<Options, MESSAGE_ID>({
           }
 
           let isPrivate = name.startsWith('_') || name.startsWith('#')
-
           let decorated = 'decorators' in member && member.decorators.length > 0
 
           if (member.type === 'MethodDefinition') {
@@ -203,6 +210,10 @@ export default createEslintRule<Options, MESSAGE_ID>({
             defineGroup('property')
           }
 
+          setCustomGroups(options['custom-groups'], name, {
+            override: true,
+          })
+
           return {
             size: rangeToDiff(member.range),
             group: getGroup(),