@rettangoli/vt 0.0.4 → 0.0.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rettangoli/vt",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "description": "Rettangoli Visual Testing",
   "type": "module",
   "main": "./src/index.js",

package/src/cli/report.js

@@ -32,6 +32,34 @@ function getAllFiles(dir, fileList = []) {
   return fileList;
 }
 
+function extractParts(p) {
+  const dir = path.dirname(p);
+  const filename = path.basename(p, '.webp');
+  const lastHyphenIndex = filename.lastIndexOf('-');
+
+  if (lastHyphenIndex > -1) {
+    const suffix = filename.substring(lastHyphenIndex + 1);
+    const number = parseInt(suffix);
+
+    if (!isNaN(number) && String(number) === suffix) {
+      const name = path.join(dir, filename.substring(0, lastHyphenIndex));
+      return { name, number };
+    }
+  }
+  // -1 is for the first file (as it will result in the first index when sorting)
+  return { name: path.join(dir, filename), number: -1 };
+}
+
+function sortPaths(a, b) {
+  const partsA = extractParts(a);
+  const partsB = extractParts(b);
+
+  if (partsA.name < partsB.name) return -1;
+  if (partsA.name > partsB.name) return 1;
+
+  return partsA.number - partsB.number;
+}
+
 async function compareImages(artifactPath, goldPath) {
   try {
     const {equal, diffBounds, diffClusters} = await looksSame(artifactPath, goldPath, {
@@ -122,6 +150,8 @@ async function main(options = {}) {
       ...new Set([...candidateRelativePaths, ...referenceRelativePaths]),
     ];
 
+    allPaths.sort(sortPaths);
+
     for (const relativePath of allPaths) {
       const candidatePath = path.join(candidateDir, relativePath);
       const referencePath = path.join(originalReferenceDir, relativePath);
@@ -206,6 +236,10 @@ async function main(options = {}) {
       templatePath,
       outputPath,
     });
+    if(mismatchingItems.length > 0){ 
+      console.error("Error: there are more than 0 mismatching item.")
+      process.exit(1);
+    }
   } catch (error) {
     console.error("Error reading directories:", error);
   }

package/src/common.js

@@ -263,7 +263,7 @@ async function takeScreenshots(
     const screenshotPath = join(screenshotsDir, `${finalPath}.webp`);
     ensureDirectoryExists(dirname(screenshotPath));
 
-    await page.screenshot({ path: tempPngPath, fullPage: true, animations: "disabled" });
+    await page.screenshot({ path: tempPngPath, fullPage: true});
     await sharp(tempPngPath).webp({ quality: 85 }).toFile(screenshotPath);
 
     if (existsSync(tempPngPath)) {
@@ -313,6 +313,12 @@ async function takeScreenshots(
               case "rclick":
                 await page.mouse.click(Number(args[0]), Number(args[1]), { button: "right" });
                 break;
+              case "mouseDown":
+                await page.mouse.down();
+                break;
+              case "mouseUp":
+                await page.mouse.up();
+                break;
               case "keypress":
                 await page.keyboard.press(args[0]);
                 break;
@@ -324,6 +330,23 @@ async function takeScreenshots(
                 const screenshotPath = await takeAndSaveScreenshot(page, `${baseName}-${screenshotIndex}`);
                 console.log(`Screenshot saved: ${screenshotPath}`);
                 break;
+              case "customEvent":
+                //Use to dispatch custom event for the test evironment to listen to
+                //customEvent <eventName> <...parameters>
+                //To listen to the event use 
+                //window.addEventListener(<eventName>,(event)=>{
+                //  console.log("The params that you pass through: ",event.detail)  
+                //})
+                const [eventName, ...params] = args;
+                const payload = {};
+                params.forEach(param => {
+                  const [key, value] = param.split('=');
+                  payload[key] = value;
+                });
+                await page.evaluate(({eventName,payload}) => {
+                  window.dispatchEvent(new CustomEvent(eventName, { detail: payload }));
+                },{eventName,payload});  
+                break;
             }
           }
           completed++;