feat(browser): provide project reference in ToMatchScreenshotResolvePath (#10138)

macarie · sheremet-va · web-flow · commit 166544e39532 · 2026-04-27T14:06:51.000+02:00
Co-authored-by: Vladimir &lt;sleuths.slews0s@icloud.com&gt;
diff --git a/docs/config/browser/expect.md b/docs/config/browser/expect.md
@@ -118,6 +118,10 @@ receives an object with the following properties:
   The value provided to [`attachmentsDir`](/config/attachmentsdir), if none is
   provided, its default value.
 
+- `project: TestProject` <Version type="experimental">4.1.6</Version> <Experimental />
+
+  The [`TestProject`](/api/advanced/test-project) the test belongs to.
+
 For example, to group screenshots by browser:
 
 ```ts
diff --git a/packages/browser/src/node/commands/screenshotMatcher/utils.ts b/packages/browser/src/node/commands/screenshotMatcher/utils.ts
@@ -143,6 +143,7 @@ export function resolveOptions(
     testFileName: basename(context.testPath),
     testName: sanitize(testName, false),
     browserName: context.project.config.browser.name,
+    project: context.project,
   } satisfies Parameters<GlobalOptions['resolveDiffPath']>[0]
 
   return {
diff --git a/packages/vitest/src/node/types/browser.ts b/packages/vitest/src/node/types/browser.ts
@@ -524,6 +524,12 @@ type ToMatchScreenshotResolvePath = (data: {
    * if none is provided, its default value.
    */
   attachmentsDir: string
+  /**
+   * The {@linkcode https://vitest.dev/api/advanced/test-project|TestProject} the test belongs to.
+   *
+   * @experimental
+   */
+  project: TestProject
 }) => string
 
 export interface ToMatchScreenshotOptions {
