vitest-canvas-mock

Mock canvas when running unit tests with vitest. Uses jest-canvas-mock.

Install

1npm install vitest-canvas-mock -D

Usage

1. Create a new setup file that imports vitest-canvas-mock or add it to an existing setup file.

1// vitest.setup.ts
2import 'vitest-canvas-mock'

2. In your vitest.config.ts file, create a setupFiles array and add that file:

1import { defineConfig } from 'vitest/config'
2
3export default defineConfig({
4  test: {
5    setupFiles: ['./vitest.setup.ts'],
6    environment: 'jsdom',
7    deps: {
8      // vitest < 0.34
9      inline: ['vitest-canvas-mock'],
10      // >= 0.34
11      optimizer: {
12        web: {
13          include: ['vitest-canvas-mock']
14        }
15      }
16    },
17    // For this config, check https://github.com/vitest-dev/vitest/issues/740
18    // Vitest < 0.1.x
19    threads: false,
20    // >= 0.1.0
21    poolOptions: {
22      threads: {
23        singleThread: true,
24      },
25    },
26    environmentOptions: {
27      jsdom: {
28        resources: 'usable',
29      },
30    },
31  },
32})

Mock Strategy

View mock strategy doc here.

Snapshots

View snapshots doc here

License

MIT