vitest 0.0.12 → 0.0.13

package/README.md

@@ -58,6 +58,34 @@ export default defineConfig({
 })
 ```
 
+## 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
@@ -124,7 +152,7 @@ describe('suite', () => {
 - [x] Reporter & Better output
 - [x] Task filter
 - [x] Mock
-- [ ] Global Mode & Types
+- [x] Global Mode & Types
 - [ ] Parallel Executing
 - [ ] CLI Help
 - [ ] JSDom

package/bin/vitest.mjs

@@ -1,44 +1,4 @@
 #!/usr/bin/env node
 'use strict'
 
-import { fileURLToPath } from 'url'
-import { resolve, dirname } from 'path'
-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',
-  },
-  string: ['root', 'config'],
-  boolean: ['dev'],
-})
-
-const __dirname = dirname(fileURLToPath(import.meta.url))
-const root = resolve(argv.root || process.cwd())
-
-const configPath = argv.config ? resolve(root, argv.config) : await findUp(['vitest.config.ts', 'vitest.config.js', 'vitest.config.mjs', 'vite.config.ts', 'vite.config.js', 'vite.config.mjs'], { cwd: root })
-
-await run({
-  root,
-  files: [
-    resolve(__dirname, argv.dev ? '../src/cli.ts' : '../dist/cli.js'),
-  ],
-  config: configPath,
-  defaultConfig: {
-    optimizeDeps: {
-      exclude: [
-        'vitest',
-      ],
-    },
-  },
-  shouldExternalize(id) {
-    if (id.includes('/node_modules/vitest/'))
-      return false
-    else
-      return id.includes('/node_modules/')
-  },
-})
+import '../dist/cli.js'

package/dist/chai.d.ts

@@ -1,9 +1,18 @@
+import { Config } from 'vitest';
+export declare function setupChai(config: Config): Promise<void>;
 export { assert, should, expect } from 'chai';
 declare global {
     namespace Chai {
         interface Assertion {
             toMatchSnapshot(message?: string): Assertion;
             matchSnapshot(message?: string): Assertion;
+            toEqual(expected: any): void;
+            toStrictEqual(expected: any): void;
+            toContain(item: any): void;
+            toBeNaN(): void;
+            toBeUndefined(): void;
+            toBeNull(): void;
+            toBeDefined(): void;
         }
         interface ExpectStatic {
             addSnapshotSerializer: import('pretty-format').Plugin;

package/dist/chai.js

@@ -1 +1,37 @@
+import chai from 'chai';
+import SinonChai from 'sinon-chai';
+import { SnapshotPlugin } from './snapshot';
+export async function setupChai(config) {
+    chai.use(SinonChai);
+    chai.use(await SnapshotPlugin({
+        rootDir: config.rootDir || process.cwd(),
+        update: config.updateSnapshot,
+    }));
+    // Jest Compact
+    // TODO: add more https://jestjs.io/docs/expect
+    chai.use((chai, utils) => {
+        const proto = chai.Assertion.prototype;
+        utils.addMethod(proto, 'toEqual', function (expected) {
+            return this.eql(expected);
+        });
+        utils.addMethod(proto, 'toStrictEqual', function (expected) {
+            return this.equal(expected);
+        });
+        utils.addMethod(proto, 'toContain', function (item) {
+            return this.contain(item);
+        });
+        utils.addMethod(proto, 'toBeNaN', function () {
+            return this.be.NaN;
+        });
+        utils.addMethod(proto, 'toBeUndefined', function () {
+            return this.be.undefined;
+        });
+        utils.addMethod(proto, 'toBeNull', function () {
+            return this.be.null;
+        });
+        utils.addMethod(proto, 'toBeDefined', function () {
+            return this.not.be.undefined;
+        });
+    });
+}
 export { assert, should, expect } from 'chai';

package/dist/cli-entry.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/cli-entry.js

@@ -0,0 +1,28 @@
+var _a;
+import minimist from 'minimist';
+import c from 'picocolors';
+import { run } from './run';
+const { log } = console;
+const argv = minimist(process.argv.slice(2), {
+    alias: {
+        u: 'update',
+    },
+    string: ['root', 'config'],
+    boolean: ['update', 'dev', 'global'],
+    unknown(name) {
+        if (name[0] === '-') {
+            console.error(c.red(`Unknown argument: ${name}`));
+            help();
+            process.exit(1);
+        }
+        return true;
+    },
+});
+// @ts-expect-error
+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), { server, global: argv.global, updateSnapshot: argv.update, rootDir: argv.root || process.cwd(), nameFilters: argv._ }));
+function help() {
+    log('Help: finish help');
+}

package/dist/cli.js

@@ -1,28 +1,36 @@
-var _a;
+import { fileURLToPath } from 'url';
+import { resolve, dirname } from 'path';
 import minimist from 'minimist';
-import c from 'picocolors';
-import { run } from './run';
-const { log } = console;
+import { findUp } from 'find-up';
+import { run } from './node.js';
+process.env.VITEST = 'true';
 const argv = minimist(process.argv.slice(2), {
     alias: {
-        u: 'update',
+        c: 'config',
     },
     string: ['root', 'config'],
-    boolean: ['update', 'dev'],
-    unknown(name) {
-        if (name[0] === '-') {
-            console.error(c.red(`Unknown argument: ${name}`));
-            help();
-            process.exit(1);
-        }
-        return true;
+    boolean: ['dev'],
+});
+const __dirname = dirname(fileURLToPath(import.meta.url));
+const root = resolve(argv.root || process.cwd());
+const configPath = argv.config ? resolve(root, argv.config) : await findUp(['vitest.config.ts', 'vitest.config.js', 'vitest.config.mjs', 'vite.config.ts', 'vite.config.js', 'vite.config.mjs'], { cwd: root });
+await run({
+    root,
+    files: [
+        resolve(__dirname, argv.dev ? '../src/cli-entry.ts' : './cli-entry.js'),
+    ],
+    config: configPath,
+    defaultConfig: {
+        optimizeDeps: {
+            exclude: [
+                'vitest',
+            ],
+        },
+    },
+    shouldExternalize(id) {
+        if (id.includes('/node_modules/vitest/'))
+            return false;
+        else
+            return id.includes('/node_modules/');
     },
 });
-// @ts-expect-error
-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), { server, updateSnapshot: argv.update, rootDir: argv.root || process.cwd(), nameFilters: argv._ }));
-function help() {
-    log('Help: finish help');
-}

package/dist/constants.d.ts

@@ -1,2 +1,3 @@
 export declare const defaultIncludes: string[];
 export declare const defaultExcludes: string[];
+export declare const globalApis: string[];

package/dist/constants.js

@@ -1,2 +1,22 @@
 export const defaultIncludes = ['**/*.{test,spec}.{js,mjs,cjs,ts,mts,cts,jsx,tsx}'];
 export const defaultExcludes = ['**/node_modules/**', '**/dist/**'];
+export const globalApis = [
+    'suite',
+    'test',
+    'describe',
+    'it',
+    'expect',
+    'assert',
+    'spy',
+    'mock',
+    'stub',
+    'sinon',
+    'beforeAll',
+    'afterAll',
+    'beforeEach',
+    'afterEach',
+    'beforeFile',
+    'afterFile',
+    'beforeSuite',
+    'afterSuite',
+];

package/dist/global.d.ts

@@ -0,0 +1 @@
+export declare function registerApiGlobally(): void;

package/dist/global.js

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

package/dist/node.d.ts

@@ -0,0 +1,11 @@
+import { InlineConfig } from 'vite';
+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>;

package/dist/node.js

@@ -0,0 +1,126 @@
+import { builtinModules, createRequire } from 'module';
+import { pathToFileURL } from 'url';
+import { dirname, resolve, relative } from 'path';
+import vm from 'vm';
+import { createServer, mergeConfig } from 'vite';
+import c from 'picocolors';
+const { red, dim, yellow } = c;
+export async function run(argv) {
+    process.exitCode = 0;
+    const root = argv.root || process.cwd();
+    process.chdir(root);
+    const files = argv.files || argv._;
+    argv.shouldExternalize = argv.shouldExternalize || (id => id.includes('/node_modules/'));
+    const server = await createServer(mergeConfig(argv.defaultConfig || {}, {
+        logLevel: 'error',
+        clearScreen: false,
+        configFile: argv.config,
+        root,
+        resolve: {},
+    }));
+    await server.pluginContainer.buildStart({});
+    // @ts-expect-error
+    process.__vite_node__ = {
+        server,
+    };
+    try {
+        await execute(files, server, argv);
+    }
+    catch (e) {
+        process.exitCode = 1;
+        throw e;
+    }
+    finally {
+        await server.close();
+    }
+}
+function normalizeId(id) {
+    // Virtual modules start with `\0`
+    if (id && id.startsWith('/@id/__x00__'))
+        id = `\0${id.slice('/@id/__x00__'.length)}`;
+    if (id && id.startsWith('/@id/'))
+        id = id.slice('/@id/'.length);
+    return id;
+}
+function toFilePath(id, server) {
+    let absolute = id.startsWith('/@fs/')
+        ? id.slice(4)
+        : id.startsWith(dirname(server.config.root))
+            ? id
+            : slash(resolve(server.config.root, id.slice(1)));
+    if (absolute.startsWith('//'))
+        absolute = absolute.slice(1);
+    if (!absolute.startsWith('/'))
+        absolute = `/${absolute}`;
+    return absolute;
+}
+async function execute(files, server, options) {
+    const __pendingModules__ = new Map();
+    const result = [];
+    for (const file of files)
+        result.push(await cachedRequest(`/@fs/${slash(resolve(file))}`, []));
+    return result;
+    async function directRequest(rawId, callstack) {
+        if (builtinModules.includes(rawId))
+            return import(rawId);
+        callstack = [...callstack, rawId];
+        const request = async (dep) => {
+            if (callstack.includes(dep)) {
+                throw new Error(`${red('Circular dependency detected')}\nStack:\n${[...callstack, dep].reverse().map((i) => {
+                    const path = relative(server.config.root, toFilePath(normalizeId(i), server));
+                    return dim(' -> ') + (i === dep ? yellow(path) : path);
+                }).join('\n')}\n`);
+            }
+            return cachedRequest(dep, callstack);
+        };
+        const id = normalizeId(rawId);
+        const absolute = toFilePath(id, server);
+        if (options.shouldExternalize(absolute))
+            return import(absolute);
+        const result = await server.transformRequest(id, { ssr: true });
+        if (!result)
+            throw new Error(`failed to load ${id}`);
+        const url = pathToFileURL(absolute);
+        const exports = {};
+        const context = {
+            require: createRequire(url),
+            __filename: absolute,
+            __dirname: dirname(absolute),
+            __vite_ssr_import__: request,
+            __vite_ssr_dynamic_import__: request,
+            __vite_ssr_exports__: exports,
+            __vite_ssr_exportAll__: (obj) => exportAll(exports, obj),
+            __vite_ssr_import_meta__: { url },
+        };
+        const fn = vm.runInThisContext(`async (${Object.keys(context).join(',')}) => { ${result.code} }`, {
+            filename: absolute,
+            lineOffset: 0,
+        });
+        await fn(...Object.values(context));
+        return exports;
+    }
+    async function cachedRequest(id, callstack) {
+        if (__pendingModules__.has(id))
+            return __pendingModules__.get(id);
+        __pendingModules__.set(id, directRequest(id, callstack));
+        return await __pendingModules__.get(id);
+    }
+    function exportAll(exports, sourceModule) {
+        // eslint-disable-next-line no-restricted-syntax
+        for (const key in sourceModule) {
+            if (key !== 'default') {
+                try {
+                    Object.defineProperty(exports, key, {
+                        enumerable: true,
+                        configurable: true,
+                        get() { return sourceModule[key]; },
+                    });
+                }
+                catch (_err) { }
+            }
+        }
+    }
+}
+function slash(path) {
+    return path.replace(/\\/g, '/');
+}

package/dist/run.js

@@ -1,10 +1,8 @@
-import chai from 'chai';
 import fg from 'fast-glob';
-import SinonChai from 'sinon-chai';
+import { setupChai } from './chai';
 import { clearContext, defaultSuite } from './suite';
 import { context } from './context';
 import { afterEachHook, afterFileHook, afterAllHook, afterSuiteHook, beforeEachHook, beforeFileHook, beforeAllHook, beforeSuiteHook } from './hooks';
-import { SnapshotPlugin } from './snapshot';
 import { DefaultReporter } from './reporters/default';
 import { defaultIncludes, defaultExcludes } from './constants';
 export async function runTask(task, ctx) {
@@ -94,13 +92,8 @@ export async function runFile(file, ctx) {
 }
 export async function run(config) {
     var _a, _b, _c, _d;
-    const { rootDir = process.cwd() } = config;
     // setup chai
-    chai.use(await SnapshotPlugin({
-        rootDir,
-        update: config.updateSnapshot,
-    }));
-    chai.use(SinonChai);
+    await setupChai(config);
     // collect files
     let paths = await fg(config.includes || defaultIncludes, {
         absolute: true,
@@ -116,6 +109,8 @@ export async function run(config) {
     }
     const reporter = new DefaultReporter();
     await ((_b = reporter.onStart) === null || _b === void 0 ? void 0 : _b.call(reporter, config));
+    if (config.global)
+        (await import('./global')).registerApiGlobally();
     const files = await collectFiles(paths);
     const ctx = {
         files,

package/dist/snapshot/utils/jest-test-result-helper.js

@@ -4,6 +4,7 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
+// @ts-ignore
 import Test from '@jest/test-result';
 const { makeEmptyAggregatedTestResult, } = Test;
 export const makeEmptySnapshotSummary = (options) => {

package/dist/types.d.ts

@@ -3,6 +3,12 @@ export declare type Awaitable<T> = Promise<T> | T;
 export interface UserOptions {
     includes?: string[];
     excludes?: string[];
+    /**
+     * Register apis globally
+     *
+     * @default false
+     */
+    global?: string;
 }
 export interface Config extends UserOptions {
     rootDir?: string;

package/global.d.ts

@@ -0,0 +1,21 @@
+declare global {
+  const suite: typeof import('vitest')['suite']
+  const test: typeof import('vitest')['test']
+  const describe: typeof import('vitest')['describe']
+  const it: typeof import('vitest')['it']
+  const expect: typeof import('vitest')['expect']
+  const assert: typeof import('vitest')['assert']
+  const spy: typeof import('vitest')['spy']
+  const mock: typeof import('vitest')['mock']
+  const stub: typeof import('vitest')['stub']
+  const sinon: typeof import('vitest')['sinon']
+  const beforeAll: typeof import('vitest')['beforeAll']
+  const afterAll: typeof import('vitest')['afterAll']
+  const beforeEach: typeof import('vitest')['beforeEach']
+  const afterEach: typeof import('vitest')['afterEach']
+  const beforeFile: typeof import('vitest')['beforeFile']
+  const afterFile: typeof import('vitest')['afterFile']
+  const beforeSuite: typeof import('vitest')['beforeSuite']
+  const afterSuite: typeof import('vitest')['afterSuite']
+}
+export {}

package/package.json

@@ -1,7 +1,6 @@
 {
   "name": "vitest",
-  "version": "0.0.12",
-  "type": "module",
+  "version": "0.0.13",
   "description": "",
   "keywords": [],
   "homepage": "https://github.com/antfu/vitest#readme",
@@ -15,6 +14,7 @@
   "funding": "https://github.com/sponsors/antfu",
   "license": "MIT",
   "author": "Anthony Fu <anthonyfu117@hotmail.com>",
+  "type": "module",
   "exports": {
     ".": {
       "import": "./dist/index.js",
@@ -25,25 +25,14 @@
   "main": "./dist/index.js",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
-  "files": [
-    "dist",
-    "bin"
-  ],
   "bin": {
     "vitest": "./bin/vitest.mjs"
   },
-  "devDependencies": {
-    "@antfu/eslint-config": "^0.11.1",
-    "@antfu/ni": "^0.11.0",
-    "@types/minimist": "^1.2.2",
-    "@types/node": "^16.11.11",
-    "@types/sinon": "^10.0.6",
-    "bumpp": "^7.1.1",
-    "eslint": "^8.3.0",
-    "esno": "^0.12.1",
-    "typescript": "^4.5.2",
-    "vite": "^2.6.14"
-  },
+  "files": [
+    "dist",
+    "bin",
+    "*.d.ts"
+  ],
   "dependencies": {
     "@jest/test-result": "^27.4.2",
     "@types/chai": "^4.2.22",
@@ -57,15 +46,27 @@
     "ora": "^6.0.1",
     "picocolors": "^1.0.0",
     "sinon": "^12.0.1",
-    "sinon-chai": "^3.7.0",
-    "vite-node": "^0.1.10"
+    "sinon-chai": "^3.7.0"
+  },
+  "devDependencies": {
+    "@antfu/eslint-config": "^0.11.1",
+    "@antfu/ni": "^0.11.0",
+    "@types/minimist": "^1.2.2",
+    "@types/node": "^16.11.11",
+    "@types/sinon": "^10.0.6",
+    "bumpp": "^7.1.1",
+    "eslint": "^8.3.0",
+    "esno": "^0.12.1",
+    "rimraf": "^3.0.2",
+    "typescript": "^4.5.2",
+    "vite": "^2.6.14"
   },
   "scripts": {
-    "build": "tsc",
-    "watch": "tsc --watch",
+    "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"
+    "test:update": "nr test -u",
+    "watch": "tsc -p src/tsconfig.json --watch"
   }
 }

package/dist/defaultIncludes.js

@@ -1 +0,0 @@
-"use strict";

package/dist/snapshot/utils/SnapshotResult.js

@@ -1 +0,0 @@
-"use strict";

package/dist/snapshot/utils/tyoes.js

@@ -1 +0,0 @@
-"use strict";