vitest-plugin-vis/src/client/page/to_match_image_snapshot.ts

Vitest visual testing plugin

import type { ComparisonMethod, ToMatchPageImageSnapshotOptions } from '../../shared/types.ts'
import { matchPageImageSnapshotAction } from '../actions/match_page_image_snapshot_action.ts'
import { toTaskId } from '../task/task_id.ts'
import { ctx } from './_ctx.ts'

export interface ToMatchImageSnapshotAction {
	toMatchImageSnapshot<M extends ComparisonMethod = 'pixel'>(
		options?: ToMatchPageImageSnapshotOptions<M> | undefined,
	): Promise<void>
}

export function toMatchImageSnapshot<M extends ComparisonMethod = 'pixel'>(
	options?: ToMatchPageImageSnapshotOptions<M> | undefined,
) {
	const test = ctx.getCurrentTest()
	if (!test) {
		throw new Error('`toMatchImageSnapshot()` must be called in a test.')
	}

	if (test.concurrent) {
		throw new Error(
			'`toMatchImageSnapshot()` cannot be called in a concurrent test because ' +
				"concurrent tests run at the same time in the same iframe and affect each other's environment.",
		)
	}

	return matchPageImageSnapshotAction(ctx.commands, toTaskId(test), options)
}