vitest 0.0.11 → 0.0.12

package/README.md

@@ -37,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
@@ -103,10 +124,12 @@ describe('suite', () => {
 - [x] Reporter & Better output
 - [x] Task filter
 - [x] Mock
+- [ ] Global Mode & Types
 - [ ] Parallel Executing
 - [ ] CLI Help
 - [ ] 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/index.d.ts

@@ -5,4 +5,4 @@ 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;
+export declare const mock: sinon.SinonMockStatic, spy: sinon.SinonSpyStatic, stub: sinon.SinonStubStatic;

package/dist/index.js

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

package/dist/reporters/default.js

@@ -48,13 +48,13 @@ export class DefaultReporter {
         var _a;
         // @ts-expect-error
         (_a = task.__ora) === null || _a === void 0 ? void 0 : _a.stop();
-        if (task.status === 'pass') {
+        if (task.state === 'pass') {
             this.log(`${c.green(CHECK + task.name)}`);
         }
-        else if (task.status === 'skip') {
+        else if (task.state === 'skip') {
             this.log(c.dim(c.yellow(`${DOT + task.name} (skipped)`)));
         }
-        else if (task.status === 'todo') {
+        else if (task.state === 'todo') {
             this.log(c.dim(`${DOT + task.name} (todo)`));
         }
         else {
@@ -67,10 +67,11 @@ export class DefaultReporter {
         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 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');
+        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:`));
@@ -89,9 +90,9 @@ export class DefaultReporter {
                 this.log();
             });
         }
-        this.log(c.green(`Passed   ${passed.length} / ${tasks.length}`));
+        this.log(c.green(`Passed   ${passed.length} / ${runable.length}`));
         if (failed.length)
-            this.log(c.red(`Failed   ${failed.length} / ${tasks.length}`));
+            this.log(c.red(`Failed   ${failed.length} / ${runable.length}`));
         if (skipped.length)
             this.log(c.yellow(`Skipped  ${skipped.length}`));
         if (todo.length)

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

@@ -11,29 +11,23 @@ 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) {
+export async function collectFiles(paths) {
+    const files = [];
+    for (const filepath of paths) {
         const file = {
             filepath,
             suites: [],
@@ -54,13 +48,37 @@ export async function collectFiles(files) {
             file.collected = false;
             process.exitCode = 1;
         }
-        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) {
@@ -74,42 +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,
     }));
     chai.use(SinonChai);
     // collect files
-    const paths = await fg(options.includes || defaultIncludes, {
+    let paths = await fg(config.includes || defaultIncludes, {
         absolute: true,
-        cwd: options.rootDir,
-        ignore: options.excludes || defaultExcludes,
+        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>;
@@ -47,8 +51,7 @@ export interface File {
 }
 export interface RunnerContext {
     files: File[];
-    mode: 'all' | 'only';
-    userOptions: Options;
+    config: Config;
     reporter: Reporter;
 }
 export interface GlobalContext {
@@ -56,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.11",
+  "version": "0.0.12",
   "type": "module",
   "description": "",
   "keywords": [],
@@ -32,15 +32,6 @@
   "bin": {
     "vitest": "./bin/vitest.mjs"
   },
-  "scripts": {
-    "build": "tsc",
-    "watch": "tsc --watch",
-    "lint": "eslint \"{src,test}/**/*.ts\"",
-    "prepublishOnly": "nr build",
-    "release": "bumpp --commit --push --tag && pnpm publish",
-    "test": "node bin/vitest.mjs --dev",
-    "test:update": "nr test -u"
-  },
   "devDependencies": {
     "@antfu/eslint-config": "^0.11.1",
     "@antfu/ni": "^0.11.0",
@@ -68,5 +59,13 @@
     "sinon": "^12.0.1",
     "sinon-chai": "^3.7.0",
     "vite-node": "^0.1.10"
+  },
+  "scripts": {
+    "build": "tsc",
+    "watch": "tsc --watch",
+    "lint": "eslint \"{src,test}/**/*.ts\"",
+    "release": "bumpp --commit --push --tag && pnpm publish",
+    "test": "node bin/vitest.mjs --dev",
+    "test:update": "nr test -u"
   }
-}
+}