Skip to content

fix(cli): improve error message for zero-duration composition renders #129

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
+22 −2
Closed

fix(cli): improve error message for zero-duration composition renders #129

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
24 changes: 22 additions & 2 deletions packages/cli/src/commands/render.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -256,7 +256,13 @@ async function renderDocker(
});
await producer.executeRenderJob(job, projectDir, outputPath);
} catch (error: unknown) {
handleRenderError(error, options, startTime, true, "Check Docker is running: docker info");
handleRenderError(
error,
options,
startTime,
true,
renderHintForError(error, "Check Docker is running: docker info"),
);
}

const elapsed = Date.now() - startTime;
Expand Down Expand Up @@ -297,7 +303,13 @@ async function renderLocal(
try {
await producer.executeRenderJob(job, projectDir, outputPath, onProgress);
} catch (error: unknown) {
handleRenderError(error, options, startTime, false, "Try --docker for containerized rendering");
handleRenderError(
error,
options,
startTime,
false,
renderHintForError(error, "Try --docker for containerized rendering"),
);
}

const elapsed = Date.now() - startTime;
Expand All @@ -312,6 +324,14 @@ function getMemorySnapshot() {
};
}

function renderHintForError(error: unknown, fallback: string): string {
const message = error instanceof Error ? error.message : String(error);
if (message.includes("__hf not ready")) {
return "Composition may have zero duration. Add data-duration to the root element or ensure the GSAP timeline has tweens.";
}
return fallback;
}

function handleRenderError(
error: unknown,
options: RenderOptions,
Expand Down
Loading