Skip to content

report: captions say which side is the change and which the reference #158

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tmashara merged 1 commit into from
Nov 5, 2026
+20 −5
Merged

report: captions say which side is the change and which the reference #158

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions src/report.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -492,20 +492,22 @@ const head = (r: ComparedResult) => `
<span class="px">${r.diffPixels.toLocaleString()} / ${r.totalPixels.toLocaleString()} px differ</span>
</header>`;

const ROLE = { left: "left · change", right: "right · reference" };

function card(r: ComparedResult): string {
const imgs = r.images;
return `
<article class="card" id="${esc(cardId(r))}">${head(r)}
${findings(r)}
<div class="grid">
<figure><figcaption>left</figcaption><a href="${imgs.left}" target="_blank"><img loading="lazy" src="${imgs.left}"></a></figure>
<figure><figcaption>right</figcaption><a href="${imgs.right}" target="_blank"><img loading="lazy" src="${imgs.right}"></a></figure>
<figure><figcaption>${ROLE.left}</figcaption><a href="${imgs.left}" target="_blank"><img loading="lazy" src="${imgs.left}"></a></figure>
<figure><figcaption>${ROLE.right}</figcaption><a href="${imgs.right}" target="_blank"><img loading="lazy" src="${imgs.right}"></a></figure>
<figure><figcaption>diff</figcaption>${imgs.diff ? `<a href="${imgs.diff}" target="_blank"><img loading="lazy" src="${imgs.diff}"></a>` : `<p class="nodiff">no differing pixels</p>`}</figure>
</div>
<div class="slider" style="--x:50%">
<img loading="lazy" src="${imgs.right}">
<div class="l"><img loading="lazy" src="${imgs.left}"></div>
<input type="range" value="50" aria-label="Divider: left shot on the left, right shot on the right">
<input type="range" value="50" aria-label="Divider: your change on the left, the reference on the right">
</div>
</article>`;
}
Expand Down Expand Up @@ -658,7 +660,7 @@ ${sidebar(results, meta.threshold)}
<main>
<h1>Visual diff</h1>
<p class="meta">
left <code>${esc(meta.left)}</code> vs right <code>${esc(meta.right)}</code><br>
${ROLE.left} <code>${esc(meta.left)}</code> vs ${ROLE.right} <code>${esc(meta.right)}</code><br>
${esc(meta.generatedAt)} &middot; ${esc(meta.browser.name)} ${esc(meta.browser.version)}${(
["left", "right"] as const
)
Expand Down Expand Up @@ -780,7 +782,7 @@ ${STYLE}

<h1>${esc(title)}</h1>
<p class="meta">
left <code>${esc(meta.left)}</code> vs right <code>${esc(meta.right)}</code><br>
${ROLE.left} <code>${esc(meta.left)}</code> vs ${ROLE.right} <code>${esc(meta.right)}</code><br>
${esc(meta.generatedAt)} &middot; renderdiff ${esc(meta.version)} &middot;
widths ${meta.widths.join(", ")} &middot;
threshold ${meta.threshold === null ? "none" : pct(meta.threshold)} &middot;
Expand Down
13 changes: 13 additions & 0 deletions tests/unit/report.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -313,6 +313,19 @@ describe("writeReport", () => {
);
});

test("the report and evidence name left as the change and right as the reference", async () => {
const html = await report([at("/a", 1440)]);
const sides =
/left · change <code>http:\/\/localhost:3000<\/code> vs right · reference <code>https:\/\/example\.com<\/code>/;
assert.match(html, sides);
assert.match(await evidence([at("/a", 1440)]), sides);
assert.deepEqual(
[...html.matchAll(/<figcaption>([^<]+)/g)].map((m) => m[1]),
["left · change", "right · reference", "diff"],
);
assert.match(html, /aria-label="Divider: your change on the left, the reference on the right"/);
});

test("a packed zero-diff card says so in place of the diff image", async () => {
const images = { left: "a.1440.left.webp", right: "a.1440.left.webp" };
const html = await report([at("/a", 1440, { images })]);
Expand Down
Loading