vitest 0.16.0 → 0.18.0

package/dist/node.d.ts

@@ -1,5 +1,87 @@
 import { ViteDevServer, TransformResult, CommonServerOptions, UserConfig as UserConfig$1, Plugin as Plugin$1 } from 'vite';
+import { Stats } from 'fs';
 
+interface UpdatePayload {
+  type: 'update'
+  updates: Update[]
+}
+
+interface Update {
+  type: 'js-update' | 'css-update'
+  path: string
+  acceptedPath: string
+  timestamp: number
+}
+
+interface PrunePayload {
+  type: 'prune'
+  paths: string[]
+}
+
+interface FullReloadPayload {
+  type: 'full-reload'
+  path?: string
+}
+
+interface ErrorPayload {
+  type: 'error'
+  err: {
+    [name: string]: any
+    message: string
+    stack: string
+    id?: string
+    frame?: string
+    plugin?: string
+    pluginCode?: string
+    loc?: {
+      file?: string
+      line: number
+      column: number
+    }
+  }
+}
+
+interface CustomEventMap {
+  'vite:beforeUpdate': UpdatePayload
+  'vite:beforePrune': PrunePayload
+  'vite:beforeFullReload': FullReloadPayload
+  'vite:error': ErrorPayload
+}
+
+type InferCustomEventPayload<T extends string> =
+  T extends keyof CustomEventMap ? CustomEventMap[T] : any
+
+type ModuleNamespace = Record<string, any> & {
+  [Symbol.toStringTag]: 'Module'
+}
+
+interface ViteHotContext {
+  readonly data: any
+
+  accept(): void
+  accept(cb: (mod: ModuleNamespace | undefined) => void): void
+  accept(dep: string, cb: (mod: ModuleNamespace | undefined) => void): void
+  accept(
+    deps: readonly string[],
+    cb: (mods: Array<ModuleNamespace | undefined>) => void
+  ): void
+
+  acceptExports(exportNames: string | readonly string[]): void
+  acceptExports(
+    exportNames: string | readonly string[],
+    cb: (mod: ModuleNamespace | undefined) => void
+  ): void
+
+  dispose(cb: (data: any) => void): void
+  decline(): void
+  invalidate(): void
+
+  on<T extends string>(
+    event: T,
+    cb: (payload: InferCustomEventPayload<T>) => void
+  ): void
+  send<T extends string>(event: T, data?: InferCustomEventPayload<T>): void
+}
 declare class ModuleCacheMap extends Map<string, ModuleCache> {
     normalizePath(fsPath: string): string;
     set(fsPath: string, mod: Partial<ModuleCache>): this;
@@ -61,8 +143,10 @@ interface FetchResult {
     externalize?: string;
     map?: RawSourceMap;
 }
+declare type HotContext = Omit<ViteHotContext, 'acceptDeps' | 'decline'>;
 declare type FetchFunction = (id: string) => Promise<FetchResult>;
 declare type ResolveIdFunction = (id: string, importer?: string) => Promise<ViteNodeResolveId | null>;
+declare type CreateHotContextFunction = (runner: ViteNodeRunner, url: string) => HotContext;
 interface ModuleCache {
     promise?: Promise<any>;
     exports?: any;
@@ -72,6 +156,7 @@ interface ViteNodeRunnerOptions {
     root: string;
     fetchModule: FetchFunction;
     resolveId?: ResolveIdFunction;
+    createHotContext?: CreateHotContextFunction;
     base?: string;
     moduleCache?: ModuleCacheMap;
     interopDefault?: boolean;
@@ -282,12 +367,17 @@ declare abstract class BaseReporter implements Reporter {
     watchFilters?: string[];
     isTTY: boolean;
     ctx: Vitest;
+    private _filesInWatchMode;
+    private _lastRunTimeout;
+    private _lastRunTimer;
+    private _lastRunCount;
     constructor();
     onInit(ctx: Vitest): void;
     relative(path: string): string;
     onFinished(files?: File[], errors?: unknown[]): Promise<void>;
     onTaskUpdate(packs: TaskResultPack[]): void;
     onWatcherStart(): Promise<void>;
+    private resetLastRunLog;
     onWatcherRerun(files: string[], trigger?: string): Promise<void>;
     onUserConsoleLog(log: UserConsoleLog): void;
     shouldLog(log: UserConsoleLog): boolean;
@@ -297,9 +387,35 @@ declare abstract class BaseReporter implements Reporter {
     registerUnhandledRejection(): void;
 }
 
+declare class Logger {
+    ctx: Vitest;
+    console: Console;
+    outputStream: NodeJS.WriteStream & {
+        fd: 1;
+    };
+    errorStream: NodeJS.WriteStream & {
+        fd: 2;
+    };
+    logUpdate: ((...text: string[]) => void) & {
+        clear(): void;
+        done(): void;
+    };
+    private _clearScreenPending;
+    constructor(ctx: Vitest, console?: Console);
+    log(...args: any[]): void;
+    error(...args: any[]): void;
+    warn(...args: any[]): void;
+    clearScreen(message: string, force?: boolean): void;
+    private _clearScreen;
+    printError(err: unknown, fullStack?: boolean, type?: string): Promise<void>;
+    printNoTestFound(filters?: string[]): void;
+    printBanner(): void;
+    printUnhandledErrors(errors: unknown[]): Promise<void>;
+}
+
 interface ListRendererOptions {
     renderSucceed?: boolean;
-    outputStream: NodeJS.WritableStream;
+    logger: Logger;
     showHeap: boolean;
 }
 declare const createListRenderer: (_tasks: Task[], options: ListRendererOptions) => {
@@ -389,6 +505,18 @@ declare const ReportersMap: {
 };
 declare type BuiltinReporters = keyof typeof ReportersMap;
 
+interface TestSequencer {
+    /**
+     * Slicing tests into shards. Will be run before `sort`.
+     * Only run, if `shard` is defined.
+     */
+    shard(files: string[]): Awaitable<string[]>;
+    sort(files: string[]): Awaitable<string[]>;
+}
+interface TestSequencerConstructor {
+    new (ctx: Vitest): TestSequencer;
+}
+
 declare type Awaitable<T> = T | PromiseLike<T>;
 declare type Arrayable<T> = T | Array<T>;
 declare type ArgumentsType<T> = T extends (...args: infer U) => any ? U : never;
@@ -572,6 +700,7 @@ interface TaskBase {
     name: string;
     mode: RunMode;
     concurrent?: boolean;
+    shuffle?: boolean;
     suite?: Suite;
     file?: File;
     result?: TaskResult;
@@ -685,7 +814,7 @@ interface SnapshotSummary {
     updated: number;
 }
 
-declare type BuiltinEnvironment = 'node' | 'jsdom' | 'happy-dom';
+declare type BuiltinEnvironment = 'node' | 'jsdom' | 'happy-dom' | 'edge-runtime';
 declare type ApiConfig = Pick<CommonServerOptions, 'port' | 'strictPort' | 'host'>;
 
 interface EnvironmentOptions {
@@ -763,7 +892,7 @@ interface InlineConfig {
     /**
      * Running environment
      *
-     * Supports 'node', 'jsdom', 'happy-dom'
+     * Supports 'node', 'jsdom', 'happy-dom', 'edge-runtime'
      *
      * @default 'node'
      */
@@ -988,6 +1117,35 @@ interface InlineConfig {
      * @default 5
      */
     maxConcurrency?: number;
+    /**
+     * Options for configuring cache policy.
+     * @default { dir: 'node_modules/.vitest' }
+     */
+    cache?: false | {
+        dir?: string;
+    };
+    /**
+     * Options for configuring the order of running tests.
+     */
+    sequence?: {
+        /**
+         * Class that handles sorting and sharding algorithm.
+         * If you only need to change sorting, you can extend
+         * your custom sequencer from `BaseSequencer` from `vitest/node`.
+         * @default BaseSequencer
+         */
+        sequencer?: TestSequencerConstructor;
+        /**
+         * Should tests run in random order.
+         * @default false
+         */
+        shuffle?: boolean;
+        /**
+         * Seed for the random number generator.
+         * @default Date.now()
+         */
+        seed?: number;
+    };
 }
 interface UserConfig extends InlineConfig {
     /**
@@ -1027,7 +1185,7 @@ interface UserConfig extends InlineConfig {
      */
     shard?: string;
 }
-interface ResolvedConfig extends Omit<Required<UserConfig>, 'config' | 'filters' | 'coverage' | 'testNamePattern' | 'related' | 'api' | 'reporters' | 'resolveSnapshotPath' | 'shard'> {
+interface ResolvedConfig extends Omit<Required<UserConfig>, 'config' | 'filters' | 'coverage' | 'testNamePattern' | 'related' | 'api' | 'reporters' | 'resolveSnapshotPath' | 'shard' | 'cache' | 'sequence'> {
     base?: string;
     config?: string;
     filters?: string[];
@@ -1042,6 +1200,14 @@ interface ResolvedConfig extends Omit<Required<UserConfig>, 'config' | 'filters'
         index: number;
         count: number;
     };
+    cache: {
+        dir: string;
+    } | false;
+    sequence: {
+        sequencer: TestSequencerConstructor;
+        shuffle?: boolean;
+        seed?: number;
+    };
 }
 
 declare type VitestInlineConfig = InlineConfig;
@@ -1334,26 +1500,70 @@ declare class StateManager {
     getFilepaths(): string[];
     getFailedFilepaths(): string[];
     collectFiles(files?: File[]): void;
+    clearFiles(paths?: string[]): void;
     updateId(task: Task): void;
     updateTasks(packs: TaskResultPack[]): void;
     updateUserLog(log: UserConsoleLog): void;
 }
 
+interface SuiteResultCache {
+    failed: boolean;
+    duration: number;
+}
+declare class ResultsCache {
+    private cache;
+    private cachePath;
+    private version;
+    private root;
+    getCachePath(): string | null;
+    setConfig(root: string, config: ResolvedConfig['cache']): void;
+    getResults(fsPath: string): SuiteResultCache | undefined;
+    readFromCache(): Promise<void>;
+    updateResults(files: File[]): void;
+    removeFromCache(filepath: string): void;
+    writeToCache(): Promise<void>;
+}
+
+interface CliOptions extends UserConfig {
+    /**
+     * Override the watch mode
+     */
+    run?: boolean;
+}
+declare function startVitest(cliFilters: string[], options: CliOptions, viteOverrides?: UserConfig$1): Promise<boolean>;
+
+declare type FileStatsCache = Pick<Stats, 'size'>;
+declare class FilesStatsCache {
+    cache: Map<string, FileStatsCache>;
+    getStats(fsPath: string): FileStatsCache | undefined;
+    updateStats(fsPath: string): Promise<void>;
+    removeStats(fsPath: string): void;
+}
+
+declare class VitestCache {
+    results: ResultsCache;
+    stats: FilesStatsCache;
+    getFileTestResults(id: string): SuiteResultCache | undefined;
+    getFileStats(id: string): {
+        size: number;
+    } | undefined;
+    static resolveCacheDir(root: string, dir: string | undefined): string;
+    static clearCache(options: CliOptions): Promise<{
+        dir: string;
+        cleared: boolean;
+    }>;
+}
+
 declare class Vitest {
     config: ResolvedConfig;
     configOverride: Partial<ResolvedConfig> | undefined;
     server: ViteDevServer;
     state: StateManager;
     snapshot: SnapshotManager;
+    cache: VitestCache;
     reporters: Reporter[];
-    console: Console;
+    logger: Logger;
     pool: WorkerPool | undefined;
-    outputStream: NodeJS.WriteStream & {
-        fd: 1;
-    };
-    errorStream: NodeJS.WriteStream & {
-        fd: 2;
-    };
     vitenode: ViteNodeServer;
     invalidates: Set<string>;
     changedTests: Set<string>;
@@ -1362,21 +1572,18 @@ declare class Vitest {
     isFirstRun: boolean;
     restartsCount: number;
     runner: ViteNodeRunner;
-    private _onRestartListeners;
     constructor();
+    private _onRestartListeners;
     setServer(options: UserConfig, server: ViteDevServer): Promise<void>;
     getSerializableConfig(): ResolvedConfig;
     start(filters?: string[]): Promise<void>;
     private getTestDependencies;
     filterTestsBySource(tests: string[]): Promise<string[]>;
-    runFiles(files: string[]): Promise<void>;
+    runFiles(paths: string[]): Promise<void>;
     rerunFiles(files?: string[], trigger?: string): Promise<void>;
     changeNamePattern(pattern: string, files?: string[], trigger?: string): Promise<void>;
     rerunFailed(): Promise<void>;
     updateSnapshot(files?: string[]): Promise<void>;
-    log(...args: any[]): void;
-    error(...args: any[]): void;
-    clearScreen(): void;
     private _rerunTimer;
     private scheduleRerun;
     private unregisterWatcher;
@@ -1391,7 +1598,6 @@ declare class Vitest {
     globTestFiles(filters?: string[]): Promise<string[]>;
     isTargetFile(id: string, source?: string): Promise<boolean>;
     isInSourceTestFile(code: string): boolean;
-    printError(err: unknown, fullStack?: boolean, type?: string): Promise<void>;
     onServerRestarted(fn: () => void): void;
 }
 
@@ -1399,15 +1605,6 @@ declare function createVitest(options: UserConfig, viteOverrides?: UserConfig$1)
 
 declare function VitestPlugin(options?: UserConfig, ctx?: Vitest): Promise<Plugin$1[]>;
 
-interface CliOptions extends UserConfig {
-    /**
-     * Override the watch mode
-     */
-    run?: boolean;
-}
-declare function startVitest(cliFilters: string[], options: CliOptions, viteOverrides?: UserConfig$1): Promise<boolean>;
-
-declare type Callback = (...args: any[]) => unknown;
 interface ViteRunnerRequest {
     (dep: string): any;
     callstack: string[];
@@ -1415,15 +1612,13 @@ interface ViteRunnerRequest {
 declare class VitestMocker {
     options: ExecuteOptions;
     private moduleCache;
+    private request;
     private static pendingIds;
     private static spyModule?;
-    private request;
-    private root;
-    private callbacks;
-    constructor(options: ExecuteOptions, moduleCache: ModuleCacheMap, request?: ViteRunnerRequest);
-    get mockMap(): MockMap;
-    on(event: string, cb: Callback): void;
-    private emit;
+    constructor(options: ExecuteOptions, moduleCache: ModuleCacheMap, request: ViteRunnerRequest);
+    private get root();
+    private get base();
+    private get mockMap();
     getSuiteFilepath(): string;
     getMocks(): {
         [x: string]: string | (() => unknown) | null;
@@ -1432,7 +1627,6 @@ declare class VitestMocker {
     private resolveMocks;
     private callFunctionMock;
     getDependencyMock(dep: string): string | (() => unknown) | null;
-    resolveDependency(dep: string): string;
     normalizePath(path: string): string;
     getFsPath(path: string, external: string | null): string;
     resolveMockPath(mockPath: string, external: string | null): string | null;
@@ -1445,7 +1639,6 @@ declare class VitestMocker {
     requestWithMock(dep: string): Promise<any>;
     queueMock(id: string, importer: string, factory?: () => unknown): void;
     queueUnmock(id: string, importer: string): void;
-    withRequest(request: ViteRunnerRequest): VitestMocker;
 }
 
 interface ExecuteOptions extends ViteNodeRunnerOptions {
@@ -1453,8 +1646,6 @@ interface ExecuteOptions extends ViteNodeRunnerOptions {
 }
 declare class VitestRunner extends ViteNodeRunner {
     options: ExecuteOptions;
-    mocker: VitestMocker;
-    entries: Set<string>;
     constructor(options: ExecuteOptions);
     prepareContext(context: Record<string, any>): Record<string, any> & {
         __vite_ssr_import__: (dep: string) => Promise<any>;
@@ -1463,4 +1654,11 @@ declare class VitestRunner extends ViteNodeRunner {
     };
 }
 
-export { ExecuteOptions, Vitest, VitestPlugin, VitestRunner, createVitest, startVitest };
+declare class BaseSequencer implements TestSequencer {
+    protected ctx: Vitest;
+    constructor(ctx: Vitest);
+    shard(files: string[]): Promise<string[]>;
+    sort(files: string[]): Promise<string[]>;
+}
+
+export { BaseSequencer, ExecuteOptions, TestSequencer, TestSequencerConstructor, Vitest, VitestPlugin, VitestRunner, createVitest, startVitest };

package/dist/node.mjs

@@ -1,33 +1,33 @@
-export { V as VitestPlugin, c as createVitest, s as startVitest } from './chunk-vite-node-externalize.58e10976.mjs';
-export { V as VitestRunner } from './chunk-runtime-mocker.110e3634.mjs';
-import './chunk-utils-global.79a8b1cc.mjs';
-import 'tty';
+export { B as BaseSequencer, V as VitestPlugin, c as createVitest, s as startVitest } from './chunk-vite-node-externalize.0791f2ed.mjs';
+export { V as VitestRunner } from './chunk-runtime-mocker.79ccc3de.mjs';
+import './chunk-env-node.26c72624.mjs';
 import 'local-pkg';
+import 'fs';
+import 'module';
+import 'url';
+import './chunk-utils-global.1b22c4fd.mjs';
+import 'tty';
 import 'path';
 import 'vite';
-import 'url';
 import 'process';
-import 'fs';
-import './chunk-defaults.dc6dc23d.mjs';
-import 'module';
-import './chunk-constants.7b9cfc82.mjs';
-import 'readline';
+import './chunk-constants.8eb2ed35.mjs';
 import 'os';
 import 'util';
 import 'stream';
 import 'events';
 import './vendor-_commonjsHelpers.4da45ef5.mjs';
-import './chunk-vite-node-utils.7450fc0c.mjs';
+import './chunk-vite-node-utils.af8ead96.mjs';
 import 'vm';
 import 'assert';
 import 'debug';
 import 'worker_threads';
-import 'crypto';
 import 'tinypool';
 import 'perf_hooks';
-import './chunk-utils-source-map.2556cba8.mjs';
-import './vendor-index.e5dc6622.mjs';
-import 'child_process';
+import './chunk-utils-source-map.957e7756.mjs';
+import 'crypto';
 import 'buffer';
+import 'child_process';
+import './vendor-index.4bf9c627.mjs';
 import './chunk-magic-string.efe26975.mjs';
-import './vendor-index.98e769c1.mjs';
+import 'readline';
+import './vendor-index.de788b6a.mjs';