vitest 0.0.7 → 0.0.8

package/README.md

@@ -11,6 +11,7 @@ A blazing fast test runner powered by Vite.
 - Chai for assertions.
 - Async suite / test.
 - ESM friendly, top level await.
+- Suite and Test filtering (skip, only, todo).
 
 ```ts
 import { it, describe, expect, assert } from 'vitest'
@@ -34,6 +35,67 @@ describe('suite name', () => {
 $ npx vitest
 ```
 
+## Filtering
+
+### Skipping suites and tasks
+
+Use `.skip` to avoid running certain suites or tests 
+
+```ts
+describe.skip('skipped suite', () => {
+  it('task', () => {
+    // Suite skipped, no error
+    assert.equal(Math.sqrt(4), 3)
+  })
+})
+
+describe('suite', () => {
+  it.skip('skipped task', () => {
+    // Task skipped, no error
+    assert.equal(Math.sqrt(4), 3)
+  })
+})
+```
+
+### Selecting suites and tests to run
+
+Use `.only` to only run certain suites or tests 
+
+```ts
+// Only this suite (and others marked with only) are run
+describe.only('suite', () => {
+  it('task', () => {
+    assert.equal(Math.sqrt(4), 3) 
+  })
+})
+
+describe('another suite', () => {
+  it('skipped task', () => {
+     // Task skipped, as tests are running in Only mode
+    assert.equal(Math.sqrt(4), 3)
+  })
+
+  it.only('task', () => {
+     // Only this task (and others marked with only) are run
+    assert.equal(Math.sqrt(4), 2)
+  })
+})
+```
+
+### Unimplemented suites and tests
+
+Use `.todo` to stub suites and tests that should be implemented
+
+```ts
+ // An entry will be shown in the report for this suite
+describe.todo('unimplemented suite')
+
+// An entry will be shown in the report for this task
+describe.suite('suite', () => {
+  it.todo('unimplemented task')
+})
+```
+
 ## TODO
 
 - [ ] Reporter & Better output

package/dist/reporters/default.d.ts

@@ -0,0 +1,18 @@
+import { File, Reporter, RunnerContext, Suite, Task } from '../types';
+export declare class DefaultReporter implements Reporter {
+    indent: number;
+    start: number;
+    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;
+    onSnapshotUpdate(): void;
+}

package/dist/reporters/default.js

@@ -0,0 +1,86 @@
+import { relative } from 'path';
+import { performance } from 'perf_hooks';
+import c from 'picocolors';
+const DOT = '· ';
+export class DefaultReporter {
+    constructor() {
+        this.indent = 0;
+        this.start = 0;
+        this.end = 0;
+    }
+    onStart() {
+        this.indent = 0;
+    }
+    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;
+            const name = DOT + suite.name;
+            if (suite.mode === 'skip')
+                this.log(c.dim(c.yellow(`${name} (skipped)`)));
+            else if (suite.mode === 'todo')
+                this.log(c.dim(`${name} (todo)`));
+            else
+                this.log(name);
+        }
+    }
+    onSuiteEnd(suite) {
+        if (suite.name)
+            this.indent -= 1;
+    }
+    onFileBegin(file) {
+        this.log(`- ${relative(process.cwd(), file.filepath)} ${c.dim(`(${file.suites.flatMap(i => i.tasks).length} tests)`)}`);
+    }
+    onFileEnd() {
+        this.log();
+    }
+    onTaskBegin() {
+        this.indent += 1;
+    }
+    onTaskEnd(t) {
+        if (t.status === 'pass') {
+            this.log(`${c.green(`✔ ${t.name}`)}`);
+        }
+        else if (t.status === 'skip') {
+            this.log(c.dim(c.yellow(`${DOT + t.name} (skipped)`)));
+        }
+        else if (t.status === 'todo') {
+            this.log(c.dim(`${DOT + t.name} (todo)`));
+        }
+        else {
+            this.error(`${c.red(`⤫ ${c.inverse(c.red(' FAIL '))} ${t.name}`)}`);
+            this.error(String(t.error), 1);
+            process.exitCode = 1;
+        }
+        this.indent -= 1;
+    }
+    log(msg = '', indentDelta = 0) {
+        // eslint-disable-next-line no-console
+        console.log(`${' '.repeat((this.indent + indentDelta) * 2)}${msg}`);
+    }
+    error(msg = '', indentDelta = 0) {
+        // eslint-disable-next-line no-console
+        console.error(c.red(`${' '.repeat((this.indent + indentDelta) * 2)}${msg}`));
+    }
+    onSnapshotUpdate() {
+    }
+}

