fix: use name to sort method property (#497)

this fix potential wrong result due to comments.
gajus · Aug 31, 2021 · 4265b27 · 4265b27
1 parent b038886
commit 4265b27
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 3 deletions.
diff --git a/src/rules/sortKeys.js b/src/rules/sortKeys.js
@@ -57,7 +57,7 @@ const generateOrderedList = (context, sort, properties) => {
       });
       const text = source.getText().slice(startIndex, beforePunctuator.range[1]);
 
-      return [property, text];
+      return [property, name, text];
     }
 
     const colonToken = source.getTokenBefore(property.value, {
@@ -123,8 +123,8 @@ const generateOrderedList = (context, sort, properties) => {
         });
     }
     orderedList.push(...itemGroup.map((item) => {
-      if (item.length === 2) {
-        return item[1];
+      if (item.length === 3) {
+        return item[2];
       }
 
       return item[2] + ':' + item[3];

diff --git a/tests/rules/assertions/sortKeys.js b/tests/rules/assertions/sortKeys.js
@@ -557,6 +557,29 @@ export default {
         }
       `,
     },
+    {
+      code: `
+        type FooType = {
+          /* preserves block comment before a */
+          a: number | string | boolean,
+          /* preserves block comment before c */
+          c: number,
+          /* preserves block comment before b */
+          b(param: string): number,
+        }
+      `,
+      errors: [{message: 'Expected type annotations to be in ascending order. "b" should be before "c".'}],
+      output: `
+        type FooType = {
+          /* preserves block comment before a */
+          a: number | string | boolean,
+          /* preserves block comment before b */
+          b(param: string): number,
+          /* preserves block comment before c */
+          c: number,
+        }
+      `,
+    },
 
     // https://github.com/gajus/eslint-plugin-flowtype/issues/493
     {