mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-09-05 00:56:23 +00:00
* fix(lint): ignore scripts inside quoted attributes * Address PR review feedback (#2223) - replace repeated attribute scanner with quoted tag ranges - remove the Fallow complexity finding * refactor(lint): parse HTML structure with htmlparser2 * fix(lint): traverse template style sources * test(lint): cover nested template style sources
150 lines
5.4 KiB
TypeScript
150 lines
5.4 KiB
TypeScript
import { afterEach, describe, it, expect, vi } from "vitest";
|
|
import { lintHyperframeHtml, lintMediaUrls } from "./hyperframeLinter.js";
|
|
|
|
afterEach(() => vi.unstubAllGlobals());
|
|
|
|
describe("lintHyperframeHtml — orchestrator", () => {
|
|
const validComposition = `
|
|
<html>
|
|
<body>
|
|
<div id="root" data-composition-id="comp-1" data-width="1920" data-height="1080" data-start="0">
|
|
<div id="stage"></div>
|
|
</div>
|
|
<script src="https://cdn.gsap.com/gsap.min.js"></script>
|
|
<script>
|
|
window.__timelines = window.__timelines || {};
|
|
const tl = gsap.timeline({ paused: true });
|
|
tl.to("#stage", { opacity: 1, duration: 1 }, 0);
|
|
window.__timelines["comp-1"] = tl;
|
|
</script>
|
|
</body>
|
|
</html>`;
|
|
|
|
it("reports no errors for a valid composition", async () => {
|
|
const result = await lintHyperframeHtml(validComposition);
|
|
expect(result.ok).toBe(true);
|
|
expect(result.errorCount).toBe(0);
|
|
});
|
|
|
|
it("attaches filePath to findings when option is set", async () => {
|
|
const html = "<html><body><div></div></body></html>";
|
|
const result = await lintHyperframeHtml(html, { filePath: "test.html" });
|
|
for (const finding of result.findings) {
|
|
expect(finding.file).toBe("test.html");
|
|
}
|
|
});
|
|
|
|
it("deduplicates identical findings", async () => {
|
|
const html = `
|
|
<html><body>
|
|
<div id="root"></div>
|
|
<script>const tl = gsap.timeline();</script>
|
|
</body></html>`;
|
|
const result = await lintHyperframeHtml(html);
|
|
const codes = result.findings.map((f) => `${f.code}|${f.message}`);
|
|
const uniqueCodes = [...new Set(codes)];
|
|
expect(codes.length).toBe(uniqueCodes.length);
|
|
});
|
|
|
|
it("strips <template> wrapper before linting composition files", async () => {
|
|
const html = `<template id="my-comp-template">
|
|
<div data-composition-id="my-comp" data-width="1920" data-height="1080"
|
|
style="position:relative;width:1920px;height:1080px;">
|
|
<div id="stage"></div>
|
|
</div>
|
|
<script>
|
|
window.__timelines = window.__timelines || {};
|
|
const tl = gsap.timeline({ paused: true });
|
|
tl.to("#stage", { opacity: 1, duration: 1 }, 0);
|
|
window.__timelines["my-comp"] = tl;
|
|
</script>
|
|
</template>`;
|
|
const result = await lintHyperframeHtml(html, { filePath: "compositions/my-comp.html" });
|
|
const missing = result.findings.filter(
|
|
(f) => f.code === "missing-composition-id" || f.code === "missing-dimensions",
|
|
);
|
|
expect(missing).toHaveLength(0);
|
|
});
|
|
|
|
it("ignores comments that mention template tags before the real template", async () => {
|
|
const html = `<!doctype html>
|
|
<html>
|
|
<head>
|
|
<!-- Authoring note: styles and scripts live inside <template>. -->
|
|
</head>
|
|
<body>
|
|
<template id="my-comp-template">
|
|
<style>#root { width: 1920px; height: 1080px; }</style>
|
|
<div data-composition-id="my-comp" data-width="1920" data-height="1080">
|
|
<div id="stage"></div>
|
|
</div>
|
|
<script>
|
|
window.__timelines = window.__timelines || {};
|
|
const tl = gsap.timeline({ paused: true });
|
|
tl.to("#stage", { opacity: 1, duration: 1 }, 0);
|
|
window.__timelines["my-comp"] = tl;
|
|
</script>
|
|
</template>
|
|
</body>
|
|
</html>`;
|
|
const result = await lintHyperframeHtml(html, { filePath: "compositions/my-comp.html" });
|
|
const rootFindings = result.findings.filter(
|
|
(f) => f.code === "root_missing_composition_id" || f.code === "root_missing_dimensions",
|
|
);
|
|
expect(rootFindings).toHaveLength(0);
|
|
});
|
|
|
|
it("strips comments whose markers re-form after one pass (no decoy template survives)", async () => {
|
|
// Adjacent comment markers: removing the inner `<!-- -->` in a single pass
|
|
// re-joins `<` + `!-- … -->` into a fresh, complete `<!-- … -->` that a lone
|
|
// global replace leaves behind — surfacing a decoy <template> with no
|
|
// composition-id. A fixpoint strip removes it; this guards that behavior.
|
|
const html = `<!doctype html>
|
|
<html>
|
|
<body>
|
|
<<!-- -->!-- <template id="decoy-template"></template> -->
|
|
<template id="my-comp-template">
|
|
<style>#root { width: 1920px; height: 1080px; }</style>
|
|
<div data-composition-id="my-comp" data-width="1920" data-height="1080">
|
|
<div id="stage"></div>
|
|
</div>
|
|
<script>
|
|
window.__timelines = window.__timelines || {};
|
|
const tl = gsap.timeline({ paused: true });
|
|
tl.to("#stage", { opacity: 1, duration: 1 }, 0);
|
|
window.__timelines["my-comp"] = tl;
|
|
</script>
|
|
</template>
|
|
</body>
|
|
</html>`;
|
|
const result = await lintHyperframeHtml(html, { filePath: "compositions/my-comp.html" });
|
|
const rootFindings = result.findings.filter(
|
|
(f) => f.code === "root_missing_composition_id" || f.code === "root_missing_dimensions",
|
|
);
|
|
expect(rootFindings).toHaveLength(0);
|
|
});
|
|
});
|
|
|
|
describe("lintMediaUrls", () => {
|
|
it("checks top-level remote media elements", async () => {
|
|
const fetchMock = vi.fn().mockResolvedValue({ ok: true, status: 200 });
|
|
vi.stubGlobal("fetch", fetchMock);
|
|
|
|
await lintMediaUrls('<img id="hero" src="https://example.com/hero.png">');
|
|
|
|
expect(fetchMock).toHaveBeenCalledWith(
|
|
"https://example.com/hero.png",
|
|
expect.objectContaining({ method: "HEAD" }),
|
|
);
|
|
});
|
|
|
|
it("ignores remote media embedded inside an iframe srcdoc attribute", async () => {
|
|
const fetchMock = vi.fn();
|
|
vi.stubGlobal("fetch", fetchMock);
|
|
|
|
await lintMediaUrls(`<iframe srcdoc='<img src="https://example.com/embedded.png">'></iframe>`);
|
|
|
|
expect(fetchMock).not.toHaveBeenCalled();
|
|
});
|
|
});
|