feat: filter file based on workspace's root (#521)

Author: 9aoy

e2e/projects/filter.test.ts

@@ -0,0 +1,28 @@
+import { dirname, join } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { describe, expect, it } from '@rstest/core';
+import { runRstestCli } from '../scripts';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+describe('test projects filter', () => {
+  it('should run test success with test file filter', async () => {
+    const { cli, expectExecSuccess } = await runRstestCli({
+      command: 'rstest',
+      args: ['run', 'client', '--globals'],
+      options: {
+        nodeOptions: {
+          cwd: join(__dirname, 'fixtures'),
+        },
+      },
+    });
+
+    await expectExecSuccess();
+    const logs = cli.stdout.split('\n').filter(Boolean);
+
+    // test log print
+    expect(logs.find((log) => log.includes('node/test/index'))).toBeFalsy();
+    expect(logs.find((log) => log.includes('client/test/index'))).toBeTruthy();
+  });
+});

packages/core/src/core/listTests.ts

@@ -33,7 +33,8 @@ export async function listTests(
     const entries = await getTestEntries({
       include,
       exclude,
-      root,
+      rootPath,
+      projectRoot: root,
       fileFilters: context.fileFilters || [],
       includeSource,
     });

packages/core/src/core/runTests.ts

@@ -32,7 +32,8 @@ export async function runTests(context: Rstest): Promise<void> {
       include,
       exclude,
       includeSource,
-      root,
+      rootPath,
+      projectRoot: root,
       fileFilters: context.fileFilters || [],
     });
 

packages/core/src/utils/testFiles.ts

@@ -48,20 +48,22 @@ export const formatTestEntryName = (name: string): string =>
 export const getTestEntries = async ({
   include,
   exclude,
-  root,
+  rootPath,
+  projectRoot,
   fileFilters,
   includeSource,
 }: {
+  rootPath: string;
   include: string[];
   exclude: string[];
   includeSource: string[];
   fileFilters: string[];
-  root: string;
+  projectRoot: string;
 }): Promise<{
   [name: string]: string;
 }> => {
   const testFiles = await glob(include, {
-    cwd: root,
+    cwd: projectRoot,
     absolute: true,
     ignore: exclude,
     dot: true,
@@ -70,7 +72,7 @@ export const getTestEntries = async ({
 
   if (includeSource?.length) {
     const sourceFiles = await glob(includeSource, {
-      cwd: root,
+      cwd: projectRoot,
       absolute: true,
       ignore: exclude,
       dot: true,
@@ -92,8 +94,8 @@ export const getTestEntries = async ({
   }
 
   return Object.fromEntries(
-    filterFiles(testFiles, fileFilters, root).map((entry) => {
-      const relativePath = pathe.relative(root, entry);
+    filterFiles(testFiles, fileFilters, rootPath).map((entry) => {
+      const relativePath = pathe.relative(rootPath, entry);
       return [formatTestEntryName(relativePath), entry];
     }),
   );

website/docs/en/guide/basic/test-filter.mdx

@@ -34,6 +34,23 @@ You can also specify multiple test files or glob patterns:
 rstest test/foo.test.ts test/bar.test.ts
 ```
 
+### Filter by file path
+
+This method also applies to filtering by file path.
+
+When filtering by file path, it can be either an absolute path or a relative path based on the current working directory (also called the project root directory or workspace root directory)
+
+```bash
+# Filtering by absolute path
+rstest /Users/userName/Desktop/projects/rstest/packages/core/tests/index.test.ts
+
+# Filtering by relative path
+rstest packages/core/tests/index.test.ts
+
+# Filtering by project directory
+rstest packages/core
+```
+
 ### include/exclude
 
 When you filter files directly with `rstest **/*.test.ts`, rstest will further filter files based on the [include](/config/test/include) and [exclude](/config/test/exclude) configuration.

website/docs/zh/guide/basic/test-filter.mdx

@@ -34,6 +34,23 @@ rstest foo
 rstest test/foo.test.ts test/bar.test.ts
 ```
 
+### 根据文件路径过滤
+
+此种方式也适用于根据文件路径过滤。
+
+当你根据文件路径过滤，它可以是一个绝对路径或者基于当前工作目录（也称为项目根目录或 workspace 根目录）的相对路径。
+
+```bash
+# 根据绝对路径过滤
+rstest /Users/userName/Desktop/projects/rstest/packages/core/tests/index.test.ts
+
+# 根据相对路径过滤
+rstest packages/core/tests/index.test.ts
+
+# 根据 project 目录过滤
+rstest packages/core
+```
+
 ### include/exclude
 
 当你直接通过 `rstest **/*.test.ts` 过滤文件时，Rstest 会在 [include](/config/test/include) 和 [exclude](/config/test/exclude) 配置的基础上进一步筛选文件。