vitest 0.0.23 → 0.0.24

package/README.gh.md

@@ -0,0 +1,178 @@
+# vitest
+
+[![NPM version](https://img.shields.io/npm/v/vitest?color=a1b858&label=)](https://www.npmjs.com/package/vitest)
+
+A blazing fast unit test framework powered by Vite.
+
+> **This project is currently in closed beta exclusively for Sponsors.**
+> Become a Sponsor of [@patak-js](https://github.com/sponsors/patak-js) or [@antfu](https://github.com/sponsors/antfu) to access the source code and issues tracker.
+
+## Features
+
+- [Vite](https://vitejs.dev/)'s config, transformers, resolvers, and plugins.
+- [Jest Snapshot](https://jestjs.io/docs/snapshot-testing)
+- [Chai](https://www.chaijs.com/) for assertions
+- [Sinon](https://sinonjs.org/) for mocking
+- [JSDOM](https://github.com/jsdom/jsdom) for DOM 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'
+
+describe('suite name', () => {
+  it('foo', () => {
+    expect(1 + 1).toEqual(2)
+    expect(true).to.be.true
+  })
+
+  it('bar', () => {
+    assert.equal(Math.sqrt(4), 2)
+  })
+
+  it('snapshot', () => {
+    expect({ foo: 'bar' }).toMatchSnapshot()
+  })
+})
+```
+
+```bash
+$ 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: {
+    // ...
+  }
+})
+```
+
+## Global APIs
+
+By default, `vitest` does not provide global APIs for explicitness. If you prefer to use the APIs globally like Jest, you can pass the `--global` option to CLI or add `global: true` in the config.
+
+```ts
+// vite.config.ts
+import { defineConfig } from 'vite'
+
+export default defineConfig({
+  test: {
+    global: true
+  }
+})
+```
+
+To get TypeScript working with the global APIs, add `vitest/global` to the `types` filed in your `tsconfig.json`
+
+```json
+// tsconfig.json
+{
+  "compilerOptions": {
+    "types": [
+      "vitest/global"
+    ]
+  }
+}
+```
+
+## 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', () => {
+  it.todo('unimplemented task')
+})
+```
+
+## TODO
+
+- [x] Reporter & Better output
+- [x] Task filter
+- [x] Mock
+- [x] Global Mode & Types
+- [ ] Parallel Executing
+- [x] CLI Help
+- [x] JSDom
+- [x] Watch
+- [ ] Source Map
+- [ ] Coverage
+
+## Sponsors
+
+<p align="center">
+  <a href="https://cdn.jsdelivr.net/gh/antfu/static/sponsors.svg">
+    <img src='https://cdn.jsdelivr.net/gh/antfu/static/sponsors.svg'/>
+  </a>
+</p>
+
+## License
+
+[MIT](./LICENSE) License © 2021 [Anthony Fu](https://github.com/antfu)

package/README.md

@@ -4,172 +4,5 @@
 
 A blazing fast unit test framework powered by Vite.
 
-## Features
-
-- [Vite](https://vitejs.dev/)'s config, transformers, resolvers, and plugins.
-- [Jest Snapshot](https://jestjs.io/docs/snapshot-testing)
-- [Chai](https://www.chaijs.com/) for assertions
-- [Sinon](https://sinonjs.org/) for mocking
-- [JSDOM](https://github.com/jsdom/jsdom) for DOM 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'
-
-describe('suite name', () => {
-  it('foo', () => {
-    expect(1 + 1).toEqual(2)
-    expect(true).to.be.true
-  })
-
-  it('bar', () => {
-    assert.equal(Math.sqrt(4), 2)
-  })
-
-  it('snapshot', () => {
-    expect({ foo: 'bar' }).toMatchSnapshot()
-  })
-})
-```
-
-```bash
-$ 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: {
-    // ...
-  }
-})
-```
-
-## Global APIs
-
-By default, `vitest` does not provide global APIs for explicitness. If you prefer to use the APIs globally like Jest, you can pass the `--global` option to CLI or add `global: true` in the config.
-
-```ts
-// vite.config.ts
-import { defineConfig } from 'vite'
-
-export default defineConfig({
-  test: {
-    global: true
-  }
-})
-```
-
-To get TypeScript working with the global APIs, add `vitest/global` to the `types` filed in your `tsconfig.json`
-
-```json
-// tsconfig.json
-{
-  "compilerOptions": {
-    "types": [
-      "vitest/global"
-    ]
-  }
-}
-```
-
-## 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', () => {
-  it.todo('unimplemented task')
-})
-```
-
-## TODO
-
-- [x] Reporter & Better output
-- [x] Task filter
-- [x] Mock
-- [x] Global Mode & Types
-- [ ] Concurrent Executing
-- [x] CLI Help
-- [x] JSDom
-- [x] Watch
-- [ ] Source Map
-- [ ] Coverage
-
-## Sponsors
-
-<p align="center">
-  <a href="https://cdn.jsdelivr.net/gh/antfu/static/sponsors.svg">
-    <img src='https://cdn.jsdelivr.net/gh/antfu/static/sponsors.svg'/>
-  </a>
-</p>
-
-## License
-
-[MIT](./LICENSE) License © 2021 [Anthony Fu](https://github.com/antfu)
+> **This project is currently in closed beta exclusively for Sponsors.**
+> Become a Sponsor of [@patak-js](https://github.com/sponsors/patak-js) or [@antfu](https://github.com/sponsors/antfu) to access the source code and issues tracker.

package/README.npm.md

@@ -0,0 +1,8 @@
+# vitest
+
+[![NPM version](https://img.shields.io/npm/v/vitest?color=a1b858&label=)](https://www.npmjs.com/package/vitest)
+
+A blazing fast unit test framework powered by Vite.
+
+> **This project is currently in closed beta exclusively for Sponsors.**
+> Become a Sponsor of [@patak-js](https://github.com/sponsors/patak-js) or [@antfu](https://github.com/sponsors/antfu) to access the source code and issues tracker.

package/bin/vitest.mjs

@@ -1,4 +1,4 @@
 #!/usr/bin/env node
 'use strict'
 
-import '../dist/cli.js'
+import '../dist/node/cli.js'

package/dist/index.d.ts

@@ -1,8 +1,16 @@
+import { UserOptions } from './types';
 export * from './types';
 export * from './suite';
-export * from './config';
 export * from './integrations/chai';
 export * from './integrations/sinon';
+declare module 'vite' {
+    interface UserConfig {
+        /**
+         * Options for Vitest
+         */
+        test?: UserOptions;
+    }
+}
 declare global {
     namespace Chai {
         interface Assertion {

package/dist/index.js

@@ -1,6 +1,4 @@
-/* eslint-disable @typescript-eslint/no-namespace */
 export * from './types';
 export * from './suite';
-export * from './config';
 export * from './integrations/chai';
 export * from './integrations/sinon';

package/dist/{global.js → integrations/global.js}

@@ -1,5 +1,5 @@
-import { globalApis } from './constants';
-import * as index from './index';
+import { globalApis } from '../constants';
+import * as index from '../index';
 export function registerApiGlobally() {
     globalApis.forEach((api) => {
         // @ts-expect-error

package/dist/{cli.d.ts → node/cli.d.ts}

@@ -1,4 +1,4 @@
-import type { UserOptions } from './types';
+import type { UserOptions } from '../types';
 declare global {
     namespace NodeJS {
         interface Process {

package/dist/{cli.js → node/cli.js}

@@ -1,8 +1,12 @@
+/* eslint-disable no-console */
 import { fileURLToPath } from 'url';
 import { resolve, dirname } from 'path';
 import { findUp } from 'find-up';
 import sade from 'sade';
-import { run as startViteNode } from './node/index.js';
+import c from 'picocolors';
+import { run as startViteNode } from './node.js';
+console.log(c.yellow(c.bold('\nVitest is currently in closed beta exclusively for Sponsors')));
+console.log(c.magenta(`Become a Sponsor of ${c.underline('https://github.com/sponsors/patak-js')} or ${c.underline('https://github.com/sponsors/antfu')} \nto access the source code and issues tracker 💖\n`));
 // TODO: use bundler
 const version = '0.0.0';
 sade('vitest [filter]', true)
@@ -35,7 +39,7 @@ sade('vitest [filter]', true)
     await startViteNode({
         root,
         files: [
-            resolve(__dirname, options.dev ? '../src/entry.ts' : './entry.js'),
+            resolve(__dirname, options.dev ? '../../src/node/entry.ts' : './entry.js'),
         ],
         config: configPath,
         defaultConfig: {

package/dist/{entry.js → node/entry.js}

@@ -1,4 +1,4 @@
-import { run } from './run';
+import { run } from '../run';
 if (!process.__vite_node__ || !process.__vitest__)
     throw new Error('Vitest can only run in vite-node environment, please use the CLI to start the process');
 const inlineOptions = process.__vite_node__.server.config.test || {};

package/dist/reporters/default.js

@@ -71,7 +71,7 @@ export class DefaultReporter {
         const { tasks, suites, files } = ctx;
         const failedFiles = files.filter(i => i.error);
         const failedSuites = suites.filter(i => i.error);
-        const runable = tasks.filter(i => i.state === 'pass' || i.state === 'fail');
+        const runnable = 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');
@@ -102,9 +102,9 @@ export class DefaultReporter {
                 console.log();
             });
         }
-        console.log(c.bold(c.green(`Passed   ${passed.length} / ${runable.length}`)));
+        console.log(c.bold(c.green(`Passed   ${passed.length} / ${runnable.length}`)));
         if (failed.length)
-            console.log(c.bold(c.red(`Failed   ${failed.length} / ${runable.length}`)));
+            console.log(c.bold(c.red(`Failed   ${failed.length} / ${runnable.length}`)));
         if (skipped.length)
             console.log(c.yellow(`Skipped  ${skipped.length}`));
         if (todo.length)

package/dist/run/index.d.ts

@@ -1,7 +1,7 @@
 import { File, ResolvedConfig, Task, RunnerContext, Suite } from '../types';
 export declare function runTask(task: Task, ctx: RunnerContext): Promise<void>;
 export declare function collectFiles(paths: string[]): Promise<Record<string, File>>;
-export declare function runSite(suite: Suite, ctx: RunnerContext): Promise<void>;
+export declare function runSuite(suite: Suite, ctx: RunnerContext): Promise<void>;
 export declare function runFile(file: File, ctx: RunnerContext): Promise<void>;
 export declare function runFiles(filesMap: Record<string, File>, ctx: RunnerContext): Promise<void>;
 export declare function run(config: ResolvedConfig): Promise<void>;

package/dist/run/index.js

@@ -65,9 +65,10 @@ export async function collectFiles(paths) {
     interpretOnlyMode(allSuites);
     allSuites.forEach((i) => {
         if (i.mode === 'skip')
-            i.tasks.forEach(t => t.mode === 'run' && (t.state = 'skip'));
+            i.tasks.forEach(t => t.mode === 'run' && (t.mode = 'skip'));
         else
             interpretOnlyMode(i.tasks);
+        i.tasks.forEach(t => t.mode === 'skip' && (t.state = 'skip'));
     });
     return files;
 }
@@ -84,7 +85,7 @@ function interpretOnlyMode(items) {
         });
     }
 }
-export async function runSite(suite, ctx) {
+export async function runSuite(suite, ctx) {
     var _a, _b;
     const { reporter } = ctx;
     await ((_a = reporter.onSuiteBegin) === null || _a === void 0 ? void 0 : _a.call(reporter, suite, ctx));
@@ -113,16 +114,16 @@ export async function runSite(suite, ctx) {
 export async function runFile(file, ctx) {
     var _a, _b;
     const { reporter } = ctx;
-    const runableSuites = file.suites.filter(i => i.mode === 'run');
-    if (runableSuites.length === 0)
+    const runnableSuites = file.suites.filter(i => i.mode === 'run');
+    if (runnableSuites.length === 0)
         return;
     await ((_a = reporter.onFileBegin) === null || _a === void 0 ? void 0 : _a.call(reporter, file, ctx));
     if (ctx.config.parallel) {
-        await Promise.all(file.suites.map(suite => runSite(suite, ctx)));
+        await Promise.all(file.suites.map(suite => runSuite(suite, ctx)));
     }
     else {
         for (const suite of file.suites)
-            await runSite(suite, ctx);
+            await runSuite(suite, ctx);
     }
     await ((_b = reporter.onFileEnd) === null || _b === void 0 ? void 0 : _b.call(reporter, file, ctx));
 }
@@ -156,7 +157,7 @@ export async function run(config) {
     }
     // setup envs
     if (config.global)
-        (await import('../global')).registerApiGlobally();
+        (await import('../integrations/global')).registerApiGlobally();
     if (config.jsdom)
         (await import('../integrations/jsdom')).setupJSDOM(globalThis);
     const reporter = new DefaultReporter();
@@ -203,11 +204,11 @@ export async function startWatcher(ctx) {
         timer = setTimeout(async () => {
             var _a, _b, _c, _d;
             const snapshot = getSnapshotManager();
-            const pathes = Array.from(changedTests);
+            const paths = Array.from(changedTests);
             changedTests.clear();
-            await ((_b = (_a = ctx.reporter).onWatcherRerun) === null || _b === void 0 ? void 0 : _b.call(_a, pathes, id, ctx));
-            pathes.forEach(i => moduleCache.delete(i));
-            const files = await collectFiles(pathes);
+            await ((_b = (_a = ctx.reporter).onWatcherRerun) === null || _b === void 0 ? void 0 : _b.call(_a, paths, id, ctx));
+            paths.forEach(i => moduleCache.delete(i));
+            const files = await collectFiles(paths);
             Object.assign(ctx.filesMap, files);
             await runFiles(files, ctx);
             // TODO: clear snapshot state

package/dist/suite.js

@@ -32,12 +32,12 @@ function createSuiteCollector(name, factory = () => { }, mode) {
             name,
             mode,
             suite: {},
-            state: mode !== 'run' ? mode : undefined,
+            state: (mode !== 'run' && mode !== 'only') ? mode : undefined,
             fn,
         });
     }
     function test(name, fn) {
-        collectTask(name, fn, mode);
+        collectTask(name, fn, 'run');
     }
     test.skip = (name, fn) => collectTask(name, fn, 'skip');
     test.only = (name, fn) => collectTask(name, fn, 'only');

package/dist/types.d.ts

@@ -1,6 +1,15 @@
 export declare type Awaitable<T> = Promise<T> | T;
 export interface UserOptions {
+    /**
+     * Include globs for test files
+     *
+     * @default ['**\/*.test.ts']
+     */
     includes?: string[];
+    /**
+     * Exclude globs for test files
+     * @default ['**\/node_modules\/**']
+     */
     excludes?: string[];
     /**
      * Register apis globally

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vitest",
-  "version": "0.0.23",
+  "version": "0.0.24",
   "description": "A blazing fast unit test framework powered by Vite",
   "keywords": [
     "vite",
@@ -38,6 +38,16 @@
     "bin",
     "*.d.ts"
   ],
+  "scripts": {
+    "prepare": "esmo scripts/generate-types.ts",
+    "build": "rimraf dist && tsc -p src/tsconfig.json",
+    "lint": "eslint \"{src,test}/**/*.ts\"",
+    "prepublishOnly": "nr build",
+    "release": "bumpp --commit --push --tag && esmo scripts/publish.ts",
+    "test": "node bin/vitest.mjs --dev",
+    "test:update": "nr test -u",
+    "watch": "tsc -p src/tsconfig.json --watch"
+  },
   "dependencies": {
     "@jest/test-result": "^27.4.2",
     "@types/chai": "^4.2.22",
@@ -55,7 +65,7 @@
     "sinon-chai": "^3.7.0"
   },
   "devDependencies": {
-    "@antfu/eslint-config": "^0.11.1",
+    "@antfu/eslint-config": "^0.12.1",
     "@antfu/ni": "^0.11.0",
     "@types/jsdom": "^16.2.13",
     "@types/listr": "^0.14.4",
@@ -63,18 +73,10 @@
     "@types/sade": "^1.7.3",
     "@types/sinon": "^10.0.6",
     "bumpp": "^7.1.1",
-    "eslint": "^8.3.0",
+    "eslint": "^8.4.0",
     "esno": "^0.12.1",
     "rimraf": "^3.0.2",
     "typescript": "^4.5.2",
     "vite": "^2.6.14"
-  },
-  "scripts": {
-    "build": "rimraf dist && tsc -p src/tsconfig.json",
-    "lint": "eslint \"{src,test}/**/*.ts\"",
-    "release": "bumpp --commit --push --tag && pnpm publish",
-    "test": "node bin/vitest.mjs --dev",
-    "test:update": "nr test -u",
-    "watch": "tsc -p src/tsconfig.json --watch"
   }
-}
+}

package/dist/config.d.ts

@@ -1,17 +0,0 @@
-import { UserConfig } from 'vite';
-import { UserOptions } from './types';
-export interface VitestConfig extends UserConfig {
-    /**
-     * Options for Vitest
-     */
-    test?: UserOptions;
-}
-export declare function defineConfig(config: VitestConfig): VitestConfig;
-declare module 'vite' {
-    interface UserConfig {
-        /**
-         * Options for Vitest
-         */
-        test?: UserOptions;
-    }
-}

package/dist/config.js

@@ -1,3 +0,0 @@
-export function defineConfig(config) {
-    return config;
-}