Reworked the Fix order

Author: fxOne

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change Log
 
+## 5.1.0
+
+- Reworked the `Fix order` suggestion so that applying it sorts the entire spread-bounded region around the reported key in a single step, instead of only swapping it with its immediate neighbour.
+
 ## 5.0.0
 
 ### Major Changes

lib/rules/sort-keys-shorthand.js

@@ -217,7 +217,6 @@ module.exports = {
           prevName: null,
           numKeys: node.properties.length,
           isSameLine: isSameLine(node),
-          lastNode: node,
         };
       },
 
@@ -239,15 +238,13 @@ module.exports = {
 
         const prevName = stack.prevName;
         const prevIsShorthand = stack.isShorthand;
-        const lastNode = stack.lastNode;
         const numKeys = stack.numKeys;
 
         const data = getPropertyData(node);
         const thisName = data && data.name;
         if (thisName !== null) {
           stack.prevName = thisName;
           stack.isShorthand = data.isShorthand;
-          stack.lastNode = node;
         }
         if (
           prevName === null ||
@@ -287,10 +284,34 @@ module.exports = {
               desc: 'Fix order',
               fix(fixer) {
                 const sourceCode = context.sourceCode;
-                return fixer.replaceTextRange(
-                    [lastNode.range[0], node.range[1]],
-                    `${sourceCode.text.slice(node.range[0], node.range[1])},${sourceCode.text.slice(lastNode.range[0], lastNode.range[1])}`
-                );
+                const siblings = node.parent.properties;
+                const idx = siblings.indexOf(node);
+
+                let start = idx;
+                while (start > 0 && siblings[start - 1].type === 'Property') {
+                  start--;
+                }
+                let end = idx;
+                while (end < siblings.length - 1 && siblings[end + 1].type === 'Property') {
+                  end++;
+                }
+
+                const region = siblings.slice(start, end + 1);
+                const sorted = region.slice().sort(function(a, b) {
+                  const ad = getPropertyData(a);
+                  const bd = getPropertyData(b);
+                  if (ad.name === bd.name && ad.isShorthand === bd.isShorthand) {
+                    return 0;
+                  }
+                  return isValidOrder(ad.name, bd.name, shorthand, ad.isShorthand, bd.isShorthand) ? -1 : 1;
+                });
+
+                return region.map(function(prop, i) {
+                  return fixer.replaceTextRange(
+                    prop.range,
+                    sourceCode.text.slice(sorted[i].range[0], sorted[i].range[1])
+                  );
+                });
               }
             }],
           });

package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-sort-keys-shorthand",
-  "version": "5.0.0",
+  "version": "5.1.0",
   "description": "eslint plugin which support sorting shorthand keys",
   "main": "index.js",
   "scripts": {

tests/lib/rules/sort-keys-shorthand.test.js

@@ -482,6 +482,48 @@ ruleTester.run('sort-keys-shorthand', rule, {
       ]
     },
 
+    // suggestion sorts the full region in one pass (not just an adjacent swap)
+    {
+      code: 'var obj = {a:1, d:2, c:3, b:4, e:5}',
+      options: [],
+      errors: [
+        {
+          message: "Expected object keys to be in ascending order. 'c' should be before 'd'.",
+          suggestions: [{
+            desc: 'Fix order',
+            output: 'var obj = {a:1, b:4, c:3, d:2, e:5}'
+          }]
+        },
+        {
+          message: "Expected object keys to be in ascending order. 'b' should be before 'c'.",
+          suggestions: [{
+            desc: 'Fix order',
+            output: 'var obj = {a:1, b:4, c:3, d:2, e:5}'
+          }]
+        }
+      ]
+    },
+    // region sort stays within spread-bounded groups
+    {
+      code: 'var obj = {d:1, a:2, ...x, f:3, e:4}',
+      options: [],
+      errors: [
+        {
+          message: "Expected object keys to be in ascending order. 'a' should be before 'd'.",
+          suggestions: [{
+            desc: 'Fix order',
+            output: 'var obj = {a:2, d:1, ...x, f:3, e:4}'
+          }]
+        },
+        {
+          message: "Expected object keys to be in ascending order. 'e' should be before 'f'.",
+          suggestions: [{
+            desc: 'Fix order',
+            output: 'var obj = {d:1, a:2, ...x, e:4, f:3}'
+          }]
+        }
+      ]
+    },
     // not ignore properties not separated by spread properties
     {
       code: 'var obj = {...z, c:1, b:1}',
@@ -950,7 +992,7 @@ ruleTester.run('sort-keys-shorthand', rule, {
           message: "Expected object keys to be in descending order. 'a' should be before ''.",
           suggestions: [{
             desc: "Fix order",
-            output: "var obj = {a:'2','':1} // desc"
+            output: "var obj = {a:'2', '':1} // desc"
           }],
         }
       ]
@@ -963,7 +1005,7 @@ ruleTester.run('sort-keys-shorthand', rule, {
           message: "Expected object keys to be in descending order. 'a' should be before ''.",
           suggestions: [{
             desc: "Fix order",
-            output: "var obj = {a:'2',[``]:1} // desc"
+            output: "var obj = {a:'2', [``]:1} // desc"
           }],
         }
       ]
@@ -1030,14 +1072,14 @@ ruleTester.run('sort-keys-shorthand', rule, {
           message: "Expected object keys to be in descending order. '2' should be before '1'.",
           suggestions: [{
             desc: "Fix order",
-            output: "var obj = {2:4,1:1, A:3, '11':2}"
+            output: "var obj = {A:3, 2:4, '11':2, 1:1}"
           }],
         },
         {
           message: "Expected object keys to be in descending order. 'A' should be before '2'.",
           suggestions: [{
             desc: "Fix order",
-            output: "var obj = {1:1, A:3,2:4, '11':2}"
+            output: "var obj = {A:3, 2:4, '11':2, 1:1}"
           }],
         }
       ]
@@ -1132,14 +1174,14 @@ ruleTester.run('sort-keys-shorthand', rule, {
           message: "Expected object keys to be in insensitive descending order. '2' should be before '1'.",
           suggestions: [{
             desc: "Fix order",
-            output: "var obj = {2:4,1:1, A:3, '11':2}"
+            output: "var obj = {A:3, 2:4, '11':2, 1:1}"
           }],
         },
         {
           message: "Expected object keys to be in insensitive descending order. 'A' should be before '2'.",
           suggestions: [{
             desc: "Fix order",
-            output: "var obj = {1:1, A:3,2:4, '11':2}"
+            output: "var obj = {A:3, 2:4, '11':2, 1:1}"
           }],
         }
       ]
@@ -1238,14 +1280,14 @@ ruleTester.run('sort-keys-shorthand', rule, {
           message: "Expected object keys to be in natural descending order. '2' should be before '1'.",
           suggestions: [{
             desc: "Fix order",
-            output: "var obj = {2:4,1:1, A:3, '11':2}"
+            output: "var obj = {A:3, '11':2, 2:4, 1:1}"
           }],
         },
         {
           message: "Expected object keys to be in natural descending order. 'A' should be before '2'.",
           suggestions: [{
             desc: "Fix order",
-            output: "var obj = {1:1, A:3,2:4, '11':2}"
+            output: "var obj = {A:3, '11':2, 2:4, 1:1}"
           }],
         }
       ]