package/dist/run.d.ts

@@ -1,5 +1,5 @@
-import { File, Options, Task, TaskResult } from './types';
-export declare function runTasks(tasks: Task[]): Promise<TaskResult[]>;
+import { File, Options, 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 runFile(file: File): Promise<void>;
+export declare function runFile(file: File, ctx: RunnerContext): Promise<void>;
 export declare function run(options?: Options): Promise<void>;

package/dist/run.js

@@ -1,88 +1,72 @@
-import { relative } from 'path';
-import { performance } from 'perf_hooks';
-import c from 'picocolors';
 import chai from 'chai';
 import fg from 'fast-glob';
 import { clearContext, defaultSuite } from './suite';
 import { context } from './context';
 import { afterEachHook, afterFileHook, afterAllHook, afterSuiteHook, beforeEachHook, beforeFileHook, beforeAllHook, beforeSuiteHook } from './hooks';
-import { SnapshotPlugin } from './snapshot/index';
-export async function runTasks(tasks) {
-    const results = [];
-    for (const task of tasks) {
-        await beforeEachHook.fire(task);
-        task.result = {};
+import { SnapshotPlugin } from './snapshot';
+import { DefaultReporter } from './reporters/default';
+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 {
         try {
             await task.fn();
+            task.status = 'pass';
         }
         catch (e) {
-            task.result.error = e;
+            task.status = 'fail';
+            task.error = e;
         }
-        await afterEachHook.fire(task);
     }
-    return results;
+    await afterEachHook.fire(task);
+    await ((_b = reporter.onTaskEnd) === null || _b === void 0 ? void 0 : _b.call(reporter, task, ctx));
 }
-// TODO: REPORTER
-const { log } = console;
 export async function collectFiles(files) {
     const result = [];
     for (const filepath of files) {
         clearContext();
         await import(filepath);
-        const suites = [defaultSuite, ...context.suites];
-        const collected = [];
-        for (const suite of suites) {
-            context.currentSuite = suite;
-            const tasks = await suite.collect();
-            collected.push([suite, tasks]);
-        }
+        const collectors = [defaultSuite, ...context.suites];
+        const suites = [];
         const file = {
             filepath,
-            suites,
-            collected,
+            suites: [],
         };
-        file.collected.forEach(([, tasks]) => tasks.forEach(task => task.file = file));
+        for (const c of collectors) {
+            context.currentSuite = c;
+            suites.push(await c.collect(file));
+        }
+        file.suites = suites;
         result.push(file);
     }
     return result;
 }
-export async function runFile(file) {
+export async function runFile(file, ctx) {
+    var _a, _b, _c, _d;
+    const { reporter } = ctx;
+    await ((_a = reporter.onFileBegin) === null || _a === void 0 ? void 0 : _a.call(reporter, file, ctx));
     await beforeFileHook.fire(file);
-    for (const [suite, tasks] of file.collected) {
+    for (const suite of file.suites) {
+        await ((_b = reporter.onSuiteBegin) === null || _b === void 0 ? void 0 : _b.call(reporter, suite, ctx));
         await beforeSuiteHook.fire(suite);
-        let indent = 1;
-        if (suite.name) {
-            log(' '.repeat(indent * 2) + suite.name);
-            indent += 1;
-        }
-        if (suite.mode === 'run' || suite.mode === 'only') {
-            // TODO: If there is a task with 'only', skip all others
-            await runTasks(tasks);
-            for (const t of tasks) {
-                if (t.result && t.result.error === undefined) {
-                    log(`${' '.repeat(indent * 2)}${c.inverse(c.green(' PASS '))} ${c.green(t.name)}`);
-                }
-                else {
-                    console.error(`${' '.repeat(indent * 2)}${c.inverse(c.red(' FAIL '))} ${c.red(t.name)}`);
-                    console.error(' '.repeat((indent + 2) * 2) + c.red(String(t.result.error)));
-                    process.exitCode = 1;
-                }
-            }
-        }
-        else if (suite.mode === 'skip') {
-            log(`${' '.repeat(indent * 2)}${c.inverse(c.gray(' SKIP '))}`);
-        }
-        else if (suite.mode === 'todo') {
-            // TODO: In Jest, these suites are collected and printed together at the end of the report
-            log(`${' '.repeat(indent * 2)}${c.inverse(c.gray(' TODO '))}`);
-        }
-        if (suite.name)
-            indent -= 1;
+        for (const t of suite.tasks)
+            await runTask(t, ctx);
         await afterSuiteHook.fire(suite);
+        await ((_c = reporter.onSuiteEnd) === null || _c === void 0 ? void 0 : _c.call(reporter, suite, 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;
     chai.use(await SnapshotPlugin({
         rootDir,
@@ -98,22 +82,22 @@ export async function run(options = {}) {
         process.exitCode = 1;
         return;
     }
+    const reporter = new DefaultReporter();
+    await ((_a = reporter.onStart) === null || _a === void 0 ? void 0 : _a.call(reporter, options));
     const files = await collectFiles(paths);
+    const ctx = {
+        files,
+        mode: isOnlyMode(files) ? 'only' : 'all',
+        userOptions: options,
+        reporter,
+    };
+    await ((_b = reporter.onCollected) === null || _b === void 0 ? void 0 : _b.call(reporter, ctx));
     await beforeAllHook.fire();
-    const start = performance.now();
-    for (const file of files) {
-        log(`${relative(process.cwd(), file.filepath)}`);
-        await runFile(file);
-        log();
-    }
-    const end = performance.now();
+    for (const file of files)
+        await runFile(file, ctx);
     await afterAllHook.fire();
-    const tasks = files.reduce((acc, file) => acc.concat(file.collected.flatMap(([, tasks]) => tasks)), []);
-    const passed = tasks.filter(i => { var _a; return !((_a = i.result) === null || _a === void 0 ? void 0 : _a.error); });
-    const failed = tasks.filter(i => { var _a; return (_a = i.result) === null || _a === void 0 ? void 0 : _a.error; });
-    log(`Passed   ${passed.length} / ${tasks.length}`);
-    if (failed.length)
-        log(`Failed   ${failed.length} / ${tasks.length}`);
-    log(`Time     ${(end - start).toFixed(2)}ms`);
-    log();
+    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')));
 }

package/dist/suite.d.ts

@@ -1,12 +1,22 @@
-import { Suite, TestFactory } from './types';
-export declare const defaultSuite: Suite;
-export declare const test: (name: string, fn: () => Promise<void> | void) => void;
-export declare function clearContext(): void;
-export declare function suite(suiteName: string, factory?: TestFactory): Suite;
+import { SuiteCollector, TestFactory, TestFunction } from './types';
+export declare const defaultSuite: SuiteCollector;
+export declare const test: {
+    (name: string, fn: TestFunction): void;
+    skip(name: string, fn: TestFunction): void;
+    only(name: string, fn: TestFunction): void;
+    todo(name: string): void;
+};
+export declare function suite(suiteName: string, factory?: TestFactory): SuiteCollector;
 export declare namespace suite {
-    var skip: (suiteName: string, factory?: TestFactory | undefined) => Suite;
-    var only: (suiteName: string, factory?: TestFactory | undefined) => Suite;
-    var todo: (suiteName: string) => Suite;
+    var skip: (suiteName: string, factory?: TestFactory | undefined) => SuiteCollector;
+    var only: (suiteName: string, factory?: TestFactory | undefined) => SuiteCollector;
+    var todo: (suiteName: string) => SuiteCollector;
 }
 export declare const describe: typeof suite;
-export declare const it: (name: string, fn: () => Promise<void> | void) => void;
+export declare const it: {
+    (name: string, fn: TestFunction): void;
+    skip(name: string, fn: TestFunction): void;
+    only(name: string, fn: TestFunction): void;
+    todo(name: string): void;
+};
+export declare function clearContext(): void;

package/dist/suite.js

@@ -1,55 +1,75 @@
 import { context } from './context';
 export const defaultSuite = suite('');
-export const test = (name, fn) => (context.currentSuite || defaultSuite).test(name, fn);
-export function clearContext() {
-    context.suites.length = 0;
-    defaultSuite.clear();
-    context.currentSuite = defaultSuite;
+function getCurrentSuite() {
+    return context.currentSuite || defaultSuite;
 }
-function processSuite(mode, suiteName, factory) {
+export const test = (name, fn) => getCurrentSuite().test(name, fn);
+test.skip = (name, fn) => getCurrentSuite().test.skip(name, fn);
+test.only = (name, fn) => getCurrentSuite().test.only(name, fn);
+test.todo = (name) => getCurrentSuite().test.todo(name);
+function createSuiteCollector(mode, suiteName, factory) {
     const queue = [];
     const factoryQueue = [];
-    const suite = {
+    const collector = {
         name: suiteName,
         mode,
         test,
         collect,
         clear,
     };
-    function test(name, fn) {
-        const task = {
-            suite,
+    function collectTask(name, fn, mode) {
+        queue.push({
             name,
+            mode,
+            suite: {},
+            status: 'init',
             fn,
-        };
-        queue.push(task);
+        });
+    }
+    function test(name, fn) {
+        collectTask(name, fn, mode);
     }
+    test.skip = (name, fn) => collectTask(name, fn, 'skip');
+    test.only = (name, fn) => collectTask(name, fn, 'only');
+    test.todo = (name) => collectTask(name, () => { }, 'todo');
     function clear() {
         queue.length = 0;
         factoryQueue.length = 0;
     }
-    async function collect() {
+    async function collect(file) {
         factoryQueue.length = 0;
         if (factory)
             await factory(test);
-        return [...factoryQueue, ...queue];
+        const tasks = [...factoryQueue, ...queue];
+        const suite = {
+            name: collector.name,
+            mode: collector.mode,
+            tasks,
+            file,
+        };
+        tasks.forEach((task) => {
+            task.suite = suite;
+            if (file)
+                task.file = file;
+        });
+        return suite;
     }
-    context.currentSuite = suite;
-    context.suites.push(suite);
-    return suite;
+    context.currentSuite = collector;
+    context.suites.push(collector);
+    return collector;
 }
 export function suite(suiteName, factory) {
-    return processSuite('run', suiteName, factory);
+    return createSuiteCollector('run', suiteName, factory);
 }
-suite.skip = function skip(suiteName, factory) {
-    return processSuite('skip', suiteName, factory);
-};
-suite.only = function skip(suiteName, factory) {
-    return processSuite('only', suiteName, factory);
-};
-suite.todo = function skip(suiteName) {
-    return processSuite('todo', suiteName);
-};
+suite.skip = (suiteName, factory) => createSuiteCollector('skip', suiteName, factory);
+suite.only = (suiteName, factory) => createSuiteCollector('only', suiteName, factory);
+suite.todo = (suiteName) => createSuiteCollector('todo', suiteName);
 // alias
 export const describe = suite;
 export const it = test;
+// utils
+export function clearContext() {
+    context.suites.length = 0;
+    defaultSuite.clear();
+    context.currentSuite = defaultSuite;
+}

package/dist/types.d.ts

@@ -1,3 +1,4 @@
+export declare type Awaitable<T> = Promise<T> | T;
 export interface UserOptions {
     includes?: string[];
     excludes?: string[];
@@ -6,31 +7,61 @@ export interface Options extends UserOptions {
     rootDir?: string;
     updateSnapshot?: boolean;
 }
-export interface TaskResult {
-    error?: unknown;
-}
+export declare type RunMode = 'run' | 'skip' | 'only' | 'todo';
+export declare type TaskStatus = 'init' | 'pass' | 'fail' | 'skip' | 'todo';
 export interface Task {
     name: string;
+    mode: RunMode;
     suite: Suite;
-    fn: () => Promise<void> | void;
+    fn: () => Awaitable<void>;
     file?: File;
-    result?: TaskResult;
+    status: TaskStatus;
+    error?: unknown;
+}
+export declare type TestFunction = () => Awaitable<void>;
+export interface TestCollector {
+    (name: string, fn: TestFunction): void;
+    only: (name: string, fn: TestFunction) => void;
+    skip: (name: string, fn: TestFunction) => void;
+    todo: (name: string) => void;
 }
-export declare type SuiteMode = 'run' | 'skip' | 'only' | 'todo';
 export interface Suite {
     name: string;
-    mode: SuiteMode;
-    test: (name: string, fn: () => Promise<void> | void) => void;
-    collect: () => Promise<Task[]>;
+    mode: RunMode;
+    tasks: Task[];
+    file?: File;
+}
+export interface SuiteCollector {
+    name: string;
+    mode: RunMode;
+    test: TestCollector;
+    collect: (file?: File) => Promise<Suite>;
     clear: () => void;
 }
-export declare type TestFactory = (test: Suite['test']) => Promise<void> | void;
+export declare type TestFactory = (test: (name: string, fn: TestFunction) => void) => Awaitable<void>;
 export interface File {
     filepath: string;
     suites: Suite[];
-    collected: [Suite, Task[]][];
+}
+export interface RunnerContext {
+    files: File[];
+    mode: 'all' | 'only';
+    userOptions: Options;
+    reporter: Reporter;
 }
 export interface GlobalContext {
-    suites: Suite[];
-    currentSuite: Suite | null;
+    suites: SuiteCollector[];
+    currentSuite: SuiteCollector | null;
+}
+export interface Reporter {
+    onStart: (userOptions: Options) => Awaitable<void>;
+    onCollected: (ctx: RunnerContext) => Awaitable<void>;
+    onFinished: (ctx: RunnerContext) => Awaitable<void>;
+    onSuiteBegin: (suite: Suite, ctx: RunnerContext) => Awaitable<void>;
+    onSuiteEnd: (suite: Suite, ctx: RunnerContext) => Awaitable<void>;
+    onFileBegin: (file: File, ctx: RunnerContext) => Awaitable<void>;
+    onFileEnd: (file: File, ctx: RunnerContext) => Awaitable<void>;
+    onTaskBegin: (task: Task, ctx: RunnerContext) => Awaitable<void>;
+    onTaskEnd: (task: Task, ctx: RunnerContext) => Awaitable<void>;
+    onSnapshotUpdate: () => Awaitable<void>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vitest",
-  "version": "0.0.7",
+  "version": "0.0.8",
   "type": "module",
   "description": "",
   "keywords": [],
@@ -53,7 +53,7 @@
     "jest-util": "^27.4.2",
     "minimist": "^1.2.5",
     "picocolors": "^1.0.0",
-    "vite-node": "^0.1.9"
+    "vite-node": "^0.1.10"
   },
   "scripts": {
     "build": "tsc",