feat(keep-sorted): support destructuring assignment (#11)

Co-authored-by: Stephen Zhou <hi@hyoban.cc>
antfu · May 6, 2024 · c1cb519 · c1cb519
1 parent 24e5ed5
commit c1cb519
Show file tree

Hide file tree

Showing 2 changed files with 80 additions and 1 deletion.
diff --git a/src/commands/keep-sorted.test.ts b/src/commands/keep-sorted.test.ts
@@ -10,7 +10,8 @@ run(
      'apple',
      'bar',
      'foo',
-   ]`,
+   ]`
+  ,
   // Object property
   {
     code: $`
@@ -130,6 +131,7 @@ run(
     errors: ['command-fix'],
   },
   {
+    description: 'Function arguments',
     code: $`
     function foo() {
       // @keep-sorted
@@ -170,6 +172,24 @@ run(
     }`,
     errors: ['command-fix'],
   },
+  {
+    description: 'Export statement without trailing comma',
+    code: $`
+    // @keep-sorted
+    export {
+      foo,
+      bar,
+      apple
+    }`,
+    output: $`
+    // @keep-sorted
+    export {
+      apple,
+      bar,
+      foo,
+    }`,
+    errors: ['command-fix'],
+  },
   {
     description: 'Sort array of objects',
     code: $`
@@ -206,6 +226,52 @@ run(
     ]`,
     errors: ['command-error'],
   },
+  {
+    description: 'Destructuring assignment',
+    code: $`
+    // @keep-sorted
+    const { foo, bar, apple } = obj`,
+    output: $`
+    // @keep-sorted
+    const { apple, bar, foo, } = obj`,
+    errors: ['command-fix'],
+  },
+  {
+    description: 'Destructuring assignment multiple lines',
+    code: $`
+    // @keep-sorted
+    const {
+      foo,
+      bar,
+      apple,
+    } = obj`,
+    output: $`
+    // @keep-sorted
+    const {
+      apple,
+      bar,
+      foo,
+    } = obj`,
+    errors: ['command-fix'],
+  },
+  {
+    description: 'Destructuring assignment multiple lines without trailing comma',
+    code: $`
+    // @keep-sorted
+    const {
+      foo,
+      bar,
+      apple
+    } = obj`,
+    output: $`
+    // @keep-sorted
+    const {
+      apple,
+      bar,
+      foo,
+    } = obj`,
+    errors: ['command-fix'],
+  },
   {
     description: 'Block comment',
     code: $`

diff --git a/src/commands/keep-sorted.ts b/src/commands/keep-sorted.ts
@@ -24,6 +24,7 @@ export const keepSorted: Command = {
 
     const node = ctx.findNodeBelow(
       'ObjectExpression',
+      'ObjectPattern',
       'ArrayExpression',
       'TSInterfaceBody',
       'TSTypeLiteral',
@@ -53,6 +54,18 @@ export const keepSorted: Command = {
         },
       )
     }
+    else if (node.type === 'ObjectPattern') {
+      sort(
+        ctx,
+        node,
+        node.properties,
+        (prop) => {
+          if (prop.type === 'Property')
+            return getString(prop.key)
+          return null
+        },
+      )
+    }
     else if (node.type === 'ArrayExpression') {
       return sort(
         ctx,