remotion-brand-codify
将研究成果转换为每个组合都能读取的类型化代码。
触发器
- 在
remotion-brand-research将档案写入.research/之后。 - 用户粘贴品牌颜色、字体和语调笔记,并说“codify the {brand} 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)作为规范示例。 - Lint 检查 design.md——运行
npx --prefix Pi-Dev-Ops/remotion-studio design.md lint Synthex/packages/brand-config/src/brands/{slug}.design.md。遇到错误则阻止。警告是建议性的——仅当未使用的令牌没有语义意图时才修复 unreferenced-token 警告。 - 镜像到运行时位置——
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 中的工作区链接读取 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.mdcolors:,如果定义了暗色变体行则包含) - 排版规则(来自
.design.mdtypography:+ 来自BrandTypography的族/字重,用于许可追溯) - 组件样式(来自
.design.mdcomponents:) - 布局原则(来自
.design.mdspacing.outer-margin-*+BrandLogo.safeAreaPx) - 深度与海拔(来自
.design.md海拔散文) - 应做与不应做(连接
.tsdoNot+voice.forbiddenWords+.design.md的应做/不应做部分) - 响应行为(来自
.ts的宽高比,每个比例的字体缩放来自.design.md) - 代理提示指南(一个文字示例,调用
{colors.*}和motion.signature令牌)
加上一个 PR(或本地 diff)总结:
- 来源档案路径
- 已填字段与留给创始人审查的字段
- Lint 状态(
design.md lint错误/警告,字体许可,对比度) - 所有三个发出文件(
.ts+.design.md+.md投影)——缺少成品则阻止
边界
- 始终设置 PR
auto-merge:false——品牌语音的细微差别必须由人类审核。 - 切勿静默覆盖现有文件;生成并排差异。
- 切勿发明字体或颜色——值来自研究档案,否则默认为中性备用值,并附带
// TODO: founder review注释。 - 切勿在
.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是要镜像的规范示例