[node:test] add setup and watch for RunOptions

koh110 · koh110 · commit 31034ca61935 · 2023-07-15T23:37:47.000+09:00
diff --git a/types/node/test.d.ts b/types/node/test.d.ts
@@ -76,10 +76,11 @@
  *
  * If any tests fail, the process exit code is set to `1`.
  * @since v18.0.0, v16.17.0
- * @see [source](https://github.com/nodejs/node/blob/v20.2.0/lib/test.js)
+ * @see [source](https://github.com/nodejs/node/blob/v20.4.0/lib/test.js)
  */
 declare module 'node:test' {
     import { Readable } from 'node:stream';
+    import { AsyncResource } from 'node:async_hooks';
     /**
      * ```js
      * import { tap } from 'node:test/reporters';
@@ -295,6 +296,23 @@ declare module 'node:test' {
          * For each test that is executed, any corresponding test hooks, such as `beforeEach()`, are also run.
          */
         testNamePatterns?: string | RegExp | string[] | RegExp[];
+        /**
+         * A function that accepts the TestsStream instance and can be used to setup listeners before any tests are run.
+         */
+        setup?: (root: Test) => void | Promise<void>;
+        /**
+         * Whether to run in watch mode or not. Default: false.
+         */
+        watch?: boolean;
+    }
+    class Test extends AsyncResource {
+        concurrency: number;
+        nesting: number;
+        only: boolean;
+        reporter: TestsStream;
+        runOnlySubtests: boolean;
+        testNumber: number;
+        timeout: number | null;
     }
     /**
      * A successful call to `run()` method will return a new `TestsStream` object, streaming a series of events representing the execution of the tests.`TestsStream` will emit events, in the
diff --git a/types/node/test/test.ts b/types/node/test/test.ts
@@ -20,6 +20,8 @@ run({
     timeout: 100,
     inspectPort: () => 8081,
     testNamePatterns: ['executed'],
+    setup: (root) => {},
+    watch: true
 });
 
 // TestsStream should be a NodeJS.ReadableStream
diff --git a/types/node/ts4.8/test.d.ts b/types/node/ts4.8/test.d.ts
@@ -80,6 +80,7 @@
  */
 declare module 'node:test' {
     import { Readable } from 'node:stream';
+    import { AsyncResource } from 'node:async_hooks';
     /**
      * ```js
      * import { tap } from 'node:test/reporters';
@@ -295,6 +296,23 @@ declare module 'node:test' {
          * For each test that is executed, any corresponding test hooks, such as `beforeEach()`, are also run.
          */
         testNamePatterns?: string | RegExp | string[] | RegExp[];
+        /**
+         * A function that accepts the TestsStream instance and can be used to setup listeners before any tests are run.
+         */
+        setup?: (root: unknown) => void | Promise<void>;
+        /**
+         * Whether to run in watch mode or not. Default: false.
+         */
+        watch?: boolean;
+    }
+    class Test extends AsyncResource {
+        concurrency: number;
+        nesting: number;
+        only: boolean;
+        reporter: TestsStream;
+        runOnlySubtests: boolean;
+        testNumber: number;
+        timeout: number | null;
     }
     /**
      * A successful call to `run()` method will return a new `TestsStream` object, streaming a series of events representing the execution of the tests.`TestsStream` will emit events, in the
diff --git a/types/node/ts4.8/test/test.ts b/types/node/ts4.8/test/test.ts
@@ -20,6 +20,8 @@ run({
     timeout: 100,
     inspectPort: () => 8081,
     testNamePatterns: ['executed'],
+    setup: (root) => {},
+    watch: true
 });
 
 // TestsStream should be a NodeJS.ReadableStream
diff --git a/types/node/v18/test.d.ts b/types/node/v18/test.d.ts
@@ -3,6 +3,7 @@
  * @see [source](https://github.com/nodejs/node/blob/v18.x/lib/test.js)
  */
 declare module 'node:test' {
+    import { AsyncResource } from 'node:async_hooks';
     /**
      * Programmatically start the test runner.
      * @since v18.9.0
@@ -178,6 +179,19 @@ declare module 'node:test' {
          * incremented from the primary's `process.debugPort`.
          */
         inspectPort?: number | (() => number) | undefined;
+        /**
+         * A function that accepts the TestsStream instance and can be used to setup listeners before any tests are run.
+         */
+        setup?: (root: Test) => void | Promise<void>;
+    }
+    class Test extends AsyncResource {
+        concurrency: number;
+        nesting: number;
+        only: boolean;
+        reporter: TestsStream;
+        runOnlySubtests: boolean;
+        testNumber: number;
+        timeout: number | null;
     }
 
     /**
diff --git a/types/node/v18/test/test.ts b/types/node/v18/test/test.ts
@@ -18,6 +18,7 @@ run({
     signal: new AbortController().signal,
     timeout: 100,
     inspectPort: () => 8081,
+    setup: (root) => {},
 });
 
 // TestsStream should be a NodeJS.ReadableStream
