renderdiff 0.1.0 → 0.3.0

package/renderdiff.config.example.ts

@@ -6,7 +6,9 @@
 import type { RenderdiffConfig } from "renderdiff";
 
 export default {
-  // The two origins. The tool has no notion of which is "prod" — it just diffs them.
+  // left: the build you changed (usually localhost). right: the reference you must match
+  // (usually production). The +/- signs in the output and text.added/removed in
+  // results.json are written from left's point of view.
   left: "http://localhost:3000",
   right: "https://example.com",
 
@@ -21,8 +23,33 @@ export default {
     "/pricing::/plans",
     { left: "/blog", right: "/posts" },
     { left: "/pricing", selector: { left: ".plans-v2", right: ".plans" } },
+    // `before` runs on each side after the page loads, before it settles and is shot, so
+    // the open menu is what gets measured. Replaces the top-level `before` for this route.
+    {
+      left: "/docs",
+      before: async (page) => {
+        await page.click("[aria-label=Menu]");
+      },
+    },
   ],
 
+  // For every route without its own `before`, CLI routes included. Gets
+  // `{ side, route, width }`; use `side` only for markup that legitimately differs per
+  // side, never to make the two sides look alike. A throw is a route error, not retried.
+  // Actions use Playwright's 30s default timeout, so check first for what may not be
+  // there. hideSelectors and extraCss apply after the hook.
+  before: async (page) => {
+    const accept = page.getByRole("button", { name: "Accept" });
+    if (await accept.isVisible()) await accept.click();
+  },
+
+  // Playwright storage state (cookies, localStorage) each side starts with, e.g. signed
+  // in: `npx playwright codegen --save-storage=auth.json <url>`. One file, or
+  // `{ left, right }`. Relative to this file. It holds live session tokens: never commit
+  // it, and add it to .gitignore. The out dir then holds signed-in screenshots and text,
+  // so keep it out of git and don't publish it either. `--storage-state` replaces it.
+  storageState: "auth.json",
+
   // Replaces the default set (1440, 1152, 896, 704, 375).
   widths: [1440, 896, 375],
 
@@ -32,7 +59,8 @@ export default {
   // Relative to the directory you run in. Wiped at the start of each run.
   outDir: "renderdiff-out",
 
-  // Captures run in parallel. Keep it low if the right origin is someone's live site.
+  // Captures run in parallel. Default half the CPU cores, between 2 and 8. Keep it low if
+  // the right origin is someone's live site.
   concurrency: 2,
 
   // Appended to the built-in analytics/consent/A-B blocklist. Aborted at the network