@argos-ci/playwright 3.6.3 → 3.7.0

package/dist/index.d.ts

@@ -27,6 +27,11 @@ type ArgosScreenshotOptions = {
      * @default 0.5
      */
     threshold?: number;
+    /**
+     * Folder where the screenshots will be saved if not using the Argos reporter.
+     * @default "./screenshots"
+     */
+    root?: string;
 } & LocatorOptions & ScreenshotOptions<LocatorScreenshotOptions> & ScreenshotOptions<PageScreenshotOptions>;
 /**
  * Stabilize the UI and takes a screenshot of the application under test.

package/dist/index.mjs

@@ -77,7 +77,7 @@ function checkIsUsingArgosReporter(testInfo) {
     return testInfo.config.reporter.some((reporter)=>reporter[0].includes("@argos-ci/playwright/reporter") || reporter[0] === reporterPath);
 }
 
-const screenshotFolder = "./screenshots";
+const DEFAULT_SCREENSHOT_ROOT = "./screenshots";
 /**
  * Inject Argos script into the page.
  */ async function injectArgos(page) {
@@ -172,7 +172,7 @@ function getViewportSize(page) {
    */ name, /**
    * Options for the screenshot.
    */ options = {}) {
-    const { element, has, hasText, viewports, argosCSS, ...playwrightOptions } = options;
+    const { element, has, hasText, viewports, argosCSS, root = DEFAULT_SCREENSHOT_ROOT, ...playwrightOptions } = options;
     if (!page) {
         throw new Error("A Playwright `page` object is required.");
     }
@@ -187,7 +187,7 @@ function getViewportSize(page) {
     const useArgosReporter = Boolean(testInfo && checkIsUsingArgosReporter(testInfo));
     await Promise.all([
         // Create the screenshot folder if it doesn't exist
-        useArgosReporter ? null : mkdir(screenshotFolder, {
+        useArgosReporter ? null : mkdir(root, {
             recursive: true
         }),
         // Inject Argos script into the page
@@ -236,9 +236,9 @@ function getViewportSize(page) {
         if (names.baseName) {
             metadata.transient.baseName = `${names.baseName}.png`;
         }
-        const screenshotPath = useArgosReporter && testInfo ? testInfo.outputPath("argos", `${names.name}.png`) : resolve(screenshotFolder, `${names.name}.png`);
+        const screenshotPath = useArgosReporter && testInfo ? testInfo.outputPath("argos", `${names.name}.png`) : resolve(root, `${names.name}.png`);
         const dir = dirname(screenshotPath);
-        if (dir !== screenshotFolder) {
+        if (dir !== root) {
             await mkdir(dirname(screenshotPath), {
                 recursive: true
             });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@argos-ci/playwright",
   "description": "Visual testing solution to avoid visual regression. Playwright commands and utilities for Argos visual testing.",
-  "version": "3.6.3",
+  "version": "3.7.0",
   "author": "Smooth Code",
   "license": "MIT",
   "repository": {
@@ -43,13 +43,13 @@
   },
   "dependencies": {
     "@argos-ci/browser": "2.1.4",
-    "@argos-ci/core": "2.8.2",
+    "@argos-ci/core": "2.9.0",
     "@argos-ci/util": "2.1.1",
     "chalk": "^5.3.0",
     "debug": "^4.3.6"
   },
   "devDependencies": {
-    "@argos-ci/cli": "2.4.4",
+    "@argos-ci/cli": "2.4.5",
     "@argos-ci/playwright": "workspace:.",
     "@playwright/test": "^1.46.1",
     "@types/debug": "^4.1.12",
@@ -61,5 +61,5 @@
     "test": "pnpm exec -- playwright test",
     "e2e": "UPLOAD_TO_ARGOS=true pnpm run test"
   },
-  "gitHead": "0e6df5391e875daba1da61fac33ca1c215db4bc2"
+  "gitHead": "cae12b0cb7d4e9237cf5973d7911af68bc708773"
 }