vitest 0.0.21 → 0.0.25

package/README.gh.md

@@ -0,0 +1,212 @@
+# 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.**<br>
+> 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.
+
+> ⚠️ **DISCLAIMER**: Vitest is still in development and not stable yet. It's not recommended to use it in production.
+
+## 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"
+    ]
+  }
+}
+```
+
+## Browser Mocking
+
+Pass `--jsdom` option in CLI to enable browser mocking. Or the `jsdom` flag in the config.
+
+```ts
+// vite.config.ts
+import { defineConfig } from 'vite'
+
+export default defineConfig({
+  test: {
+    jsdom: true
+  }
+})
+```
+
+## Watch Mode
+
+```bash
+$ vitest -w
+```
+
+Vitest will smartly search for the module graph to only rerun the related tests.
+
+## 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>
+
+## Credits
+
+Thanks to:
+
+- [@patak-js](https://github.com/patak-js) for the awesome package name!
+- [The Vite team](https://github.com/vitejs/vite) for brainstorming the initial idea.
+- [@pi0](https://github.com/pi0) for the idea and implementation of using Vite to transform and bundle the server code.
+- [@lukeed](https://github.com/lukeed) for the work on [uvu](https://github.com/lukeed/uvu) where we are inspired a lot from.
+
+## License
+
+[MIT](./LICENSE) License © 2021 [Anthony Fu](https://github.com/antfu)

package/README.md

@@ -2,174 +2,7 @@
 
 [![NPM version](https://img.shields.io/npm/v/vitest?color=a1b858&label=)](https://www.npmjs.com/package/vitest)
 
-A blazing fast test runner powered by Vite.
+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
-- [ ] Parallel Executing
-- [ ] CLI Help (Use yargs)
-- [x] JSDom
-- [ ] 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.**<br>
+> 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.**<br>
+> 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/entry.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/integrations/chai/setup.d.ts

@@ -1,2 +1,2 @@
-import { Config } from 'vitest';
-export declare function setupChai(config: Config): Promise<void>;
+import { ResolvedConfig } from 'vitest';
+export declare function setupChai(config: ResolvedConfig): Promise<void>;

package/dist/integrations/chai/setup.js

@@ -5,8 +5,5 @@ import { SnapshotPlugin } from './snapshot';
 export async function setupChai(config) {
     chai.use(SinonChai);
     chai.use(JestChaiExpect());
-    chai.use(await SnapshotPlugin({
-        rootDir: config.rootDir || process.cwd(),
-        update: config.updateSnapshot,
-    }));
+    chai.use(await SnapshotPlugin(config));
 }

package/dist/integrations/chai/snapshot/index.d.ts

@@ -1,7 +1,7 @@
 import { ChaiPlugin } from '../types';
 import { SnapshotManager } from './manager';
 export interface SnapshotOptions {
-    rootDir: string;
+    root: string;
     update?: boolean;
 }
 export declare function getSnapshotManager(): SnapshotManager;

package/dist/integrations/chai/snapshot/index.js

@@ -6,7 +6,7 @@ export function getSnapshotManager() {
     return _manager;
 }
 export async function SnapshotPlugin(options) {
-    const { rootDir } = options;
+    const { root: rootDir } = options;
     _manager = new SnapshotManager({
         rootDir,
         update: options.update,

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/node/cli.d.ts

@@ -0,0 +1,10 @@
+import type { UserOptions } from '../types';
+declare global {
+    namespace NodeJS {
+        interface Process {
+            __vitest__: {
+                options: Required<UserOptions>;
+            };
+        }
+    }
+}

package/dist/node/cli.js

@@ -0,0 +1,60 @@
+/* eslint-disable no-console */
+import { fileURLToPath } from 'url';
+import { resolve, dirname } from 'path';
+import { findUp } from 'find-up';
+import sade from 'sade';
+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)
+    .version(version)
+    .describe('A blazing fast unit test framework powered by Vite.')
+    .option('-r, --root', 'root path', process.cwd())
+    .option('-c, --config', 'path to config file')
+    .option('-w, --watch', 'watch mode', false)
+    .option('-u, --update', 'update snapshot', false)
+    .option('--global', 'inject apis globally', false)
+    .option('--dev', 'dev mode', false)
+    .option('--jsdom', 'mock browser api using JSDOM', false)
+    .action(async (filters, options) => {
+    process.env.VITEST = 'true';
+    const __dirname = dirname(fileURLToPath(import.meta.url));
+    const root = resolve(options.root || process.cwd());
+    const configPath = options.config
+        ? resolve(root, options.config)
+        : await findUp(['vitest.config.ts', 'vitest.config.js', 'vitest.config.mjs', 'vite.config.ts', 'vite.config.js', 'vite.config.mjs'], { cwd: root });
+    options.config = configPath;
+    options.root = root;
+    options.filters = filters
+        ? Array.isArray(filters)
+            ? filters
+            : [filters]
+        : undefined;
+    process.__vitest__ = {
+        options,
+    };
+    await startViteNode({
+        root,
+        files: [
+            resolve(__dirname, options.dev ? '../../src/node/entry.ts' : './entry.js'),
+        ],
+        config: configPath,
+        defaultConfig: {
+            optimizeDeps: {
+                exclude: [
+                    'vitest',
+                ],
+            },
+        },
+        shouldExternalize(id) {
+            if (id.includes('/node_modules/vitest/'))
+                return false;
+            else
+                return id.includes('/node_modules/');
+        },
+    });
+})
+    .parse(process.argv);

package/dist/node/entry.js

@@ -0,0 +1,6 @@
+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 || {};
+const cliOptions = process.__vitest__.options || {};
+await run(Object.assign(Object.assign({}, inlineOptions), cliOptions));

package/dist/node/node.d.ts

@@ -0,0 +1,22 @@
+import { InlineConfig, ViteDevServer } from 'vite';
+declare global {
+    namespace NodeJS {
+        interface Process {
+            __vite_node__: {
+                server: ViteDevServer;
+                watch?: boolean;
+                moduleCache: Map<string, Promise<any>>;
+            };
+        }
+    }
+}
+export interface ViteNodeOptions {
+    silent?: boolean;
+    root: string;
+    files: string[];
+    _?: string[];
+    shouldExternalize?: (file: string) => boolean;
+    config?: string;
+    defaultConfig?: InlineConfig;
+}
+export declare function run(argv: ViteNodeOptions): Promise<void>;