Skip to content

Commit 3be0986

Browse files
authored
feat(api): add relativeModuleId to TestModule (#8505)
1 parent ed7e3ad commit 3be0986

File tree

2 files changed

+16
-0
lines changed

2 files changed

+16
-0
lines changed

docs/advanced/api/test-module.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,16 @@ This is usually an absolute unix file path (even on Windows). It can be a virtua
2424
'C:\\Users\\Documents\\project\\example.test.ts' //
2525
```
2626

27+
## relativeModuleId
28+
29+
Module id relative to the project. This is the same as `task.name` in the deprecated API.
30+
31+
```ts
32+
'project/example.test.ts' //
33+
'example.test.ts' //
34+
'project\\example.test.ts' //
35+
```
36+
2737
## state
2838

2939
```ts

packages/vitest/src/node/reporters/reported-tasks.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -437,10 +437,16 @@ export class TestModule extends SuiteImplementation {
437437
*/
438438
public readonly moduleId: string
439439

440+
/**
441+
* Module id relative to the project. This is the same as `task.name`.
442+
*/
443+
public readonly relativeModuleId: string
444+
440445
/** @internal */
441446
protected constructor(task: RunnerTestFile, project: TestProject) {
442447
super(task, project)
443448
this.moduleId = task.filepath
449+
this.relativeModuleId = task.name
444450
}
445451

446452
/**

0 commit comments

Comments
 (0)