fix(sort-decorators): keep jsdoc blocks in place

azat-io · Nov 30, 2024 · 54dfdd9 · 54dfdd9
1 parent 9800e26
commit 54dfdd9
Show file tree

Hide file tree

Showing 21 changed files with 336 additions and 106 deletions.
diff --git a/rules/sort-array-includes.ts b/rules/sort-array-includes.ts
@@ -161,7 +161,10 @@ export let sortArray = <MessageIds extends string>(
         (options.partitionByComment &&
           hasPartitionComment(
             options.partitionByComment,
-            getCommentsBefore(element, sourceCode),
+            getCommentsBefore({
+              node: element,
+              sourceCode,
+            }),
           )) ||
         (options.partitionByNewLine &&
           lastSortingNode &&

diff --git a/rules/sort-classes.ts b/rules/sort-classes.ts
@@ -543,15 +543,20 @@ export default createEslintRule<SortClassesOptions, MESSAGE_ID>({
             name,
           }
 
-          let comments = getCommentsBefore(member, sourceCode)
           let lastMember = accumulator.at(-1)?.at(-1)
 
           if (
             (options.partitionByNewLine &&
               lastMember &&
               getLinesBetween(sourceCode, lastMember, sortingNode)) ||
             (options.partitionByComment &&
-              hasPartitionComment(options.partitionByComment, comments))
+              hasPartitionComment(
+                options.partitionByComment,
+                getCommentsBefore({
+                  node: member,
+                  sourceCode,
+                }),
+              ))
           ) {
             accumulator.push([])
           }

diff --git a/rules/sort-decorators.ts b/rules/sort-decorators.ts
@@ -216,7 +216,10 @@ let sortDecorators = (
         options.partitionByComment &&
         hasPartitionComment(
           options.partitionByComment,
-          getCommentsBefore(decorator, sourceCode),
+          getCommentsBefore({
+            node: decorator,
+            sourceCode,
+          }),
         )
       ) {
         accumulator.push([])
@@ -270,6 +273,7 @@ let sortDecorators = (
       fix: fixer =>
         makeFixes({
           sortedNodes: sortedNodesExcludingEslintDisabled,
+          ignoreFirstNodeHighestBlockComment: true,
           sourceCode,
           options,
           fixer,

diff --git a/rules/sort-enums.ts b/rules/sort-enums.ts
@@ -151,7 +151,10 @@ export default createEslintRule<Options, MESSAGE_ID>({
             (options.partitionByComment &&
               hasPartitionComment(
                 options.partitionByComment,
-                getCommentsBefore(member, sourceCode),
+                getCommentsBefore({
+                  node: member,
+                  sourceCode,
+                }),
               )) ||
             (options.partitionByNewLine &&
               lastSortingNode &&

diff --git a/rules/sort-exports.ts b/rules/sort-exports.ts
@@ -91,7 +91,10 @@ export default createEslintRule<Options, MESSAGE_ID>({
         (partitionComment &&
           hasPartitionComment(
             partitionComment,
-            getCommentsBefore(node, sourceCode),
+            getCommentsBefore({
+              sourceCode,
+              node,
+            }),
           )) ||
         (options.partitionByNewLine &&
           lastNode &&

diff --git a/rules/sort-imports.ts b/rules/sort-imports.ts
@@ -456,7 +456,10 @@ export default createEslintRule<Options<string[]>, MESSAGE_ID>({
             (options.partitionByComment &&
               hasPartitionComment(
                 options.partitionByComment,
-                getCommentsBefore(sortingNode.node, sourceCode),
+                getCommentsBefore({
+                  node: sortingNode.node,
+                  sourceCode,
+                }),
               )) ||
             (options.partitionByNewLine &&
               lastSortingNode &&

diff --git a/rules/sort-interfaces.ts b/rules/sort-interfaces.ts
@@ -178,7 +178,10 @@ export default createEslintRule<Options<string[]>, MESSAGE_ID>({
               (options.partitionByComment &&
                 hasPartitionComment(
                   options.partitionByComment,
-                  getCommentsBefore(element, sourceCode),
+                  getCommentsBefore({
+                    node: element,
+                    sourceCode,
+                  }),
                 )) ||
               (options.partitionByNewLine &&
                 lastElement &&

diff --git a/rules/sort-intersection-types.ts b/rules/sort-intersection-types.ts
@@ -187,7 +187,11 @@ export default createEslintRule<Options, MESSAGE_ID>({
             (options.partitionByComment &&
               hasPartitionComment(
                 options.partitionByComment,
-                getCommentsBefore(type, sourceCode, '&'),
+                getCommentsBefore({
+                  tokenValueToIgnoreBefore: '&',
+                  node: type,
+                  sourceCode,
+                }),
               )) ||
             (options.partitionByNewLine &&
               lastSortingNode &&

diff --git a/rules/sort-maps.ts b/rules/sort-maps.ts
@@ -123,7 +123,10 @@ export default createEslintRule<Options, MESSAGE_ID>({
             (options.partitionByComment &&
               hasPartitionComment(
                 options.partitionByComment,
-                getCommentsBefore(element, sourceCode),
+                getCommentsBefore({
+                  node: element,
+                  sourceCode,
+                }),
               )) ||
             (options.partitionByNewLine &&
               lastSortingNode &&

diff --git a/rules/sort-modules.ts b/rules/sort-modules.ts
@@ -377,14 +377,19 @@ let analyzeModule = ({
       node,
       name,
     }
-    let comments = getCommentsBefore(node, sourceCode)
     let lastSortingNode = formattedNodes.at(-1)?.at(-1)
     if (
       (options.partitionByNewLine &&
         lastSortingNode &&
         getLinesBetween(sourceCode, lastSortingNode, sortingNode)) ||
       (options.partitionByComment &&
-        hasPartitionComment(options.partitionByComment, comments))
+        hasPartitionComment(
+          options.partitionByComment,
+          getCommentsBefore({
+            sourceCode,
+            node,
+          }),
+        ))
     ) {
       formattedNodes.push([])
     }

diff --git a/rules/sort-named-exports.ts b/rules/sort-named-exports.ts
@@ -100,7 +100,10 @@ export default createEslintRule<Options, MESSAGE_ID>({
           (options.partitionByComment &&
             hasPartitionComment(
               options.partitionByComment,
-              getCommentsBefore(specifier, sourceCode),
+              getCommentsBefore({
+                node: specifier,
+                sourceCode,
+              }),
             )) ||
           (options.partitionByNewLine &&
             lastSortingNode &&

diff --git a/rules/sort-named-imports.ts b/rules/sort-named-imports.ts
@@ -109,7 +109,10 @@ export default createEslintRule<Options, MESSAGE_ID>({
           (options.partitionByComment &&
             hasPartitionComment(
               options.partitionByComment,
-              getCommentsBefore(specifier, sourceCode),
+              getCommentsBefore({
+                node: specifier,
+                sourceCode,
+              }),
             )) ||
           (options.partitionByNewLine &&
             lastSortingNode &&

diff --git a/rules/sort-object-types.ts b/rules/sort-object-types.ts
@@ -167,7 +167,10 @@ export default createEslintRule<Options<string[]>, MESSAGE_ID>({
               (options.partitionByComment &&
                 hasPartitionComment(
                   options.partitionByComment,
-                  getCommentsBefore(member, sourceCode),
+                  getCommentsBefore({
+                    node: member,
+                    sourceCode,
+                  }),
                 )) ||
               (options.partitionByNewLine &&
                 lastSortingNode &&

diff --git a/rules/sort-objects.ts b/rules/sort-objects.ts
@@ -299,7 +299,6 @@ export default createEslintRule<Options, MESSAGE_ID>({
               return accumulator
             }
 
-            let comments = getCommentsBefore(property, sourceCode)
             let lastProperty = accumulator.at(-1)?.at(-1)
 
             let name: string
@@ -353,7 +352,13 @@ export default createEslintRule<Options, MESSAGE_ID>({
                   propertySortingNode,
                 )) ||
               (options.partitionByComment &&
-                hasPartitionComment(options.partitionByComment, comments))
+                hasPartitionComment(
+                  options.partitionByComment,
+                  getCommentsBefore({
+                    node: property,
+                    sourceCode,
+                  }),
+                ))
             ) {
               accumulator.push([])
             }

diff --git a/rules/sort-union-types.ts b/rules/sort-union-types.ts
@@ -187,7 +187,11 @@ export default createEslintRule<Options, MESSAGE_ID>({
             (options.partitionByComment &&
               hasPartitionComment(
                 options.partitionByComment,
-                getCommentsBefore(type, sourceCode, '|'),
+                getCommentsBefore({
+                  tokenValueToIgnoreBefore: '|',
+                  node: type,
+                  sourceCode,
+                }),
               )) ||
             (options.partitionByNewLine &&
               lastSortingNode &&

diff --git a/rules/sort-variable-declarations.ts b/rules/sort-variable-declarations.ts
@@ -197,7 +197,10 @@ export default createEslintRule<Options, MESSAGE_ID>({
             (options.partitionByComment &&
               hasPartitionComment(
                 options.partitionByComment,
-                getCommentsBefore(declaration, sourceCode),
+                getCommentsBefore({
+                  node: declaration,
+                  sourceCode,
+                }),
               )) ||
             (options.partitionByNewLine &&
               lastSortingNode &&