diff --git a/packages/runner/src/types/tasks.ts b/packages/runner/src/types/tasks.ts index eb3e34d8f558..5cf376b69a06 100644 --- a/packages/runner/src/types/tasks.ts +++ b/packages/runner/src/types/tasks.ts @@ -583,8 +583,14 @@ export interface RuntimeContext { currentSuite: SuiteCollector | null } +/** + * User's custom test context. + */ export interface TestContext {} +/** + * Context that's always available in the test function. + */ export interface TaskContext { /** * Metadata of the current test diff --git a/packages/vitest/src/public/index.ts b/packages/vitest/src/public/index.ts index 42f2c031670b..4798ba6c23ad 100644 --- a/packages/vitest/src/public/index.ts +++ b/packages/vitest/src/public/index.ts @@ -4,8 +4,14 @@ import '../types/global' import type { Custom as Custom_, + DoneCallback as DoneCallback_, File as File_, + RuntimeContext as RuntimeContext_, + SuiteHooks as SuiteHooks_, Suite as Suite_, + TaskBase as TaskBase_, + TaskResultPack as TaskResultPack_, + TaskResult as TaskResult_, Task as Task_, Test as Test_, } from '@vitest/runner' @@ -18,6 +24,10 @@ import type { TscErrorInfo as TscErrorInfo_, } from '../typecheck/types' +import type { + WorkerRPC as WorkerRPC_, +} from '../types/worker' + import type { ArgumentsType as ArgumentsType_, Arrayable as Arrayable_, @@ -86,6 +96,9 @@ import type { } from '../node/types/benchmark' import type { SerializedTestSpecification } from '../runtime/types/utils' +import type { + WorkerContext as WorkerContext_, +} from '../node/types/worker' export { suite, @@ -137,34 +150,46 @@ export type Test = Test_ export type Custom = Custom_ /** @deprecated use `RunnerTask` instead */ export type Task = Task_ +/** @deprecated use `RunnerTaskBase` instead */ +export type TaskBase = TaskBase_ +/** @deprecated use `RunnerTaskResult` instead */ +export type TaskResult = TaskResult_ +/** @deprecated use `RunnerTaskResultPack` instead */ +export type TaskResultPack = TaskResultPack_ + +/** @deprecated don't use `DoneCallback` since it's not supported */ +export type DoneCallback = DoneCallback_ + +/** @deprecated internal type, don't use it */ +export type RuntimeContext = RuntimeContext_ +/** @deprecated internal type, don't use it */ +export type SuiteHooks = SuiteHooks_ export type { RunMode, TaskState, - TaskBase, - TaskResult, - TaskResultPack, + TaskBase as RunnerTaskBase, + TaskResult as RunnerTaskResult, + TaskResultPack as RunnerTaskResultPack, Suite as RunnerTestSuite, File as RunnerTestFile, Test as RunnerTestCase, Task as RunnerTask, Custom as RunnerCustomCase, - DoneCallback, TestFunction, TestOptions, TestAPI, SuiteAPI, HookListener, HookCleanupCallback, - SuiteHooks, SuiteCollector, SuiteFactory, - RuntimeContext, TestContext, TaskContext, ExtendedContext, TaskCustomOptions, OnTestFailedHandler, + OnTestFinishedHandler, TaskMeta, } from '@vitest/runner' export type { @@ -182,17 +207,17 @@ export type { SnapshotSerializer, } from '@vitest/snapshot' +/** @deprecated import from `vitest/node` instead */ +export type WorkerContext = WorkerContext_ +/** @deprecated import from `vitest/node` instead */ +export type WorkerRPC = WorkerRPC_ + export type { ResolveIdFunction, - WorkerRPC, WorkerGlobalState, ContextTestEnvironment, ContextRPC, } from '../types/worker' -export type { - /** @deprecated import from `vitest/node` instead */ - WorkerContext, -} from '../node/types/worker' /** @deprecated do not use, internal helper */ export type Awaitable = Awaitable_ diff --git a/packages/vitest/src/types/rpc.ts b/packages/vitest/src/types/rpc.ts index 7f5cc4bc8380..5fd1f45c7687 100644 --- a/packages/vitest/src/types/rpc.ts +++ b/packages/vitest/src/types/rpc.ts @@ -1,4 +1,3 @@ -import type { FetchResult, RawSourceMap, ViteNodeResolveId } from 'vite-node' import type { CancelReason, File, TaskResultPack } from '@vitest/runner' import type { SnapshotResult } from '@vitest/snapshot' import type { AfterSuiteRunMeta, TransformMode, UserConsoleLog } from './general' @@ -11,16 +10,30 @@ export interface RuntimeRPC { externalize?: string id?: string }> - transform: (id: string, transformMode: TransformMode) => Promise + transform: (id: string, transformMode: TransformMode) => Promise<{ + code?: string + }> resolveId: ( id: string, importer: string | undefined, transformMode: TransformMode - ) => Promise + ) => Promise<{ + external?: boolean | 'absolute' | 'relative' + id: string + /** @deprecated */ + meta?: Record | null + /** @deprecated */ + moduleSideEffects?: boolean | 'no-treeshake' | null + /** @deprecated */ + syntheticNamedExports?: boolean | string | null + } | null> + /** + * @deprecated unused + */ getSourceMap: ( id: string, force?: boolean - ) => Promise + ) => Promise onFinished: (files: File[], errors?: unknown[]) => void onPathsCollected: (paths: string[]) => void