fix: support nested object deconstructuring with type annotation (#4548)

typescript-eslint · Feb 13, 2022 · 4da9278 · 4da9278
1 parent 5b7d8df
commit 4da9278
Show file tree

Hide file tree

Showing 2 changed files with 82 additions and 1 deletion.
diff --git a/packages/eslint-plugin/src/rules/typedef.ts b/packages/eslint-plugin/src/rules/typedef.ts
@@ -149,6 +149,25 @@ export default util.createRule<[Options], MessageIds>({
       );
     }
 
+    function isAncestorHasTypeAnnotation(
+      node: TSESTree.ObjectPattern,
+    ): boolean {
+      let ancestor = node.parent;
+
+      while (ancestor) {
+        if (
+          ancestor.type === AST_NODE_TYPES.ObjectPattern &&
+          ancestor.typeAnnotation
+        ) {
+          return true;
+        }
+
+        ancestor = ancestor.parent;
+      }
+
+      return false;
+    }
+
     return {
       ...(arrayDestructuring && {
         ArrayPattern(node): void {
@@ -193,7 +212,11 @@ export default util.createRule<[Options], MessageIds>({
       }),
       ...(objectDestructuring && {
         ObjectPattern(node): void {
-          if (!node.typeAnnotation && !isForOfStatementContext(node)) {
+          if (
+            !node.typeAnnotation &&
+            !isForOfStatementContext(node) &&
+            !isAncestorHasTypeAnnotation(node)
+          ) {
             report(node);
           }
         },

diff --git a/packages/eslint-plugin/tests/rules/typedef.test.ts b/packages/eslint-plugin/tests/rules/typedef.test.ts
@@ -201,6 +201,26 @@ ruleTester.run('typedef', rule, {
         },
       ],
     },
+    {
+      code: `
+        const {
+          id,
+          details: {
+            name: {
+              first,
+              middle,
+              last,
+              forTest: { moreNested },
+            },
+          },
+        }: User = getUser();
+      `,
+      options: [
+        {
+          objectDestructuring: true,
+        },
+      ],
+    },
     // Function parameters
     'function receivesNumber(a: number): void {}',
     'function receivesStrings(a: string, b: string): void {}',
@@ -516,6 +536,44 @@ class ClassName {
         },
       ],
     },
+    {
+      code: `
+        const {
+          id,
+          details: {
+            name: {
+              first,
+              middle,
+              last,
+              forTest: { moreNested },
+            },
+          },
+        } = getUser();
+      `,
+      errors: [
+        {
+          data: { name: 'first' },
+          messageId: 'expectedTypedef',
+        },
+        {
+          data: { name: 'middle' },
+          messageId: 'expectedTypedef',
+        },
+        {
+          data: { name: 'last' },
+          messageId: 'expectedTypedef',
+        },
+        {
+          data: { name: 'moreNested' },
+          messageId: 'expectedTypedef',
+        },
+      ],
+      options: [
+        {
+          objectDestructuring: true,
+        },
+      ],
+    },
     // Arrow parameters
     {
       code: 'const receivesNumber = (a): void => {};',