Improve the type definition of path.isX (#15661)

* improve * fix * improve * review
babel · Jul 31, 2023 · 078d59a · 078d59a
1 parent 74b5ac2
commit 078d59a
Show file tree

Hide file tree

Showing 8 changed files with 848 additions and 650 deletions.
diff --git a/packages/babel-traverse/scripts/generators/asserts.js b/packages/babel-traverse/scripts/generators/asserts.js
@@ -8,13 +8,20 @@ export default function generateAsserts() {
 import type * as t from "@babel/types";
 import type NodePath from "../index";
 
+type Opts<Obj> = Partial<{
+  [Prop in keyof Obj]: Obj[Prop] extends t.Node
+    ? t.Node
+    : Obj[Prop] extends t.Node[]
+    ? t.Node[]
+    : Obj[Prop];
+}>;
 
 export interface NodePathAssertions {`;
 
   for (const type of [...t.TYPES].sort()) {
     output += `
   assert${type}(
-    opts?: object,
+    opts?: Opts<t.${type}>,
   ): asserts this is NodePath<t.${type}>;`;
   }
 

diff --git a/packages/babel-traverse/scripts/generators/validators.js b/packages/babel-traverse/scripts/generators/validators.js
@@ -9,18 +9,27 @@ import type * as t from "@babel/types";
 import type NodePath from "../index";
 import type { VirtualTypeNodePathValidators } from "../lib/virtual-types-validator";
 
+type Opts<Obj> = Partial<{
+  [Prop in keyof Obj]: Obj[Prop] extends t.Node
+    ? t.Node
+    : Obj[Prop] extends t.Node[]
+    ? t.Node[]
+    : Obj[Prop];
+}>;
+
 interface BaseNodePathValidators {
 `;
 
   for (const type of [...t.TYPES].sort()) {
-    output += `is${type}<T extends t.Node>(this: NodePath<T>, opts?: object): this is NodePath<T & t.${type}>;`;
+    output += `is${type}<T extends t.Node>(this: NodePath<T>, opts?: Opts<t.${type}>): this is NodePath<T & t.${type}>;`;
   }
 
   output += `
 }
 
 export interface NodePathValidators
-  extends BaseNodePathValidators, VirtualTypeNodePathValidators {}
+  extends Omit<BaseNodePathValidators, keyof VirtualTypeNodePathValidators>,
+    VirtualTypeNodePathValidators {}
 `;
 
   return output;