fix comments position

Author: tanhauhau

lib/rules/sort-styles.js

@@ -46,6 +46,14 @@ module.exports = (context) => {
     });
   }
 
+  function getActualRange(node) {
+    const range = [].concat(node.range);
+    range[0] = sourceCode
+      .getCommentsBefore(node)
+      .reduce((start, comment) => Math.min(start, comment.range[0]), range[0]);
+    return range;
+  }
+
   function report(array, type, node, prev, current) {
     const currentName = getStylePropertyIdentifier(current);
     const prevName = getStylePropertyIdentifier(prev);
@@ -58,7 +66,11 @@ module.exports = (context) => {
         return array
           .map((item, i) => {
             if (item !== sortedArray[i]) {
-              return fixer.replaceText(item, sourceCode.getText(sortedArray[i]));
+              const actualRange = getActualRange(sortedArray[i]);
+              return fixer.replaceTextRange(
+                getActualRange(item),
+                sourceCode.text.slice(actualRange[0], actualRange[1])
+              );
             }
             return null;
           })

tests/lib/rules/sort-styles.js

@@ -329,41 +329,117 @@ const tests = {
         const styles = StyleSheet.create({
           a: {
             d: 4,
-            // comments
+            // comments 1
             c: 3,
             a: 1,
             b: 2,
           },
           d: {},
           c: {},
-          // comments
+          // comments 2
           b: {
             a: 1,
             b: 2,
           },
+          // comments 3
         })
       `,
       output: `
         const styles = StyleSheet.create({
           a: {
             a: 1,
             b: 2,
-            // comments
+            // comments 1
             c: 3,
             d: 4,
           },
-          // comments
+          // comments 2
           b: {
             a: 1,
             b: 2,
           },
           c: {},
           d: {},
+          // comments 3
         })
       `,
       errors: [
-        { message: "Expected style properties to be in ascending order. 'c' should be before 'd'." },
-        { message: "Expected class names to be in ascending order. 'c' should be before 'd'." },
+        {
+          message:
+            "Expected style properties to be in ascending order. 'c' should be before 'd'.",
+        },
+        {
+          message:
+            "Expected class names to be in ascending order. 'c' should be before 'd'.",
+        },
+      ],
+    },
+    {
+      code: `
+        const styles = StyleSheet.create({
+          a: {
+            d: 4,
+            // singleline 1
+            // singleline 2
+            // singleline 3
+            c: 3,
+            a: 1,
+            b: 2,
+          },
+          d: {},
+          c: {},
+          /*
+          multiline 1
+          */
+          /*
+          multiline 2
+          */
+          /*
+          multiline 3
+          */
+          b: {
+            a: 1,
+            b: 2,
+          },
+        })
+      `,
+      output: `
+        const styles = StyleSheet.create({
+          a: {
+            a: 1,
+            b: 2,
+            // singleline 1
+            // singleline 2
+            // singleline 3
+            c: 3,
+            d: 4,
+          },
+          /*
+          multiline 1
+          */
+          /*
+          multiline 2
+          */
+          /*
+          multiline 3
+          */
+          b: {
+            a: 1,
+            b: 2,
+          },
+          c: {},
+          d: {},
+        })
+      `,
+      errors: [
+        {
+          message:
+            "Expected style properties to be in ascending order. 'c' should be before 'd'.",
+        },
+        {
+          message:
+            "Expected class names to be in ascending order. 'c' should be before 'd'.",
+        },
       ],
     },
   ],