vitest 0.0.20 → 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

@@ -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.**
+> 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/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/integrations/jsdom/keys.js

@@ -1,130 +1,163 @@
 // SEE https://github.com/jsdom/jsdom/blob/master/lib/jsdom/living/interfaces.js
 const LIVING_KEYS = [
     'DOMException',
+    'URL',
+    'URLSearchParams',
+    'EventTarget',
     'NamedNodeMap',
-    'Attr',
     'Node',
+    'Attr',
     'Element',
     'DocumentFragment',
-    'HTMLDocument',
+    'DOMImplementation',
     'Document',
+    'XMLDocument',
     'CharacterData',
+    'Text',
+    'CDATASection',
+    'ProcessingInstruction',
     'Comment',
     'DocumentType',
-    'DOMImplementation',
-    'ProcessingInstruction',
-    'Image',
-    'Text',
-    'Event',
-    'CustomEvent',
-    'MessageEvent',
-    'ErrorEvent',
-    'HashChangeEvent',
-    'PopStateEvent',
-    'UIEvent',
-    'MouseEvent',
-    'KeyboardEvent',
-    'TouchEvent',
-    'ProgressEvent',
-    'EventTarget',
-    'Location',
-    'History',
+    'NodeList',
+    'HTMLCollection',
+    'HTMLOptionsCollection',
+    'DOMStringMap',
+    'DOMTokenList',
+    'StyleSheetList',
     'HTMLElement',
-    'HTMLAnchorElement',
-    'HTMLAppletElement',
-    'HTMLAreaElement',
-    'HTMLAudioElement',
+    'HTMLHeadElement',
+    'HTMLTitleElement',
     'HTMLBaseElement',
+    'HTMLLinkElement',
+    'HTMLMetaElement',
+    'HTMLStyleElement',
     'HTMLBodyElement',
+    'HTMLHeadingElement',
+    'HTMLParagraphElement',
+    'HTMLHRElement',
+    'HTMLPreElement',
+    'HTMLUListElement',
+    'HTMLOListElement',
+    'HTMLLIElement',
+    'HTMLMenuElement',
+    'HTMLDListElement',
+    'HTMLDivElement',
+    'HTMLAnchorElement',
+    'HTMLAreaElement',
     'HTMLBRElement',
     'HTMLButtonElement',
     'HTMLCanvasElement',
     'HTMLDataElement',
     'HTMLDataListElement',
+    'HTMLDetailsElement',
     'HTMLDialogElement',
     'HTMLDirectoryElement',
-    'HTMLDivElement',
-    'HTMLDListElement',
-    'HTMLEmbedElement',
     'HTMLFieldSetElement',
     'HTMLFontElement',
     'HTMLFormElement',
-    'HTMLFrameElement',
-    'HTMLFrameSetElement',
-    'HTMLHeadingElement',
-    'HTMLHeadElement',
-    'HTMLHRElement',
     'HTMLHtmlElement',
-    'HTMLIFrameElement',
     'HTMLImageElement',
     'HTMLInputElement',
     'HTMLLabelElement',
     'HTMLLegendElement',
-    'HTMLLIElement',
-    'HTMLLinkElement',
     'HTMLMapElement',
+    'HTMLMarqueeElement',
     'HTMLMediaElement',
-    'HTMLMenuElement',
-    'HTMLMetaElement',
     'HTMLMeterElement',
     'HTMLModElement',
-    'HTMLObjectElement',
-    'HTMLOListElement',
     'HTMLOptGroupElement',
     'HTMLOptionElement',
     'HTMLOutputElement',
-    'HTMLParagraphElement',
-    'HTMLParamElement',
-    'HTMLPreElement',
+    'HTMLPictureElement',
     'HTMLProgressElement',
     'HTMLQuoteElement',
     'HTMLScriptElement',
     'HTMLSelectElement',
+    'HTMLSlotElement',
     'HTMLSourceElement',
     'HTMLSpanElement',
-    'HTMLStyleElement',
     'HTMLTableCaptionElement',
     'HTMLTableCellElement',
     'HTMLTableColElement',
-    'HTMLTableDataCellElement',
     'HTMLTableElement',
-    'HTMLTableHeaderCellElement',
     'HTMLTimeElement',
-    'HTMLTitleElement',
     'HTMLTableRowElement',
     'HTMLTableSectionElement',
     'HTMLTemplateElement',
     'HTMLTextAreaElement',
-    'HTMLTrackElement',
-    'HTMLUListElement',
     'HTMLUnknownElement',
+    'HTMLFrameElement',
+    'HTMLFrameSetElement',
+    'HTMLIFrameElement',
+    'HTMLEmbedElement',
+    'HTMLObjectElement',
+    'HTMLParamElement',
     'HTMLVideoElement',
-    'StyleSheet',
-    'MediaList',
-    'CSSStyleSheet',
-    'CSSRule',
-    'CSSStyleRule',
-    'CSSMediaRule',
-    'CSSImportRule',
-    'CSSStyleDeclaration',
-    'StyleSheetList',
-    'XPathException',
-    'XPathExpression',
-    'XPathResult',
-    'XPathEvaluator',
-    'HTMLCollection',
-    'NodeFilter',
-    'NodeIterator',
-    'NodeList',
+    'HTMLAudioElement',
+    'HTMLTrackElement',
+    'SVGElement',
+    'SVGGraphicsElement',
+    'SVGSVGElement',
+    'SVGTitleElement',
+    'SVGAnimatedString',
+    'SVGNumber',
+    'SVGStringList',
+    'Event',
+    'CloseEvent',
+    'CustomEvent',
+    'MessageEvent',
+    'ErrorEvent',
+    'HashChangeEvent',
+    'PopStateEvent',
+    'StorageEvent',
+    'ProgressEvent',
+    'PageTransitionEvent',
+    'UIEvent',
+    'FocusEvent',
+    'InputEvent',
+    'MouseEvent',
+    'KeyboardEvent',
+    'TouchEvent',
+    'CompositionEvent',
+    'WheelEvent',
+    'BarProp',
+    'External',
+    'Location',
+    'History',
+    'Screen',
+    'Performance',
+    'Navigator',
+    'PluginArray',
+    'MimeTypeArray',
+    'Plugin',
+    'MimeType',
+    'FileReader',
     'Blob',
     'File',
     'FileList',
+    'ValidityState',
+    'DOMParser',
+    'XMLSerializer',
     'FormData',
-    'XMLHttpRequest',
     'XMLHttpRequestEventTarget',
     'XMLHttpRequestUpload',
-    'DOMTokenList',
-    'URL',
+    'XMLHttpRequest',
+    'WebSocket',
+    'NodeFilter',
+    'NodeIterator',
+    'TreeWalker',
+    'AbstractRange',
+    'Range',
+    'StaticRange',
+    'Selection',
+    'Storage',
+    'CustomElementRegistry',
+    'ShadowRoot',
+    'MutationObserver',
+    'MutationRecord',
+    'Headers',
+    'AbortController',
+    'AbortSignal',
 ];
 const OTHER_KEYS = [
     'addEventListener',

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>;
+            };
+        }
+    }
+}