vitest 0.0.8 → 0.0.12

package/README.md

@@ -6,12 +6,14 @@ A blazing fast test runner powered by Vite.
 
 ## Features
 
-- Vite's transformer, resolver, and plugin system. Powered by [vite-node](https://github.com/antfu/vite-node).
-- Jest Snapshot.
-- Chai for assertions.
-- Async suite / test.
-- ESM friendly, top level await.
-- Suite and Test filtering (skip, only, todo).
+- [Vite](https://vitejs.dev/)'s config, transformers, resolvers, and plugins. Powered by [vite-node](https://github.com/antfu/vite-node)
+- [Jest Snapshot](https://jestjs.io/docs/snapshot-testing)
+- [Chai](https://www.chaijs.com/) for assertions
+- [Sinon](https://sinonjs.org/) for mocking
+- Async suite / test, top level await
+- ESM friendly
+- Out-of-box TypeScript support
+- Suite and Test filtering (skip, only, todo)
 
 ```ts
 import { it, describe, expect, assert } from 'vitest'
@@ -35,6 +37,27 @@ describe('suite name', () => {
 $ npx vitest
 ```
 
+## Configuration
+
+`vitest` will read your root `vite.config.ts` when it present to match with the plugins and setup as your Vite app. If you want to it to have a different configuration for testing, you could either:
+
+- Create `vitest.config.ts`, which will have the higher priority
+- Pass `--config` option to CLI, e.g. `vitest --config ./path/to/vitest.config.ts`
+- Use `process.env.VITEST` to conditionally apply differnet configuration in `vite.config.ts`
+
+To configure `vitest` itself, add `test` property in your Vite config
+
+```ts
+// vite.config.ts
+import { defineConfig } from 'vite'
+
+export default defineConfig({
+  test: {
+    // ...
+  }
+})
+```
+
 ## Filtering
 
 ### Skipping suites and tasks
@@ -91,19 +114,22 @@ Use `.todo` to stub suites and tests that should be implemented
 describe.todo('unimplemented suite')
 
 // An entry will be shown in the report for this task
-describe.suite('suite', () => {
+describe('suite', () => {
   it.todo('unimplemented task')
 })
 ```
 
 ## TODO
 
-- [ ] Reporter & Better output
+- [x] Reporter & Better output
+- [x] Task filter
+- [x] Mock
+- [ ] Global Mode & Types
+- [ ] Parallel Executing
 - [ ] CLI Help
-- [ ] Task filter
-- [ ] Mock
 - [ ] JSDom
 - [ ] Watch
+- [ ] Source Map
 - [ ] Coverage
 
 ## Sponsors

package/bin/vitest.mjs

@@ -7,6 +7,8 @@ import { run } from 'vite-node'
 import minimist from 'minimist'
 import { findUp } from 'find-up'
 
+process.env.VITEST = 'true'
+
 const argv = minimist(process.argv.slice(2), {
   alias: {
     c: 'config',

package/dist/cli.js

@@ -22,7 +22,7 @@ const argv = minimist(process.argv.slice(2), {
 const server = (_a = process === null || process === void 0 ? void 0 : process.__vite_node__) === null || _a === void 0 ? void 0 : _a.server;
 const viteConfig = (server === null || server === void 0 ? void 0 : server.config) || {};
 const testOptions = viteConfig.test || {};
-await run(Object.assign(Object.assign({}, testOptions), { updateSnapshot: argv.update, rootDir: argv.root || process.cwd() }));
+await run(Object.assign(Object.assign({}, testOptions), { server, updateSnapshot: argv.update, rootDir: argv.root || process.cwd(), nameFilters: argv._ }));
 function help() {
     log('Help: finish help');
 }

package/dist/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const defaultIncludes: string[];
+export declare const defaultExcludes: string[];

package/dist/constants.js

@@ -0,0 +1,2 @@
+export const defaultIncludes = ['**/*.{test,spec}.{js,mjs,cjs,ts,mts,cts,jsx,tsx}'];
+export const defaultExcludes = ['**/node_modules/**', '**/dist/**'];

package/dist/defaultIncludes.js

@@ -0,0 +1 @@
+"use strict";

package/dist/index.d.ts

@@ -1,5 +1,8 @@
+import sinon from 'sinon';
 export * from './types';
 export * from './suite';
 export * from './config';
 export * from './chai';
 export { beforeAll, afterAll, beforeEach, afterEach, beforeFile, afterFile, beforeSuite, afterSuite } from './hooks';
+export { sinon };
+export declare const mock: sinon.SinonMockStatic, spy: sinon.SinonSpyStatic, stub: sinon.SinonStubStatic;

package/dist/index.js

@@ -1,5 +1,8 @@
+import sinon from 'sinon';
 export * from './types';
 export * from './suite';
 export * from './config';
 export * from './chai';
 export { beforeAll, afterAll, beforeEach, afterEach, beforeFile, afterFile, beforeSuite, afterSuite } from './hooks';
+export { sinon };
+export const { mock, spy, stub } = sinon;

package/dist/reporters/default.d.ts

@@ -5,14 +5,15 @@ export declare class DefaultReporter implements Reporter {
     end: number;
     onStart(): void;
     onCollected(): void;
-    onFinished({ files }: RunnerContext): void;
     onSuiteBegin(suite: Suite): void;
     onSuiteEnd(suite: Suite): void;
     onFileBegin(file: File): void;
     onFileEnd(): void;
-    onTaskBegin(): void;
-    onTaskEnd(t: Task): void;
-    log(msg?: string, indentDelta?: number): void;
-    error(msg?: string, indentDelta?: number): void;
+    onTaskBegin(task: Task): void;
+    onTaskEnd(task: Task): void;
+    onFinished({ files }: RunnerContext): void;
+    private getIndent;
+    private log;
+    private error;
     onSnapshotUpdate(): void;
 }

package/dist/reporters/default.js

@@ -1,7 +1,10 @@
 import { relative } from 'path';
 import { performance } from 'perf_hooks';
 import c from 'picocolors';
+import ora from 'ora';
 const DOT = '· ';
+const CHECK = '✔ ';
+const CROSS = '⤫ ';
 export class DefaultReporter {
     constructor() {
         this.indent = 0;
@@ -14,23 +17,6 @@ export class DefaultReporter {
     onCollected() {
         this.start = performance.now();
     }
-    onFinished({ files }) {
-        this.end = performance.now();
-        const tasks = files.reduce((acc, file) => acc.concat(file.suites.flatMap(i => i.tasks)), []);
-        const passed = tasks.filter(i => i.status === 'pass');
-        const failed = tasks.filter(i => i.status === 'fail');
-        const skipped = tasks.filter(i => i.status === 'skip');
-        const todo = tasks.filter(i => i.status === 'todo');
-        this.indent = 0;
-        this.log(c.green(`Passed   ${passed.length} / ${tasks.length}`));
-        if (skipped.length)
-            this.log(c.yellow(`Skipped  ${skipped.length}`));
-        if (todo.length)
-            this.log(c.dim(`Todo     ${todo.length}`));
-        if (failed.length)
-            this.log(c.red(`Failed   ${failed.length} / ${tasks.length}`));
-        this.log(`Time     ${(this.end - this.start).toFixed(2)}ms`);
-    }
     onSuiteBegin(suite) {
         if (suite.name) {
             this.indent += 1;
@@ -53,33 +39,76 @@ export class DefaultReporter {
     onFileEnd() {
         this.log();
     }
-    onTaskBegin() {
+    onTaskBegin(task) {
         this.indent += 1;
+        // @ts-expect-error
+        task.__ora = ora({ text: task.name, prefixText: this.getIndent().slice(1), spinner: 'arc' }).start();
     }
-    onTaskEnd(t) {
-        if (t.status === 'pass') {
-            this.log(`${c.green(`✔ ${t.name}`)}`);
+    onTaskEnd(task) {
+        var _a;
+        // @ts-expect-error
+        (_a = task.__ora) === null || _a === void 0 ? void 0 : _a.stop();
+        if (task.state === 'pass') {
+            this.log(`${c.green(CHECK + task.name)}`);
         }
-        else if (t.status === 'skip') {
-            this.log(c.dim(c.yellow(`${DOT + t.name} (skipped)`)));
+        else if (task.state === 'skip') {
+            this.log(c.dim(c.yellow(`${DOT + task.name} (skipped)`)));
         }
-        else if (t.status === 'todo') {
-            this.log(c.dim(`${DOT + t.name} (todo)`));
+        else if (task.state === 'todo') {
+            this.log(c.dim(`${DOT + task.name} (todo)`));
         }
         else {
-            this.error(`${c.red(`⤫ ${c.inverse(c.red(' FAIL '))} ${t.name}`)}`);
-            this.error(String(t.error), 1);
+            this.error(`${c.red(`${CROSS}${task.name}`)}`);
             process.exitCode = 1;
         }
         this.indent -= 1;
     }
-    log(msg = '', indentDelta = 0) {
+    onFinished({ files }) {
+        this.end = performance.now();
+        const failedFiles = files.filter(i => i.error);
+        const tasks = files.reduce((acc, file) => acc.concat(file.suites.flatMap(i => i.tasks)), []);
+        const runable = tasks.filter(i => i.state === 'pass' || i.state === 'fail');
+        const passed = tasks.filter(i => i.state === 'pass');
+        const failed = tasks.filter(i => i.state === 'fail');
+        const skipped = tasks.filter(i => i.state === 'skip');
+        const todo = tasks.filter(i => i.state === 'todo');
+        this.indent = 0;
+        if (failedFiles.length) {
+            this.error(c.bold(`\nFailed to parse ${failedFiles.length} files:`));
+            failedFiles.forEach((i) => {
+                this.error(`\n- ${i.filepath}`);
+                console.error(i.error || 'Unknown error');
+                this.log();
+            });
+        }
+        if (failed.length) {
+            this.error(c.bold(`\nFailed Tests (${failed.length})`));
+            failed.forEach((task) => {
+                var _a;
+                this.error(`\n${CROSS + c.inverse(c.red(' FAIL '))} ${[task.suite.name, task.name].filter(Boolean).join(' > ')} ${c.gray(`${(_a = task.file) === null || _a === void 0 ? void 0 : _a.filepath}`)}`);
+                console.error(task.error || 'Unknown error');
+                this.log();
+            });
+        }
+        this.log(c.green(`Passed   ${passed.length} / ${runable.length}`));
+        if (failed.length)
+            this.log(c.red(`Failed   ${failed.length} / ${runable.length}`));
+        if (skipped.length)
+            this.log(c.yellow(`Skipped  ${skipped.length}`));
+        if (todo.length)
+            this.log(c.dim(`Todo     ${todo.length}`));
+        this.log(`Time     ${(this.end - this.start).toFixed(2)}ms`);
+    }
+    getIndent(offest = 0) {
+        return ' '.repeat((this.indent + offest) * 2);
+    }
+    log(msg = '', indentOffset = 0) {
         // eslint-disable-next-line no-console
-        console.log(`${' '.repeat((this.indent + indentDelta) * 2)}${msg}`);
+        console.log(`${this.getIndent(indentOffset)}${msg}`);
     }
-    error(msg = '', indentDelta = 0) {
+    error(msg = '', indentOffset = 0) {
         // eslint-disable-next-line no-console
-        console.error(c.red(`${' '.repeat((this.indent + indentDelta) * 2)}${msg}`));
+        console.error(c.red(`${this.getIndent(indentOffset)}${msg}`));
     }
     onSnapshotUpdate() {
     }

package/dist/run.d.ts

@@ -1,5 +1,5 @@
-import { File, Options, Task, RunnerContext } from './types';
+import { File, Config, Task, RunnerContext } from './types';
 export declare function runTask(task: Task, ctx: RunnerContext): Promise<void>;
-export declare function collectFiles(files: string[]): Promise<File[]>;
+export declare function collectFiles(paths: string[]): Promise<File[]>;
 export declare function runFile(file: File, ctx: RunnerContext): Promise<void>;
-export declare function run(options?: Options): Promise<void>;
+export declare function run(config: Config): Promise<void>;

package/dist/run.js

@@ -1,57 +1,84 @@
 import chai from 'chai';
 import fg from 'fast-glob';
+import SinonChai from 'sinon-chai';
 import { clearContext, defaultSuite } from './suite';
 import { context } from './context';
 import { afterEachHook, afterFileHook, afterAllHook, afterSuiteHook, beforeEachHook, beforeFileHook, beforeAllHook, beforeSuiteHook } from './hooks';
 import { SnapshotPlugin } from './snapshot';
 import { DefaultReporter } from './reporters/default';
+import { defaultIncludes, defaultExcludes } from './constants';
 export async function runTask(task, ctx) {
     var _a, _b;
     const { reporter } = ctx;
     await ((_a = reporter.onTaskBegin) === null || _a === void 0 ? void 0 : _a.call(reporter, task, ctx));
-    await beforeEachHook.fire(task);
-    if (task.suite.mode === 'skip' || task.mode === 'skip') {
-        task.status = 'skip';
-    }
-    else if (task.suite.mode === 'todo' || task.mode === 'todo') {
-        task.status = 'todo';
-    }
-    else {
+    if (task.mode === 'run') {
+        await beforeEachHook.fire(task);
         try {
             await task.fn();
-            task.status = 'pass';
+            task.state = 'pass';
         }
         catch (e) {
-            task.status = 'fail';
+            task.state = 'fail';
             task.error = e;
         }
+        await afterEachHook.fire(task);
     }
-    await afterEachHook.fire(task);
     await ((_b = reporter.onTaskEnd) === null || _b === void 0 ? void 0 : _b.call(reporter, task, ctx));
 }
-export async function collectFiles(files) {
-    const result = [];
-    for (const filepath of files) {
-        clearContext();
-        await import(filepath);
-        const collectors = [defaultSuite, ...context.suites];
-        const suites = [];
+export async function collectFiles(paths) {
+    const files = [];
+    for (const filepath of paths) {
         const file = {
             filepath,
             suites: [],
+            collected: false,
         };
-        for (const c of collectors) {
-            context.currentSuite = c;
-            suites.push(await c.collect(file));
+        clearContext();
+        try {
+            await import(filepath);
+            const collectors = [defaultSuite, ...context.suites];
+            for (const c of collectors) {
+                context.currentSuite = c;
+                file.suites.push(await c.collect(file));
+            }
+            file.collected = true;
+        }
+        catch (e) {
+            file.error = e;
+            file.collected = false;
+            process.exitCode = 1;
         }
-        file.suites = suites;
-        result.push(file);
+        files.push(file);
+    }
+    const allSuites = files.reduce((suites, file) => suites.concat(file.suites), []);
+    interpretOnlyMode(allSuites);
+    allSuites.forEach((i) => {
+        if (i.mode === 'skip')
+            i.tasks.forEach(t => t.mode === 'run' && (t.state = 'skip'));
+        else
+            interpretOnlyMode(i.tasks);
+    });
+    return files;
+}
+/**
+ * If any items been marked as `only`, mark all other items as `skip`.
+ */
+function interpretOnlyMode(items) {
+    if (items.some(i => i.mode === 'only')) {
+        items.forEach((i) => {
+            if (i.mode === 'run')
+                i.mode = 'skip';
+            else if (i.mode === 'only')
+                i.mode = 'run';
+        });
     }
-    return result;
 }
 export async function runFile(file, ctx) {
     var _a, _b, _c, _d;
     const { reporter } = ctx;
+    const runableSuites = file.suites.filter(i => i.mode === 'run');
+    if (runableSuites.length === 0)
+        return;
     await ((_a = reporter.onFileBegin) === null || _a === void 0 ? void 0 : _a.call(reporter, file, ctx));
     await beforeFileHook.fire(file);
     for (const suite of file.suites) {
@@ -65,39 +92,40 @@ export async function runFile(file, ctx) {
     await afterFileHook.fire(file);
     await ((_d = reporter.onFileEnd) === null || _d === void 0 ? void 0 : _d.call(reporter, file, ctx));
 }
-export async function run(options = {}) {
-    var _a, _b, _c;
-    const { rootDir = process.cwd() } = options;
+export async function run(config) {
+    var _a, _b, _c, _d;
+    const { rootDir = process.cwd() } = config;
+    // setup chai
     chai.use(await SnapshotPlugin({
         rootDir,
-        update: options.updateSnapshot,
+        update: config.updateSnapshot,
     }));
-    const paths = await fg(options.includes || ['**/*.{test,spec}.{js,mjs,cjs,ts,mts,cts,jsx,tsx}'], {
+    chai.use(SinonChai);
+    // collect files
+    let paths = await fg(config.includes || defaultIncludes, {
         absolute: true,
-        cwd: options.rootDir,
-        ignore: options.excludes || ['**/node_modules/**', '**/dist/**'],
+        cwd: config.rootDir,
+        ignore: config.excludes || defaultExcludes,
     });
+    if ((_a = config.nameFilters) === null || _a === void 0 ? void 0 : _a.length)
+        paths = paths.filter(i => config.nameFilters.some(f => i.includes(f)));
     if (!paths.length) {
         console.error('No test files found');
         process.exitCode = 1;
         return;
     }
     const reporter = new DefaultReporter();
-    await ((_a = reporter.onStart) === null || _a === void 0 ? void 0 : _a.call(reporter, options));
+    await ((_b = reporter.onStart) === null || _b === void 0 ? void 0 : _b.call(reporter, config));
     const files = await collectFiles(paths);
     const ctx = {
         files,
-        mode: isOnlyMode(files) ? 'only' : 'all',
-        userOptions: options,
+        config,
         reporter,
     };
-    await ((_b = reporter.onCollected) === null || _b === void 0 ? void 0 : _b.call(reporter, ctx));
+    await ((_c = reporter.onCollected) === null || _c === void 0 ? void 0 : _c.call(reporter, ctx));
     await beforeAllHook.fire();
     for (const file of files)
         await runFile(file, ctx);
     await afterAllHook.fire();
-    await ((_c = reporter.onFinished) === null || _c === void 0 ? void 0 : _c.call(reporter, ctx));
-}
-function isOnlyMode(files) {
-    return !!files.find(file => file.suites.find(suite => suite.mode === 'only' || suite.tasks.find(t => t.mode === 'only')));
+    await ((_d = reporter.onFinished) === null || _d === void 0 ? void 0 : _d.call(reporter, ctx));
 }

package/dist/suite.js

@@ -22,7 +22,7 @@ function createSuiteCollector(mode, suiteName, factory) {
             name,
             mode,
             suite: {},
-            status: 'init',
+            state: mode !== 'run' ? mode : undefined,
             fn,
         });
     }

package/dist/types.d.ts

@@ -1,21 +1,25 @@
+import { ViteDevServer } from 'vite';
 export declare type Awaitable<T> = Promise<T> | T;
 export interface UserOptions {
     includes?: string[];
     excludes?: string[];
 }
-export interface Options extends UserOptions {
+export interface Config extends UserOptions {
     rootDir?: string;
     updateSnapshot?: boolean;
+    nameFilters?: string[];
+    server: ViteDevServer;
+    watch?: boolean;
 }
 export declare type RunMode = 'run' | 'skip' | 'only' | 'todo';
-export declare type TaskStatus = 'init' | 'pass' | 'fail' | 'skip' | 'todo';
+export declare type TaskState = RunMode | 'pass' | 'fail';
 export interface Task {
     name: string;
     mode: RunMode;
     suite: Suite;
     fn: () => Awaitable<void>;
     file?: File;
-    status: TaskStatus;
+    state?: TaskState;
     error?: unknown;
 }
 export declare type TestFunction = () => Awaitable<void>;
@@ -42,11 +46,12 @@ export declare type TestFactory = (test: (name: string, fn: TestFunction) => voi
 export interface File {
     filepath: string;
     suites: Suite[];
+    collected: boolean;
+    error?: unknown;
 }
 export interface RunnerContext {
     files: File[];
-    mode: 'all' | 'only';
-    userOptions: Options;
+    config: Config;
     reporter: Reporter;
 }
 export interface GlobalContext {
@@ -54,7 +59,7 @@ export interface GlobalContext {
     currentSuite: SuiteCollector | null;
 }
 export interface Reporter {
-    onStart: (userOptions: Options) => Awaitable<void>;
+    onStart: (userOptions: Config) => Awaitable<void>;
     onCollected: (ctx: RunnerContext) => Awaitable<void>;
     onFinished: (ctx: RunnerContext) => Awaitable<void>;
     onSuiteBegin: (suite: Suite, ctx: RunnerContext) => Awaitable<void>;

package/dist/types.js

@@ -1,2 +1 @@
-/* eslint-disable no-use-before-define */
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vitest",
-  "version": "0.0.8",
+  "version": "0.0.12",
   "type": "module",
   "description": "",
   "keywords": [],
@@ -37,6 +37,7 @@
     "@antfu/ni": "^0.11.0",
     "@types/minimist": "^1.2.2",
     "@types/node": "^16.11.11",
+    "@types/sinon": "^10.0.6",
     "bumpp": "^7.1.1",
     "eslint": "^8.3.0",
     "esno": "^0.12.1",
@@ -46,13 +47,17 @@
   "dependencies": {
     "@jest/test-result": "^27.4.2",
     "@types/chai": "^4.2.22",
+    "@types/sinon-chai": "^3.2.6",
     "chai": "^4.3.4",
     "fast-glob": "^3.2.7",
     "find-up": "^6.2.0",
     "jest-snapshot": "^27.4.2",
     "jest-util": "^27.4.2",
     "minimist": "^1.2.5",
+    "ora": "^6.0.1",
     "picocolors": "^1.0.0",
+    "sinon": "^12.0.1",
+    "sinon-chai": "^3.7.0",
     "vite-node": "^0.1.10"
   },
   "scripts": {