Skip to content

fix(lint): flag videos nested in visual wrappers #2362

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

Closed
miguel-heygen wants to merge 1 commit into from
+44 −51
Closed

fix(lint): flag videos nested in visual wrappers #2362

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
21 changes: 21 additions & 0 deletions packages/lint/src/rules/media.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,27 @@ describe("media rules", () => {
expect(finding).toBeUndefined();
});

it("reports video nested in an untimed visual wrapper", async () => {
// The renderer only discovers managed media that are direct children of
// the host composition root. An untimed wrapper is enough to make the
// video render black even though the wrapper itself is not a clip.
const html = `
<html><body>
<div id="root" data-composition-id="c1" data-width="1920" data-height="1080">
<div class="video-shell">
<video id="wrapped-video" src="clip.mp4" data-start="0" data-duration="5" muted playsinline></video>
</div>
</div>
<script>window.__timelines = window.__timelines || {}; window.__timelines["c1"] = gsap.timeline({ paused: true });</script>
</body></html>`;
const result = await lintHyperframeHtml(html);
const finding = result.findings.find((f) => f.code === "video_nested_in_timed_element");
expect(finding).toBeDefined();
expect(finding?.severity).toBe("error");
expect(finding?.elementId).toBe("wrapped-video");
expect(finding?.fixHint).toContain("direct child");
});

it("reports imperative play() control on managed media ids", async () => {
const html = `
<html><body>
Expand Down
74 changes: 23 additions & 51 deletions packages/lint/src/rules/media.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -283,61 +283,33 @@ export const mediaRules: Array<(ctx: LintContext) => HyperframeLintFinding[]> =
},

// video_nested_in_timed_element
({ source, tags }) => {
({ tags, rootTag }) => {
const findings: HyperframeLintFinding[] = [];
// HTML5 void elements cannot contain children, so they can never be a
// parent of a nested <video>. Skipping them avoids false positives where
// the linter looks for `</img>` and never finds it.
const voidElements = new Set([
"area",
"base",
"br",
"col",
"embed",
"hr",
"img",
"input",
"link",
"meta",
"source",
"track",
"wbr",
]);
const timedTagPositions: Array<{ name: string; start: number; id?: string }> = [];
for (const tag of tags) {
if (tag.name === "video" || tag.name === "audio") continue;
if (voidElements.has(tag.name)) continue;
// Skip the composition root — it uses data-start as a playback anchor, not as a clip timer
if (readAttr(tag.raw, "data-composition-id")) continue;
if (readAttr(tag.raw, "data-start")) {
timedTagPositions.push({
name: tag.name,
start: tag.index,
id: readAttr(tag.raw, "id") || undefined,
});
}
}
for (const tag of tags) {
if (tag.name !== "video") continue;
if (!readAttr(tag.raw, "data-start")) continue;
for (const parent of timedTagPositions) {
if (parent.start < tag.index) {
const parentClosePattern = new RegExp(`</${parent.name}>`, "gi");
const between = source.substring(parent.start, tag.index);
if (!parentClosePattern.test(between)) {
findings.push({
code: "video_nested_in_timed_element",
severity: "error",
message: `<video> with data-start is nested inside <${parent.name}${parent.id ? ` id="${parent.id}"` : ""}> which also has data-start. The framework cannot manage playback of nested media — video will be FROZEN in renders.`,
elementId: readAttr(tag.raw, "id") || undefined,
fixHint:
"Move the <video> to be a direct child of the stage, or remove data-start from the wrapper div (use it as a non-timed visual container).",
snippet: truncateSnippet(tag.raw),
});
break;
}
}
}
const parent = tags
.filter(
(candidate) =>
candidate !== tag &&
candidate.index < tag.index &&
candidate.closeIndex != null &&
candidate.closeIndex > tag.index,
)
.sort((a, b) => b.index - a.index)[0];
if (!parent || parent === rootTag) continue;

const parentId = readAttr(parent.raw, "id") || undefined;
const parentIsTimed = readAttr(parent.raw, "data-start") != null;
findings.push({
code: "video_nested_in_timed_element",
severity: "error",
message: `<video> with data-start is nested inside <${parent.name}${parentId ? ` id="${parentId}"` : ""}>${parentIsTimed ? " which also has data-start" : ""}. Managed video must be a direct child of the host composition root or it can render FROZEN/black.`,
elementId: readAttr(tag.raw, "id") || undefined,
fixHint:
"Move the <video> to be a direct child of the composition root/stage. Apply sizing and motion to the video itself or to a separate overlay element.",
snippet: truncateSnippet(tag.raw),
});
}
return findings;
},
Expand Down
Loading