feat: allow separating object properties into logical parts

azat-io · Jun 16, 2023 · 933b621 · 933b621
1 parent 8703209
commit 933b621
Show file tree

Hide file tree

Showing 8 changed files with 532 additions and 18 deletions.
diff --git a/docs/rules/sort-objects.md b/docs/rules/sort-objects.md
@@ -84,6 +84,7 @@ interface Options {
   order?: 'asc' | 'desc'
   'ignore-case'?: boolean
   'always-on-top'?: string[]
+  'partition-by-comment': string[] | string | boolean
 }
 ```
 
@@ -114,6 +115,14 @@ Only affects alphabetical and natural sorting. When `true` the rule ignores the
 
 You can set a list of key names that will always go at the beginning of the object. For example: `['id', 'name']`
 
+### partition-by-comment
+
+<sub>(default: `false`)</sub>
+
+You can set comments that would separate the properties of objects into logical parts. If set to `true`, all object property comments will be treated as delimiters.
+
+The [minimatch](https://github.com/isaacs/minimatch) library is used for pattern matching.
+
 ## ⚙️ Usage
 
 ::: code-group
@@ -127,7 +136,9 @@ You can set a list of key names that will always go at the beginning of the obje
       "error",
       {
         "type": "natural",
-        "order": "asc"
+        "order": "asc",
+        "always-on-top": ["id", "name"],
+        "partition-by-comment": "Part:**"
       }
     ]
   }
@@ -149,6 +160,8 @@ export default [
         {
           type: 'natural',
           order: 'asc',
+          'always-on-top': ['id', 'name'],
+          'partition-by-comment': 'Part:**',
         },
       ],
     },

diff --git a/index.ts b/index.ts
@@ -77,24 +77,25 @@ let createConfigWithOptions = (options: {
         callback: 'ignore',
       },
     ],
-    [sortArrayIncludesName]: [
+    [sortObjectsName]: [
       'error',
       {
-        'spread-last': true,
+        'partition-by-comment': false,
+        'always-on-top': [],
       },
     ],
-    [sortObjectsName]: [
+    [sortArrayIncludesName]: [
       'error',
       {
-        'always-on-top': [],
+        'spread-last': true,
       },
     ],
-    [sortNamedImportsName]: ['error'],
     [sortNamedExportsName]: ['error'],
-    [sortObjectTypesName]: ['error'],
+    [sortNamedImportsName]: ['error'],
     [sortMapElementsName]: ['error'],
-    [sortUnionTypesName]: ['error'],
+    [sortObjectTypesName]: ['error'],
     [sortInterfacesName]: ['error'],
+    [sortUnionTypesName]: ['error'],
     [sortExportsName]: ['error'],
     [sortEnumsName]: ['error'],
   }

diff --git a/rules/sort-objects.ts b/rules/sort-objects.ts
@@ -1,18 +1,20 @@
-import type { TSESLint } from '@typescript-eslint/utils'
 import type { TSESTree } from '@typescript-eslint/types'
+import type { TSESLint } from '@typescript-eslint/utils'
 
 import { AST_NODE_TYPES } from '@typescript-eslint/types'
 
-import type { SortingNode } from '../typings'
+import type { PartitionComment, SortingNode } from '../typings'
 
+import { isPartitionComment } from '../utils/is-partition-comment'
+import { getCommentBefore } from '../utils/get-comment-before'
 import { createEslintRule } from '../utils/create-eslint-rule'
 import { toSingleLine } from '../utils/to-single-line'
 import { rangeToDiff } from '../utils/range-to-diff'
 import { SortOrder, SortType } from '../typings'
-import { sortNodes } from '../utils/sort-nodes'
 import { makeFixes } from '../utils/make-fixes'
-import { pairwise } from '../utils/pairwise'
+import { sortNodes } from '../utils/sort-nodes'
 import { complete } from '../utils/complete'
+import { pairwise } from '../utils/pairwise'
 import { groupBy } from '../utils/group-by'
 import { compare } from '../utils/compare'
 
@@ -29,6 +31,7 @@ type SortingNodeWithPosition = SortingNode & {
 
 type Options = [
   Partial<{
+    'partition-by-comment': PartitionComment
     'always-on-top': string[]
     'ignore-case': boolean
     order: SortOrder
@@ -51,6 +54,10 @@ export default createEslintRule<Options, MESSAGE_ID>({
       {
         type: 'object',
         properties: {
+          'partition-by-comment': {
+            type: ['boolean', 'string', 'array'],
+            default: false,
+          },
           type: {
             enum: [
               SortType.alphabetical,
@@ -91,6 +98,7 @@ export default createEslintRule<Options, MESSAGE_ID>({
     ) => {
       if (node.properties.length > 1) {
         let options = complete(context.options.at(0), {
+          'partition-by-comment': false,
           type: SortType.alphabetical,
           'ignore-case': false,
           order: SortOrder.asc,
@@ -116,6 +124,19 @@ export default createEslintRule<Options, MESSAGE_ID>({
                 return accumulator
               }
 
+              let comment = getCommentBefore(prop, source)
+
+              if (
+                options['partition-by-comment'] &&
+                comment &&
+                isPartitionComment(
+                  options['partition-by-comment'],
+                  comment.value,
+                )
+              ) {
+                accumulator.push([])
+              }
+
               let name: string
               let position: Position = Position.ignore
               let dependencies: string[] = []
@@ -230,7 +251,9 @@ export default createEslintRule<Options, MESSAGE_ID>({
                   sortNodes(getGroup(Position.ignore), options),
                 ].flat()
 
-                return makeFixes(fixer, nodes, sortedNodes, source)
+                return makeFixes(fixer, nodes, sortedNodes, source, {
+                  partitionComment: options['partition-by-comment'],
+                })
               }
 
               context.report({