Debug your Vitest tests. Effortlessly. ๐งช๐ผโก๏ธ
Try Vitest Preview Online. No downloads needed!
[](https://www.npmjs.com/package/vitest-preview) [](./CONTRIBUTING.md) [](https://stackblitz.com/edit/vitest-preview?file=src%2FApp.test.tsx,README.md) ## Why **vitest-preview** When writing tests, we usually have to debug by reading the cryptic HTML output on the terminal. Sometimes, they are too complicated to visualize the UI in our heads. `vitest-preview` previews your Vitest tests right in a browser, then you can see your actual UI visually. You can write tests and watch rendered output changes accordingly. Vitest Preview lets you concentrate on tests in the "real world" rather than deciphering HTML code. `vitest-preview` is built on top of [Vite](https://vitejs.dev), it's blazing fast and easy to use. `vitest-preview` is a younger sibling of [`jest-preview`](https://github.com/nvh95/jest-preview) with the same idea and to solve the same problem. If you are writing tests using Jest, [give it a try](https://stackblitz.com/edit/jest-preview?file=src%2FApp.test.tsx,README.md). ## Features - ๐ Visualize your testing UI in an external browser in milliseconds. - ๐ Auto reloads the browser when `debug()` is executed. - ๐ Fully support CSS - ๐ Support viewing images. ## Installation ```bash npm install --save-dev vitest-preview # Or yarn add -D vitest-preview pnpm add -D vitest-preview ``` ## Configuration ### Process CSS You need to configure `vitest` to process CSS by: ```diff // vite.config.js export default defineConfig({ test: { + css: true, }, }); ``` You might want to import your CSS global files in `setupFiles`: ```diff // vite.config.js export default defineConfig({ test: { + setupFiles: './src/test/setup.ts', }, }); ``` ```diff // src/test/setup.ts +import './global.css'; +import '@your-design-system/css/dist/index.min.css'; +import 'bootstrap/dist/css/bootstrap.min.css'; ``` ### Add script vitest-preview `vitest-preview` has a CLI that opens **Vitest Preview Dashboard** where you can preview your tests' UI. You can update your `package.json` to add a script for more convenience: ```json "scripts": { "vitest-preview": "vitest-preview" }, ``` ### Update .gitignore Update your `.gitignore` ```diff // .gitignore +.vitest-preview ``` ## Usage Put `debug()` wherever you want to see the UI in your tests. ```diff +import { debug } from 'vitest-preview'; describe('App', () => { it('should work as expected', () => { render(