feat: jsdom

vitest-dev · Dec 5, 2021 · ac4df04 · ac4df04
1 parent 516136d
commit ac4df04
Show file tree

Hide file tree

Showing 6 changed files with 55 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -6,10 +6,11 @@ A blazing fast test runner powered by Vite.
 
 ## Features
 
-- [Vite](https://vitejs.dev/)'s config, transformers, resolvers, and plugins. Powered by [vite-node](https://github.com/antfu/vite-node)
+- [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
@@ -20,11 +21,12 @@ import { it, describe, expect, assert } from 'vitest'
 
 describe('suite name', () => {
   it('foo', () => {
-    assert.equal(Math.sqrt(4), 2)
+    expect(1 + 1).toEqual(2)
+    expect(true).to.be.true
   })
 
   it('bar', () => {
-    expect(1 + 1).eq(2)
+    assert.equal(Math.sqrt(4), 2)
   })
 
   it('snapshot', () => {

diff --git a/package.json b/package.json
@@ -62,6 +62,7 @@
   "devDependencies": {
     "@antfu/eslint-config": "^0.11.1",
     "@antfu/ni": "^0.11.0",
+    "@types/jsdom": "^16.2.13",
     "@types/minimist": "^1.2.2",
     "@types/node": "^16.11.11",
     "@types/sinon": "^10.0.6",

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/cli.ts b/src/cli.ts
@@ -11,7 +11,7 @@ const argv = minimist(process.argv.slice(2), {
     w: 'watch',
   },
   string: ['root', 'config'],
-  boolean: ['update', 'dev', 'global', 'watch'],
+  boolean: ['update', 'dev', 'global', 'watch', 'jsdom'],
   unknown(name) {
     if (name[0] === '-') {
       console.error(c.red(`Unknown argument: ${name}`))
@@ -28,8 +28,7 @@ const viteConfig = server?.config || {}
 const testOptions = viteConfig.test || {}
 
 await run({
-  global: argv.global,
-  watch: argv.watch,
+  ...argv,
   ...testOptions,
   server,
   updateSnapshot: argv.update,

diff --git a/src/integrations/jsdom.ts b/src/integrations/jsdom.ts
@@ -0,0 +1,26 @@
+import { JSDOM } from 'jsdom'
+
+export function setupJSDOM(global: any) {
+  const dom = new JSDOM('<!DOCTYPE html>',
+    {
+      pretendToBeVisual: true,
+      runScripts: 'dangerously',
+      // TODO: options
+      url: 'http://localhost:3000',
+    },
+  )
+
+  const keys = Object.getOwnPropertyNames(dom.window)
+    .filter(k => !k.startsWith('_'))
+    .filter(k => !(k in global))
+
+  for (const key of keys)
+    global[key] = dom.window[key]
+
+  return {
+    dom,
+    restore() {
+      keys.forEach(key => delete global[key])
+    },
+  }
+}
diff --git a/src/run.ts b/src/run.ts
@@ -140,6 +140,9 @@ export async function run(config: Config) {
   if (config.global)
     (await import('./global')).registerApiGlobally()
 
+  if (config.jsdom)
+    (await import('./integrations/jsdom')).setupJSDOM(globalThis)
+
   const files = await collectFiles(paths)
 
   const ctx: RunnerContext = {