feat: hide the task in reported tasks

docs/advanced/reporters.md

@@ -93,12 +93,7 @@ class MyReporter implements Reporter {
 
 ```ts
 declare class TestCase {
-  readonly type = 'test' | 'custom'
-  /**
-   * Task instance.
-   * @experimental Public task API is experimental and does not follow semver.
-   */
-  readonly task: RunnerTestCase | RunnerCustomCase
+  readonly type = 'test'
   /**
    * The project associated with the test.
    */
@@ -236,11 +231,6 @@ export interface TestDiagnostic {
 ```ts
 declare class TestSuite {
   readonly type = 'suite'
-  /**
-   * Task instance.
-   * @experimental Public task API is experimental and does not follow semver.
-   */
-  readonly task: RunnerTestSuite
   /**
    * The project associated with the test.
    */
@@ -286,11 +276,6 @@ declare class TestSuite {
 ```ts
 declare class TestModule extends SuiteImplementation {
   readonly type = 'module'
-  /**
-   * Task instance.
-   * @experimental Public task API is experimental and does not follow semver.
-   */
-  readonly task: RunnerTestFile
   /**
    * Collection of suites and tests that are part of this module.
    */

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

@@ -11,7 +11,7 @@ import type { TestProject } from '../project'
 class ReportedTaskImplementation {
   /**
    * Task instance.
-   * @experimental Public runner task API is experimental and does not follow semver.
+   * @internal
    */
   public readonly task: RunnerTask
 
@@ -32,6 +32,7 @@ class ReportedTaskImplementation {
    */
   public readonly location: { line: number; column: number } | undefined
 
+  /** @internal */
   protected constructor(
     task: RunnerTask,
     project: TestProject,
@@ -44,6 +45,7 @@ class ReportedTaskImplementation {
 
   /**
    * Creates a new reported task instance and stores it in the project's state for future use.
+   * @internal
    */
   static register(task: RunnerTask, project: TestProject) {
     const state = new this(task, project) as TestCase | TestSuite | TestModule
@@ -55,6 +57,7 @@ class ReportedTaskImplementation {
 export class TestCase extends ReportedTaskImplementation {
   #fullName: string | undefined
 
+  /** @internal */
   declare public readonly task: RunnerTestCase
   public readonly type = 'test'
 
@@ -78,6 +81,7 @@ export class TestCase extends ReportedTaskImplementation {
    */
   public readonly parent: TestSuite | TestModule
 
+  /** @internal */
   protected constructor(task: RunnerTestCase, project: TestProject) {
     super(task, project)
 
@@ -294,13 +298,15 @@ class TestCollection {
 export type { TestCollection }
 
 abstract class SuiteImplementation extends ReportedTaskImplementation {
+  /** @internal */
   declare public readonly task: RunnerTestSuite | RunnerTestFile
 
   /**
    * Collection of suites and tests that are part of this suite.
    */
   public readonly children: TestCollection
 
+  /** @internal */
   protected constructor(task: RunnerTestSuite | RunnerTestFile, project: TestProject) {
     super(task, project)
     this.children = new TestCollection(task, project)
@@ -310,6 +316,7 @@ abstract class SuiteImplementation extends ReportedTaskImplementation {
 export class TestSuite extends SuiteImplementation {
   #fullName: string | undefined
 
+  /** @internal */
   declare public readonly task: RunnerTestSuite
   public readonly type = 'suite'
 
@@ -333,6 +340,7 @@ export class TestSuite extends SuiteImplementation {
    */
   public readonly options: TaskOptions
 
+  /** @internal */
   protected constructor(task: RunnerTestSuite, project: TestProject) {
     super(task, project)
 
@@ -365,6 +373,7 @@ export class TestSuite extends SuiteImplementation {
 }
 
 export class TestModule extends SuiteImplementation {
+  /** @internal */
   declare public readonly task: RunnerTestFile
   declare public readonly location: undefined
   public readonly type = 'module'
@@ -376,6 +385,7 @@ export class TestModule extends SuiteImplementation {
    */
   public readonly moduleId: string
 
+  /** @internal */
   protected constructor(task: RunnerTestFile, project: TestProject) {
     super(task, project)
     this.moduleId = task.filepath