remotion-brand-codify
將研究輸出轉換為每個合成都能讀取的型別化程式碼。
觸發條件
- 在
remotion-brand-research將檔案寫入.research/目錄後。 - 使用者貼上品牌顏色、字型和語調筆記,並說「將 {brand} 品牌程式碼化」。
輸入
.research/brand-{slug}-{date}.json(優先)或 Markdown 檔案- 如果已存在,則讀取現有
Synthex/packages/brand-config/src/brands/{slug}.ts以供差異比對
方法
- 驗證檔案是否涵蓋
BrandConfig的所有必要欄位(參見Synthex/packages/brand-config/src/types.ts)。缺少欄位則阻塞,並要求remotion-brand-research補齊。 - 套用邊界合約 — 顏色十六進位碼 / 字型比例 / 間距 / 元件 / 佈局進入
.design.md;語音 / 旁白 / 動作 / 觀眾 / 頻道 / 禁止詞 / Logo 路徑 / 簽名進入.ts。請參閱Pi-Dev-Ops/remotion-studio/src/brands/CONTRACT.md。 - 針對每個顏色,如果調色盤少於 5 種顏色或未通過
text on primary的 WCAG-AA 標準,則執行remotion-colour-family。色彩家族技能會輸出一個 YAML 區塊,可直接放入.design.md的colors:區段。 - 針對動作,如果
motion區塊為空,則執行remotion-motion-language。 - 針對字型,驗證授權:僅允許 OFL / Apache / MIT 系列字型。阻塞 Adobe Fonts(不允許伺服器端渲染)和付費 Google Fonts。
- 產生
Synthex/packages/brand-config/src/brands/{slug}.ts,僅包含執行期欄位(根據 CONTRACT.md)。以Synthex/packages/brand-config/src/brands/ra.ts為最佳範例。之後在Synthex/packages/brand-config/目錄下執行npm run build,以重新產生dist/。 - 產生
Synthex/packages/brand-config/src/brands/{slug}.design.md,僅包含視覺標記,並採用符合規格的@google/design.md格式。以任何現有的*.design.md(例如ra.design.md)為最佳範例。 - 檢查 design.md — 執行
npx --prefix Pi-Dev-Ops/remotion-studio design.md lint Synthex/packages/brand-config/src/brands/{slug}.design.md。錯誤則阻塞。警告僅作為建議 — 僅在未使用的標記沒有語義意圖時,才修復未引用標記的警告。 - 鏡像到執行期位置 —
cp Synthex/packages/brand-config/src/brands/{slug}.design.md Pi-Dev-Ops/packages/brand-config/src/brands/{slug}.design.md。執行期載入器 (loadDesign(slug)) 會透過 remotion-studio 中的 workspace-link 讀取 Pi-Dev-Ops 本地副本。 - 如果 slug 是新的,則更新
Synthex/packages/brand-config/src/brands/index.ts(同時在types.ts中擴充BrandSlug聯集型別)。 - 從
.ts和.design.md兩者讀取,重新產生位於Pi-Dev-Ops/remotion-studio/src/brands/{slug}.md的人類可讀九章節投影檔。章節 2(色彩調色板)、3(字型排版)、4(元件)、5(佈局)從.design.md提取;章節 1、6、7、8、9 從.ts及輔助文字提取。
輸出
每個品牌三個編輯過的檔案:
Synthex/packages/brand-config/src/brands/{slug}.ts— 型別的BrandConfig(執行期與行為,根據 RA-1985 為真實來源)。Synthex/packages/brand-config/src/brands/{slug}.design.md— 視覺標記(真實來源,符合@google/design.md規格)。Pi-Dev-Ops/remotion-studio/src/brands/{slug}.md— 九章節人類可讀投影檔(從兩者重新產生;切勿手動編輯)。
以及位於 Pi-Dev-Ops/packages/brand-config/src/brands/{slug}.design.md 的執行期鏡像(#2 的拷貝 — 保持同步,直到品牌設定檔合併移除本地副本)。
九章節 .md 投影檔是 .ts + .design.md 的投影,而非平行來源。每當任一來源變更時,請重新產生;切勿手動編輯。章節順序固定:
- 視覺主題與氛圍(來自
.ts的語音 + 觀眾說明) - 色彩調色板與角色(表格映射
.design.md的colors:,並包含深色變體行(如有定義)) - 字型排版規則(來自
.design.md的typography:,以及BrandTypography中的系列/粗細以追蹤授權) - 元件樣式(來自
.design.md的components:) - 佈局原則(來自
.design.md的spacing.outer-margin-*+BrandLogo.safeAreaPx) - 深度與高度(來自
.design.md的高度說明) - 注意事項與禁止事項(合併
.ts的doNot+voice.forbiddenWords+.design.md的注意/禁止事項章節) - 響應式行為(來自
.ts的長寬比,以及.design.md中每個長寬比的字型比例) - 代理程式提示指南(一個實際範例,調用
{colors.*}和motion.signature標記)
加上一個 PR(或本地差異)摘要:
- 來源檔案路徑
- 已填寫的欄位 vs 留待創始人審查的欄位
- 檢查狀態(
design.md lint錯誤 / 警告、字型授權、對比度) - 所有三個產出的檔案(
.ts+.design.md+.md投影)— 缺少成品則阻塞
邊界
- 始終將 PR 設為
auto-merge:false— 品牌語意的細微差異必須由人類審查。 - 切勿無聲覆寫現有檔案;產生並排差異。
- 切勿憑空發明字型或顏色 — 這些值來自研究檔案,或者預設為中立備用值,並加上
// TODO: 創始人審查註解。 - 切勿在
.ts和.design.md之間重複標記。 如果colour.primary存在於.design.md,則.ts不得重新宣告它。CONTRACT.md是仲裁者。 - 切勿手動編輯
.md投影檔 — 應從來源重新產生。
重複使用的資源
src/brands/CONTRACT.md— 標記所有權邊界src/brands/ra.design.md— 標準.design.md範例Synthex/packages/brand-config/src/brands/ra.ts— 標準.ts範例src/design-systems/_library/— 140 個供應的 DESIGN.md 檔案,用於視覺學派錨定(最多引用一個)
重複使用的工具
Synthex/packages/brand-config/src/types.ts— 真實來源結構(根據 RA-1985)remotion-studio/src/colour/index.ts— 用於 WCAG 檢查的contrast()函式remotion-studio/src/design-systems/_library/— 138 個供應的參考 DESIGN.md 檔案(開放設計,Apache-2.0)。在.md投影檔中最多引用一個作為視覺學派錨點;切勿逐字複製- 參考投影檔:
remotion-studio/src/brands/ra.md是可供鏡像的標準範例