02/03: add playwright solution, merge vitest with vite

kettanaito · kettanaito · commit 34e0710b5da0 · 2025-01-14T14:37:51.000+01:00
diff --git a/exercises/01.sunsetting-jsdom/01.problem.break-jsdom/package.json b/exercises/01.sunsetting-jsdom/01.problem.break-jsdom/package.json
@@ -1,4 +1,5 @@
 {
+  "type": "module",
   "name": "exercises_01.sunsetting-jsdom_01.problem.break-jsdom",
   "scripts": {
     "dev": "vite",
@@ -20,6 +21,6 @@
     "postcss": "^8.4.49",
     "tailwindcss": "^3.4.17",
     "vite": "^6.0.7",
-    "vitest": "^2.1.8"
+    "vitest": "^3.0.0-beta.4"
   }
 }
diff --git a/exercises/01.sunsetting-jsdom/01.problem.break-jsdom/tsconfig.node.json b/exercises/01.sunsetting-jsdom/01.problem.break-jsdom/tsconfig.node.json
@@ -19,5 +19,5 @@
 		"noFallthroughCasesInSwitch": true,
 		"noUncheckedSideEffectImports": true
 	},
-	"include": ["vite.config.ts", "vitest.config.ts"]
+	"include": ["vite.config.ts"]
 }
diff --git a/exercises/01.sunsetting-jsdom/01.problem.break-jsdom/vite.config.ts b/exercises/01.sunsetting-jsdom/01.problem.break-jsdom/vite.config.ts
@@ -1,6 +1,10 @@
+/// <reference types="vitest" />
 import { defineConfig } from 'vite'
 import react from '@vitejs/plugin-react'
 
 export default defineConfig({
 	plugins: [react()],
+	test: {
+		environment: 'jsdom',
+	},
 })
diff --git a/exercises/01.sunsetting-jsdom/01.problem.break-jsdom/vitest.config.ts b/exercises/01.sunsetting-jsdom/01.problem.break-jsdom/vitest.config.ts
diff --git a/exercises/01.sunsetting-jsdom/01.solution.break-jsdom/package.json b/exercises/01.sunsetting-jsdom/01.solution.break-jsdom/package.json
@@ -1,4 +1,5 @@
 {
+  "type": "module",
   "name": "exercises_01.sunsetting-jsdom_01.solution.break-jsdom",
   "scripts": {
     "dev": "vite",
@@ -19,6 +20,6 @@
     "postcss": "^8.4.49",
     "tailwindcss": "^3.4.17",
     "vite": "^6.0.7",
-    "vitest": "^2.1.8"
+    "vitest": "^3.0.0-beta.4"
   }
 }
diff --git a/exercises/01.sunsetting-jsdom/01.solution.break-jsdom/tsconfig.node.json b/exercises/01.sunsetting-jsdom/01.solution.break-jsdom/tsconfig.node.json
@@ -19,5 +19,5 @@
 		"noFallthroughCasesInSwitch": true,
 		"noUncheckedSideEffectImports": true
 	},
-	"include": ["vite.config.ts", "vitest.config.ts"]
+	"include": ["vite.config.ts"]
 }
diff --git a/exercises/01.sunsetting-jsdom/01.solution.break-jsdom/vite.config.ts b/exercises/01.sunsetting-jsdom/01.solution.break-jsdom/vite.config.ts
@@ -1,6 +1,10 @@
+/// <reference types="vitest" />
 import { defineConfig } from 'vite'
 import react from '@vitejs/plugin-react'
 
 export default defineConfig({
 	plugins: [react()],
+	test: {
+		environment: 'jsdom',
+	},
 })
