@argos-ci/vitest 0.3.2 → 0.4.0

package/README.md

@@ -17,7 +17,7 @@
 
 Capture Argos screenshots directly from your [Vitest browser tests](https://vitest.dev/guide/browser/).
 
-Visit the [Vitest SDK documentation](https://argos-ci.com/docs/sdks-reference/vitest) for guides, API and more.
+Visit the [Vitest SDK documentation](https://argos-ci.com/docs/reference/vitest) for guides, API and more.
 
 ## Installation
 
@@ -140,6 +140,6 @@ when `uploadToArgos` is enabled.
 
 ## Links
 
-- [Official SDK Docs](https://argos-ci.com/docs/sdks-reference/vitest)
+- [Official SDK Docs](https://argos-ci.com/docs/reference/vitest)
 - [Quickstart](https://argos-ci.com/docs/quickstart/vitest-quickstart)
 - [Discord](https://argos-ci.com/discord)

package/dist/index.d.mts

@@ -47,6 +47,22 @@ interface VitestScreenshotOptions {
    * @default 0.5
    */
   threshold?: number;
+  /**
+   * Name, or list of names, to compare this screenshot against instead of its
+   * own name. A list is tried in order and the first name found in the baseline
+   * build wins, which lets a brand new screenshot fall back to an existing one
+   * rather than showing up as added.
+   *
+   * The screenshot's own name is not implicitly included: list it first to keep
+   * comparing against itself when it exists.
+   *
+   * @example
+   *    // Compare "home-variant-b" against itself, or against "home" if it is new.
+   *    argosScreenshot("home-variant-b", {
+   *      baseName: ["home-variant-b", "home"],
+   *    })
+   */
+  baseName?: string | string[];
   /**
    * Tag or array of tags to attach to the screenshot.
    */

package/dist/plugin.d.mts

@@ -58,6 +58,22 @@ interface VitestScreenshotOptions {
    * @default 0.5
    */
   threshold?: number;
+  /**
+   * Name, or list of names, to compare this screenshot against instead of its
+   * own name. A list is tried in order and the first name found in the baseline
+   * build wins, which lets a brand new screenshot fall back to an existing one
+   * rather than showing up as added.
+   *
+   * The screenshot's own name is not implicitly included: list it first to keep
+   * comparing against itself when it exists.
+   *
+   * @example
+   *    // Compare "home-variant-b" against itself, or against "home" if it is new.
+   *    argosScreenshot("home-variant-b", {
+   *      baseName: ["home-variant-b", "home"],
+   *    })
+   */
+  baseName?: string | string[];
   /**
    * Tag or array of tags to attach to the screenshot.
    */

package/dist/plugin.mjs

@@ -2,7 +2,7 @@ import { createRequire } from "node:module";
 import { dirname, relative, resolve } from "node:path";
 import { DO_NOT_USE_setMetadataConfig, argosScreenshot } from "@argos-ci/playwright";
 import { resolveViewport } from "@argos-ci/browser";
-import { createDirectory, getGitRepositoryPath, getMetadataPath, getScreenshotName, readVersionFromPackage, writeMetadata } from "@argos-ci/util";
+import { createDirectory, getGitRepositoryPath, getMetadataPath, getScreenshotName, normalizeBaseNames, readVersionFromPackage, writeMetadata } from "@argos-ci/util";
 import { writeFile } from "node:fs/promises";
 import { getSnapshotMimeType, readConfig, upload } from "@argos-ci/core";
 //#region src/iframe.ts
@@ -169,6 +169,7 @@ const createArgosScreenshotCommand = (pluginOptions = {}) => {
 			...pluginOptions,
 			...options
 		};
+		const baseNames = normalizeBaseNames(merged.baseName);
 		const fullPage = merged.fullPage ?? false;
 		const fitWidth = !fullPage;
 		const restore = await resetTesterScale(ctx);
@@ -190,7 +191,10 @@ const createArgosScreenshotCommand = (pluginOptions = {}) => {
 				const size = resolveViewport(viewport);
 				await setIframeViewportSize(ctx, size, { fullPage });
 				setMetadata(size);
-				const shot = await screenshotFrame(ctx, getScreenshotName(name, { viewportWidth: size.width }), merged, { fitWidth: false });
+				const shot = await screenshotFrame(ctx, getScreenshotName(name, { viewportWidth: size.width }), {
+					...merged,
+					baseName: baseNames?.map((baseName) => getScreenshotName(baseName, { viewportWidth: size.width }))
+				}, { fitWidth: false });
 				attachments.push(...shot);
 				await setIframeViewportSize(ctx, "initial", { fullPage });
 			}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@argos-ci/vitest",
   "description": "Vitest SDK for visual testing with Argos.",
-  "version": "0.3.2",
+  "version": "0.4.0",
   "author": "Smooth Code",
   "license": "MIT",
   "repository": {
@@ -9,7 +9,7 @@
     "url": "https://github.com/argos-ci/argos-javascript.git",
     "directory": "packages/vitest"
   },
-  "homepage": "https://argos-ci.com/docs/sdks-reference/vitest",
+  "homepage": "https://argos-ci.com/docs/reference/vitest",
   "bugs": {
     "url": "https://github.com/argos-ci/argos-javascript/issues"
   },
@@ -52,9 +52,9 @@
   },
   "dependencies": {
     "@argos-ci/browser": "6.4.4",
-    "@argos-ci/core": "6.6.2",
-    "@argos-ci/playwright": "7.3.7",
-    "@argos-ci/util": "4.0.4"
+    "@argos-ci/core": "6.7.0",
+    "@argos-ci/playwright": "7.4.0",
+    "@argos-ci/util": "4.1.0"
   },
   "peerDependencies": {
     "@vitest/browser": ">=4",
@@ -81,5 +81,5 @@
     "check-format": "prettier --check --ignore-unknown --ignore-path=./.gitignore --ignore-path=../../.gitignore --ignore-path=../../.prettierignore .",
     "lint": "eslint ."
   },
-  "gitHead": "a86f2dc1a243591e064a2d5c4e03d712c8f03b86"
+  "gitHead": "a3083087b11004e0b315e2d14f1e9179cbd56da2"
 }