chore: no need to run files when run list filesOnly (#689)

Co-authored-by: Copilot <[email protected]>

Author: 9aoy

packages/core/src/core/listTests.ts

@@ -1,7 +1,12 @@
 import { mkdirSync, writeFileSync } from 'node:fs';
 import { dirname, isAbsolute, join, relative } from 'node:path';
 import { createPool } from '../pool';
-import type { ListCommandOptions, RstestContext, Test } from '../types';
+import type {
+  FormattedError,
+  ListCommandOptions,
+  RstestContext,
+  Test,
+} from '../types';
 import {
   color,
   getSetupFiles,
@@ -12,38 +17,13 @@ import {
 } from '../utils';
 import { createRsbuildServer, prepareRsbuild } from './rsbuild';
 
-export async function listTests(
-  context: RstestContext,
-  { filesOnly, json }: ListCommandOptions,
-): Promise<void> {
-  const { rootPath } = context;
-
-  const testEntries: Record<string, Record<string, string>> = {};
-
-  const globTestSourceEntries = async (
-    name: string,
-  ): Promise<Record<string, string>> => {
-    if (testEntries[name]) {
-      return testEntries[name];
-    }
-    const { include, exclude, includeSource, root } = context.projects.find(
-      (p) => p.environmentName === name,
-    )!.normalizedConfig;
-
-    const entries = await getTestEntries({
-      include,
-      exclude: exclude.patterns,
-      rootPath,
-      projectRoot: root,
-      fileFilters: context.fileFilters || [],
-      includeSource,
-    });
-
-    testEntries[name] = entries;
-
-    return entries;
-  };
-
+const collectTests = async ({
+  context,
+  globTestSourceEntries,
+}: {
+  context: RstestContext;
+  globTestSourceEntries: (name: string) => Promise<Record<string, string>>;
+}) => {
   const setupFiles = Object.fromEntries(
     context.projects.map((project) => {
       const {
@@ -70,7 +50,7 @@ export async function listTests(
     },
     setupFiles,
     rsbuildInstance,
-    rootPath,
+    rootPath: context.rootPath,
   });
 
   const pool = await createPool({
@@ -106,7 +86,90 @@ export async function listTests(
     }),
   );
 
-  const list = returns.flatMap((r) => r.list);
+  return {
+    list: returns.flatMap((r) => r.list),
+    getSourceMap: async (name: string) => {
+      const resource = returns.find((r) => r.assetNames.includes(name));
+      return (await resource?.getSourceMaps([name]))?.[name];
+    },
+    close: async () => {
+      await closeServer();
+      await pool.close();
+    },
+  };
+};
+
+const collectTestFiles = async ({
+  context,
+  globTestSourceEntries,
+}: {
+  context: RstestContext;
+  globTestSourceEntries: (name: string) => Promise<Record<string, string>>;
+}) => {
+  const list: {
+    tests: Test[];
+    testPath: string;
+    project: string;
+    errors?: FormattedError[];
+  }[] = [];
+  for (const project of context.projects) {
+    const files = await globTestSourceEntries(project.environmentName);
+    list.push(
+      ...Object.values(files).map((testPath) => ({
+        testPath,
+        project: project.name,
+        tests: [],
+      })),
+    );
+  }
+  return {
+    close: async () => {},
+    list,
+    getSourceMap: async (_name: string) => null,
+  };
+};
+
+export async function listTests(
+  context: RstestContext,
+  { filesOnly, json }: ListCommandOptions,
+): Promise<void> {
+  const { rootPath } = context;
+
+  const testEntries: Record<string, Record<string, string>> = {};
+
+  const globTestSourceEntries = async (
+    name: string,
+  ): Promise<Record<string, string>> => {
+    if (testEntries[name]) {
+      return testEntries[name];
+    }
+    const { include, exclude, includeSource, root } = context.projects.find(
+      (p) => p.environmentName === name,
+    )!.normalizedConfig;
+
+    const entries = await getTestEntries({
+      include,
+      exclude: exclude.patterns,
+      rootPath,
+      projectRoot: root,
+      fileFilters: context.fileFilters || [],
+      includeSource,
+    });
+
+    testEntries[name] = entries;
+
+    return entries;
+  };
+
+  const { list, close, getSourceMap } = filesOnly
+    ? await collectTestFiles({
+        context,
+        globTestSourceEntries,
+      })
+    : await collectTests({
+        context,
+        globTestSourceEntries,
+      });
 
   const tests: {
     file: string;
@@ -156,9 +219,7 @@ export async function listTests(
           await printError(
             error,
             async (name) => {
-              const resource = returns.find((r) => r.assetNames.includes(name));
-
-              const sourceMap = (await resource?.getSourceMaps([name]))?.[name];
+              const sourceMap = await getSourceMap(name);
               return sourceMap ? JSON.parse(sourceMap) : null;
             },
             rootPath,
@@ -167,9 +228,7 @@ export async function listTests(
       }
     }
 
-    await closeServer();
-
-    await pool.close();
+    await close();
     return;
   }
 
@@ -212,6 +271,5 @@ export async function listTests(
     }
   }
 
-  await closeServer();
-  await pool.close();
+  await close();
 }

website/docs/en/config/test/include.mdx

@@ -4,7 +4,7 @@
 - **Default:** `['**/*.{test,spec}.?(c|m)[jt]s?(x)']`
 - **CLI:** `--include '**/*.test.ts' --include '**/*.spec.ts'`
 
-A list of glob patterns that match your test files.
+A list of glob patterns that match your test files. These patterns will be resolved relative to the [root](/config/test/root) (`process.cwd()` by default).
 
 import { Tab, Tabs } from '@theme';
 
@@ -24,3 +24,43 @@ export default defineConfig({
 ```
   </Tab>
 </Tabs>
+
+You can run `npx rstest list --filesOnly` to see the list of test files that Rstest will include.
+
+```bash
+$ npx rstest list --filesOnly
+
+# the output is shown below:
+a.test.ts
+b.test.ts
+```
+
+## Default behavior
+
+By default, Rstest will include all javascript / typescript files with `.test.` or `.spec.` suffix in the filename.
+
+The following is a visualization of the default pattern:
+
+```bash
+├── __tests__
+│   └── index.test.js # test
+│   └── App.spec.tsx # test
+│   └── helper.ts # not test
+├── src
+│   └── component.ts # not test
+│   └── component.test.tsx # test
+├── bar.spec.jsx # test
+├── index.test.js # test
+└── index.js # not test
+```
+
+It should be noted that if you specify `index.test.ts` as the include pattern, Rstest will only include `index.test.ts` in the root directory. If you want to include `index.test.ts` in all subdirectories, you need to use `**/index.test.ts`.
+
+```diff
+import { defineConfig } from '@rstest/core';
+
+export default defineConfig({
+-  include: ['index.test.ts'],
++  include: ['**/index.test.ts'],
+});
+```

website/docs/zh/config/test/include.mdx

@@ -4,7 +4,7 @@
 - **默认值：** `['**/*.{test,spec}.?(c|m)[jt]s?(x)']`
 - **CLI：** `--include '**/*.test.ts' --include '**/*.spec.ts'`
 
-匹配 glob 规则的文件将被视为测试文件。
+匹配 glob 规则的文件将被视为测试文件。这些规则会相对于 [root](/config/test/root) 解析（默认是 `process.cwd()`）。
 
 import { Tab, Tabs } from '@theme';
 
@@ -24,3 +24,43 @@ export default defineConfig({
 ```
   </Tab>
 </Tabs>
+
+你可以运行 `npx rstest list --filesOnly` 来查看 Rstest 会包含的测试文件列表。
+
+```bash
+$ npx rstest list --filesOnly
+
+# the output is shown below:
+a.test.ts
+b.test.ts
+```
+
+## 默认行为
+
+默认情况下，Rstest 会匹配当前项目下所有文件名带有 `.test.` 或 `.spec.` 中缀的 JavaScript / TypeScript 文件。
+
+下面是默认匹配模式的示例：
+
+```bash
+├── __tests__
+│   └── index.test.js # test
+│   └── App.spec.tsx # test
+│   └── helper.ts # not test
+├── src
+│   └── component.ts # not test
+│   └── component.test.tsx # test
+├── bar.spec.jsx # test
+├── index.test.js # test
+└── index.js # not test
+```
+
+需要注意的是，如果你将 `include` 配置为 `index.test.ts`，Rstest 只会匹配根目录下的 `index.test.ts`。如果要匹配所有子目录中的 `index.test.ts`，需要使用 `**/index.test.ts`。
+
+```diff
+import { defineConfig } from '@rstest/core';
+
+export default defineConfig({
+-  include: ['index.test.ts'],
++  include: ['**/index.test.ts'],
+});
+```