@design-parity/export-driver

The design-artifacts export driver. It turns a rendered @Preview module and a catalog.spec.json into the importable design-artifacts/<system> delivery branch that preview.coo.ee serves and the Figma importer reads: the catalog, design pages, design references, parity findings and issues, and the Remote Compose comparison lanes.

Rendering itself is the compose-preview CLI's job; the driver reads its output.

Running a script

Every script is one file in this package. Run any of them through the design-artifacts command, with the script's name and its own arguments:

npx -p @design-parity/export-driver@<version> design-artifacts validate-catalog-spec --spec catalog.spec.json
npx -p @design-parity/export-driver@<version> design-artifacts generate-design-catalog --help

The name may carry its .mjs or .sh extension or not. Pin an exact version: the reusable workflow that runs this driver treats the version as the code it executes.

Four inputs default to paths beside or inside a compose-ai-tools checkout, which an installed package does not have. Pass them explicitly when running from the package:

• rc-compare --fonts <dir>: the typeface directory the Remote Compose lanes render with. RC_FONTS_DIR=<dir> sets the same default for every script and test; the published CMP/Wasm player distribution's fonts/ carries these faces.
• RC_PLAYER_JS_BUNDLE=<bundle.js>: the Remote Compose player bundle the browser lanes and tests load.
• COMPOSE_PREVIEW_SERVER_ROOT=<dir>: a compose-preview-server checkout (or just its server/src/main/resources/ee/schimke/composeai/cli/serve/assets/format-compare.js), which emit-design-references drives to bake each reference's match score. Without it the references publish unscored and the log says why.

Where the source is

This package is the driver's source, and its only copy: change it here. It started as a copy of compose-ai-tools' scripts/design-artifacts/ at 4986e21, which compose-ai-tools has since deleted. compose-ai-tools' workflows run this package, installed from a lockfile in .github/design-artifacts-driver/ that Renovate moves (docs/design-artifacts/CONSOLIDATION.md). bin/ and package-scripts/ exist only here.

Tests

npm test runs the driver's node --test suites through package-scripts/run-tests.mjs. That leaves out the checks that assert the driver agrees with compose-ai-tools itself (its workflow file, Kotlin sources, sample specs and lockfile), which compose-ai-tools runs against the installed package (its scripts/design-artifacts/driver-contract.test.mjs); the runner lists each with its reason. Without their inputs, the browser lanes skip (no Playwright Chromium or player bundle), the font checks are left out (no RC_FONTS_DIR) and the cross-repository mirrors skip (no COMPOSE_PREVIEW_SERVER_ROOT).

CI's export-driver-browser job supplies all of them: the published Remote Compose players from Maven Central at RC_PLAYERS_VERSION, their fonts/, three compose-preview-server sources from its latest release, and Chromium. It sets RC_CMP_WASM_REQUIRE and RC_PLAYER_JS_BUNDLE_REQUIRE, so there a missing input fails rather than skips.