mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-08-31 02:41:44 +00:00
Miguel Ángel
406bf316a3
* fix(catalog): make component previews answer their variables panel Every control on a component's catalog page did nothing. Asking caption-camera-follow for a violet accent rendered gold, and so did green and blue, on 166 of the 168 components that declare variables. A component ships a snippet, which is what the page hands you to paste and which carries the declaration plus the script that turns a chosen value into a CSS custom property, and a demo.html which stages and animates it. The preview is built from the demo, and the demo was authored as a copy of the snippet rather than a reference to it. The copies drifted until almost none of them carried the declaration or the reader, so the payload for that page never contained the word violet at all. Components come in two shapes, so the repair does too. 123 ship a snippet that registers its own paused timeline. That snippet is a whole piece, so their preview is now built from it and carries markup, variables and motion together. 45 are markup plus a commented recipe, where the demo owns the motion. Those demos now carry the snippet's declaration, reader and var-driven CSS in the registry itself, written by scripts/catalog/sync-demo-variables.ts. Nothing is patched in at build time. A test runs that tool in dry mode and fails when a demo has drifted again, naming the command that repairs it. It also asserts it inspected more than a hundred components, because a check that silently matches nothing is how this rotted in the first place. Measured by rendering every payload in a real player rather than by reading markup: payloads declaring their variables go from 2 of 168 to 168 of 168, previews that animate go from 166 to 167, and nothing that moved stopped moving. ascii-render-pass and star-rating-fill render a still frame when built from their snippet, so they keep the demo path as a recorded exception and stay in the state they were already in. * refactor(catalog): give the preview pipeline one lookup and one entrypoint guard Follow-up on the same branch, no behaviour change: 42 tests still pass and `sync-demo-variables --check` still reports all 168 components clean. The payload generator and the demo sync had each grown their own copy of "given a component directory, find the snippet and the demo". Both now call `componentFiles`, which is the same duplication-by-copying that broke the previews in the first place. Both catalog generators also carried a byte-identical 12-line guard for "only run main() when this file is the entrypoint". That clone was already in the tree, but nothing had touched both files at once before, so it had never surfaced. It is now `runAsCommand`, and the sync script's variant of the same condition is `isEntrypoint`. The rest is flattening: the layering guards read as a table of conditions instead of a chain, the reporting splits by what it reports, and the entry resolution comes out of `buildPayload` rather than being spliced into it. Also runs the formatter over the demos this branch rewrote. Whitespace only, and `notes-typing` is the only component demo that renders pre-formatted text, which this does not touch.
35 lines
1.4 KiB
TypeScript
35 lines
1.4 KiB
TypeScript
import { describe, expect, it } from "vitest";
|
|
|
|
import { syncDemoVariables } from "./sync-demo-variables.ts";
|
|
|
|
/**
|
|
* The invariant this defends.
|
|
*
|
|
* A component's `demo.html` was authored as a copy of its snippet, and the
|
|
* copies drifted until almost none of them carried the variable declaration or
|
|
* the script that reads a chosen value. The catalog preview is built from the
|
|
* demo, so those pages showed a variables panel that could not change anything.
|
|
*
|
|
* Running in dry mode reports what it *would* rewrite. Anything it would
|
|
* rewrite is a demo that has drifted again, and a drifted demo is a dead panel
|
|
* on that component's catalog page, so this fails rather than letting it ship.
|
|
*/
|
|
describe("component demos carry their snippet's variables", () => {
|
|
it("has nothing left to sync", () => {
|
|
const wouldChange = syncDemoVariables(false)
|
|
.filter((r) => r.status === "synced")
|
|
.map((r) => r.name);
|
|
|
|
expect(
|
|
wouldChange,
|
|
`these demos no longer carry their snippet's variables, so their catalog ` +
|
|
`page would render a dead panel. Run: npx tsx scripts/catalog/sync-demo-variables.ts`,
|
|
).toEqual([]);
|
|
});
|
|
|
|
it("actually inspects the catalog rather than passing on an empty set", () => {
|
|
// A check that silently matched nothing would pass forever.
|
|
expect(syncDemoVariables(false).length).toBeGreaterThan(100);
|
|
});
|
|
});
|