@lewiswright/storybook-addon-vis/src/client/expect/to_match_image_snapshot.ts

Storybook Vitest visual testing addon

import type { AsyncExpectationResult } from '@vitest/expect'
import {
	type ComparisonMethod,
	type ToMatchImageSnapshotOptions,
	imageSnapshotMatcher,
	success,
} from 'vitest-plugin-vis/client'
import { commands, getCurrentTest } from '../vitest_proxy.ts'

export function toMatchImageSnapshot<M extends ComparisonMethod>(
	/**
	 * The element or locator to take the snapshot of,
	 * or the base64 value of the image to compare against.
	 */
	subject: any,
	options?: ToMatchImageSnapshotOptions<M> | undefined,
): AsyncExpectationResult {
	const test = getCurrentTest()

	/* v8 ignore start: stub as success when not in a test (e.g. in a story) */
	if (!test) return Promise.resolve(success)
	/* v8 ignore end */

	return imageSnapshotMatcher(commands)(test, subject, options).then(() => success)
}