diff --git a/exercises/01.sunsetting-jsdom/01.solution.break-jsdom/vitest.config.ts b/exercises/01.sunsetting-jsdom/01.solution.break-jsdom/vitest.config.ts
diff --git a/exercises/01.sunsetting-jsdom/02.problem.under-the-hood/package.json b/exercises/01.sunsetting-jsdom/02.problem.under-the-hood/package.json
@@ -1,4 +1,5 @@
 {
+  "type": "module",
   "name": "exercises_01.sunsetting-jsdom_02.problem.under-the-hood",
   "scripts": {
     "dev": "echo hi"
diff --git a/exercises/01.sunsetting-jsdom/02.solution.under-the-hood/package.json b/exercises/01.sunsetting-jsdom/02.solution.under-the-hood/package.json
@@ -1,4 +1,5 @@
 {
+  "type": "module",
   "name": "exercises_01.sunsetting-jsdom_02.solution.under-the-hood",
   "scripts": {
     "dev": "echo hi"
diff --git a/exercises/02.vitest-browser-mode/01.solution.installation-and-setup/tsconfig.node.json b/exercises/02.vitest-browser-mode/01.solution.installation-and-setup/tsconfig.node.json
@@ -19,5 +19,5 @@
 		"noFallthroughCasesInSwitch": true,
 		"noUncheckedSideEffectImports": true
 	},
-	"include": ["vite.config.ts", "vitest.config.ts"]
+	"include": ["vite.config.ts"]
 }
diff --git a/exercises/02.vitest-browser-mode/01.solution.installation-and-setup/vite.config.ts b/exercises/02.vitest-browser-mode/01.solution.installation-and-setup/vite.config.ts
@@ -1,6 +1,17 @@
+/// <reference types="vitest" />
 import { defineConfig } from 'vite'
 import react from '@vitejs/plugin-react'
 
 export default defineConfig({
 	plugins: [react()],
+	test: {
+		browser: {
+			enabled: true,
+			instances: [
+				{
+					browser: 'chromium',
+				},
+			],
+		},
+	},
 })
diff --git a/exercises/02.vitest-browser-mode/01.solution.installation-and-setup/vitest.config.ts b/exercises/02.vitest-browser-mode/01.solution.installation-and-setup/vitest.config.ts
diff --git a/exercises/02.vitest-browser-mode/02.solution.migrate-the-test/package.json b/exercises/02.vitest-browser-mode/02.solution.migrate-the-test/package.json
@@ -1,4 +1,5 @@
 {
+  "type": "module",
   "name": "exercises_02.vitest-browser-mode_02.solution.migrate-the-test",
   "scripts": {
     "dev": "vite",
diff --git a/exercises/02.vitest-browser-mode/02.solution.migrate-the-test/tsconfig.node.json b/exercises/02.vitest-browser-mode/02.solution.migrate-the-test/tsconfig.node.json
@@ -19,5 +19,5 @@
 		"noFallthroughCasesInSwitch": true,
 		"noUncheckedSideEffectImports": true
 	},
-	"include": ["vite.config.ts", "vitest.config.ts"]
+	"include": ["vite.config.ts"]
 }
diff --git a/exercises/02.vitest-browser-mode/02.solution.migrate-the-test/vite.config.ts b/exercises/02.vitest-browser-mode/02.solution.migrate-the-test/vite.config.ts
@@ -1,6 +1,17 @@
+/// <reference types="vitest" />
 import { defineConfig } from 'vite'
 import react from '@vitejs/plugin-react'
 
 export default defineConfig({
 	plugins: [react()],
+	test: {
+		browser: {
+			enabled: true,
+			instances: [
+				{
+					browser: 'chromium',
+				},
+			],
+		},
+	},
 })
diff --git a/exercises/02.vitest-browser-mode/02.solution.migrate-the-test/vitest.config.ts b/exercises/02.vitest-browser-mode/02.solution.migrate-the-test/vitest.config.ts
diff --git a/exercises/02.vitest-browser-mode/03.solution.use-playwright/README.mdx b/exercises/02.vitest-browser-mode/03.solution.use-playwright/README.mdx
@@ -0,0 +1,6 @@
+# Use Playwright
+
+0. Explain why we want `playwright` and not the default `preview` browser provider (works better for CI, more powerful since it taps into the Chrome DevTools Protocol).
+1. Install `playwright`.
+1. Run `npx playwright install --with-deps chromium` and configure your repo so this runs automatically (this can be quite annoying). Also, install just the browsers we need, not all of them, to save time on CI.
+1. Update the Vitest configuration to use `playwright` as the browser automation tool.
diff --git a/exercises/02.vitest-browser-mode/03.solution.use-playwright/index.html b/exercises/02.vitest-browser-mode/03.solution.use-playwright/index.html
@@ -0,0 +1,15 @@
+<!doctype html>
+<html lang="en">
+	<head>
+		<meta charset="UTF-8" />
+		<link rel="icon" type="image/svg+xml" href="/vite.svg" />
+		<meta name="viewport" content="width=device-width, initial-scale=1.0" />
+		<title>Vite App</title>
+		<link rel="preconnect" href="https://fonts.googleapis.com" />
+		<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
+	</head>
+	<body>
+		<div id="root"></div>
+		<script type="module" src="/src/main.tsx"></script>
+	</body>
+</html>
diff --git a/exercises/02.vitest-browser-mode/03.solution.use-playwright/package.json b/exercises/02.vitest-browser-mode/03.solution.use-playwright/package.json
@@ -0,0 +1,26 @@
+{
+  "type": "module",
+  "name": "exercises_02.vitest-browser-mode_03.solution.use-playwright",
+  "scripts": {
+    "dev": "vite",
+    "test": "vitest"
+  },
+  "dependencies": {
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0"
+  },
+  "devDependencies": {
+    "@testing-library/dom": "^10.4.0",
+    "@testing-library/react": "^16.1.0",
+    "@types/react": "^19.0.6",
+    "@types/react-dom": "^19.0.3",
+    "@vitejs/plugin-react": "^4.3.4",
+    "@vitest/browser": "^3.0.0-beta.4",
+    "autoprefixer": "^10.4.20",
+    "playwright": "^1.49.1",
+    "postcss": "^8.4.49",
+    "tailwindcss": "^3.4.17",
+    "vite": "^6.0.7",
+    "vitest": "^3.0.0-beta.4"
+  }
+}
diff --git a/exercises/02.vitest-browser-mode/03.solution.use-playwright/postcss.config.js b/exercises/02.vitest-browser-mode/03.solution.use-playwright/postcss.config.js
@@ -0,0 +1,6 @@
+module.exports = {
+	plugins: {
+		tailwindcss: {},
+		autoprefixer: {},
+	},
+}
diff --git a/exercises/02.vitest-browser-mode/03.solution.use-playwright/public/vite.svg b/exercises/02.vitest-browser-mode/03.solution.use-playwright/public/vite.svg
@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" class="iconify iconify--logos" width="31.88" height="32" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 257"><defs><linearGradient id="IconifyId1813088fe1fbc01fb466" x1="-.828%" x2="57.636%" y1="7.652%" y2="78.411%"><stop offset="0%" stop-color="#41D1FF"></stop><stop offset="100%" stop-color="#BD34FE"></stop></linearGradient><linearGradient id="IconifyId1813088fe1fbc01fb467" x1="43.376%" x2="50.316%" y1="2.242%" y2="89.03%"><stop offset="0%" stop-color="#FFEA83"></stop><stop offset="8.333%" stop-color="#FFDD35"></stop><stop offset="100%" stop-color="#FFA800"></stop></linearGradient></defs><path fill="url(#IconifyId1813088fe1fbc01fb466)" d="M255.153 37.938L134.897 252.976c-2.483 4.44-8.862 4.466-11.382.048L.875 37.958c-2.746-4.814 1.371-10.646 6.827-9.67l120.385 21.517a6.537 6.537 0 0 0 2.322-.004l117.867-21.483c5.438-.991 9.574 4.796 6.877 9.62Z"></path><path fill="url(#IconifyId1813088fe1fbc01fb467)" d="M185.432.063L96.44 17.501a3.268 3.268 0 0 0-2.634 3.014l-5.474 92.456a3.268 3.268 0 0 0 3.997 3.378l24.777-5.718c2.318-.535 4.413 1.507 3.936 3.838l-7.361 36.047c-.495 2.426 1.782 4.5 4.151 3.78l15.304-4.649c2.372-.72 4.652 1.36 4.15 3.788l-11.698 56.621c-.732 3.542 3.979 5.473 5.943 2.437l1.313-2.028l72.516-144.72c1.215-2.423-.88-5.186-3.54-4.672l-25.505 4.922c-2.396.462-4.435-1.77-3.759-4.114l16.646-57.705c.677-2.35-1.37-4.583-3.769-4.113Z"></path></svg>
diff --git a/exercises/02.vitest-browser-mode/03.solution.use-playwright/src/app.tsx b/exercises/02.vitest-browser-mode/03.solution.use-playwright/src/app.tsx
@@ -0,0 +1,38 @@
+import { useState } from 'react'
+import { FilePreview } from './file-preview.jsx'
+
+export function App() {
+	const [file, setFile] = useState<File>()
+
+	return (
+		<div>
+			{file ? (
+				<div className="flex flex-col items-center">
+					<FilePreview file={file} />
+					<button
+						className="mt-10 rounded-full bg-slate-800 px-6 py-2 text-sm font-bold text-white hover:bg-slate-600"
+						onClick={() => setFile(undefined)}
+					>
+						Preview another file
+					</button>
+				</div>
+			) : (
+				<div className="rounded-md border border-slate-200 bg-white p-4 shadow-lg shadow-slate-200">
+					<input
+						type="file"
+						name="file"
+						required
+						className="text-sm font-medium"
+						onChange={(event) => {
+							const [selectedFile] = event.currentTarget.files || []
+
+							if (selectedFile) {
+								setFile(selectedFile)
+							}
+						}}
+					/>
+				</div>
+			)}
+		</div>
+	)
+}
diff --git a/exercises/02.vitest-browser-mode/03.solution.use-playwright/src/file-preview.test.tsx b/exercises/02.vitest-browser-mode/03.solution.use-playwright/src/file-preview.test.tsx
@@ -0,0 +1,11 @@
+import { it, expect } from 'vitest'
+import { page } from '@vitest/browser/context'
+import { render } from 'vitest-browser-react'
+import { FilePreview } from './file-preview.tsx'
+
+it('displays the preview card', async () => {
+	render(<FilePreview file={new File(['hello world'], 'file.txt')} />)
+
+	expect(page.getByText('file.txt')).toBeTruthy()
+	expect(page.getByText('hello world')).toBeTruthy()
+})
diff --git a/exercises/02.vitest-browser-mode/03.solution.use-playwright/src/file-preview.tsx b/exercises/02.vitest-browser-mode/03.solution.use-playwright/src/file-preview.tsx
@@ -0,0 +1,20 @@
+import { useEffect, useState } from 'react'
+
+export function FilePreview({ file }: { file: File }) {
+	const [previewText, setPreviewText] = useState<string>()
+
+	useEffect(() => {
+		file.text().then(setPreviewText)
+	}, [file])
+
+	return (
+		<div>
+			<div className="w-full max-w-2xl overflow-hidden rounded-md border border-slate-200 bg-white shadow-lg shadow-slate-200">
+				<p className="border-b border-slate-200 bg-slate-50 px-4 py-2 font-bold text-slate-600">
+					{file.name}
+				</p>
+				<pre className="max-h-[28ch] overflow-scroll p-4">{previewText}</pre>
+			</div>
+		</div>
+	)
+}
diff --git a/exercises/02.vitest-browser-mode/03.solution.use-playwright/src/index.css b/exercises/02.vitest-browser-mode/03.solution.use-playwright/src/index.css
@@ -0,0 +1,25 @@
+@import url('https://fonts.googleapis.com/css2?family=DM+Sans:ital,opsz,wght@0,9..40,100..1000;1,9..40,100..1000&display=swap');
+
+@tailwind base;
+@tailwind components;
+@tailwind utilities;
+
+html {
+	@apply flex size-full items-center justify-center bg-slate-100 p-10;
+
+	font-family:
+		'DM Sans',
+		system-ui,
+		-apple-system,
+		BlinkMacSystemFont,
+		'Segoe UI',
+		Roboto,
+		Oxygen,
+		Ubuntu,
+		Cantarell,
+		'Open Sans',
+		'Helvetica Neue',
+		sans-serif;
+	font-style: normal;
+	font-optical-sizing: auto;
+}
diff --git a/exercises/02.vitest-browser-mode/03.solution.use-playwright/src/main.tsx b/exercises/02.vitest-browser-mode/03.solution.use-playwright/src/main.tsx
@@ -0,0 +1,10 @@
+import { StrictMode } from 'react'
+import { createRoot } from 'react-dom/client'
+import './index.css'
+import { App } from './app.jsx'
+
+createRoot(document.getElementById('root')!).render(
+	<StrictMode>
+		<App />
+	</StrictMode>,
+)
diff --git a/exercises/02.vitest-browser-mode/03.solution.use-playwright/src/vite-env.d.ts b/exercises/02.vitest-browser-mode/03.solution.use-playwright/src/vite-env.d.ts
@@ -0,0 +1 @@
+/// <reference types="vite/client" />
diff --git a/exercises/02.vitest-browser-mode/03.solution.use-playwright/tailwind.config.ts b/exercises/02.vitest-browser-mode/03.solution.use-playwright/tailwind.config.ts
@@ -0,0 +1,9 @@
+import type { Config } from 'tailwindcss'
+
+export default {
+	content: ['./index.html', './src/**/*.{ts,tsx}'],
+	theme: {
+		extend: {},
+	},
+	plugins: [],
+} satisfies Config
diff --git a/exercises/02.vitest-browser-mode/03.solution.use-playwright/tsconfig.app.json b/exercises/02.vitest-browser-mode/03.solution.use-playwright/tsconfig.app.json
@@ -0,0 +1,26 @@
+{
+	"compilerOptions": {
+		"target": "ES2020",
+		"useDefineForClassFields": true,
+		"lib": ["ES2020", "DOM", "DOM.Iterable"],
+		"module": "ESNext",
+		"skipLibCheck": true,
+
+		/* Bundler mode */
+		"moduleResolution": "bundler",
+		"allowImportingTsExtensions": true,
+		"isolatedModules": true,
+		"moduleDetection": "force",
+		"noEmit": true,
+		"jsx": "react-jsx",
+		"verbatimModuleSyntax": true,
+
+		/* Linting */
+		"strict": true,
+		"noUnusedLocals": true,
+		"noUnusedParameters": true,
+		"noFallthroughCasesInSwitch": true,
+		"noUncheckedSideEffectImports": true
+	},
+	"include": ["src"]
+}
diff --git a/exercises/02.vitest-browser-mode/03.solution.use-playwright/tsconfig.json b/exercises/02.vitest-browser-mode/03.solution.use-playwright/tsconfig.json
@@ -0,0 +1,7 @@
+{
+	"files": [],
+	"references": [
+		{ "path": "./tsconfig.app.json" },
+		{ "path": "./tsconfig.node.json" }
+	]
+}
diff --git a/exercises/02.vitest-browser-mode/03.solution.use-playwright/tsconfig.node.json b/exercises/02.vitest-browser-mode/03.solution.use-playwright/tsconfig.node.json
diff --git a/exercises/02.vitest-browser-mode/03.solution.use-playwright/vite.config.ts b/exercises/02.vitest-browser-mode/03.solution.use-playwright/vite.config.ts
diff --git a/package-lock.json b/package-lock.json
diff --git a/tsconfig.json b/tsconfig.json

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`{`
	`2`	`+ "type": "module",`
`2`	`3`	`"name": "exercises_01.sunsetting-jsdom_01.problem.break-jsdom",`
`3`	`4`	`"scripts": {`
`4`	`5`	`"dev": "vite",`
`@@ -20,6 +21,6 @@`
`20`	`21`	`"postcss": "^8.4.49",`
`21`	`22`	`"tailwindcss": "^3.4.17",`
`22`	`23`	`"vite": "^6.0.7",`
`23`		`- "vitest": "^2.1.8"`
	`24`	`+ "vitest": "^3.0.0-beta.4"`
`24`	`25`	`}`
`25`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,5 +19,5 @@`
`19`	`19`	`"noFallthroughCasesInSwitch": true,`
`20`	`20`	`"noUncheckedSideEffectImports": true`
`21`	`21`	`},`
`22`		`- "include": ["vite.config.ts", "vitest.config.ts"]`
	`22`	`+ "include": ["vite.config.ts"]`
`23`	`23`	`}`