remotion-brand-codify
調査結果を、すべてのコンポジションが読み取る型付きコードに変換します。
トリガー
remotion-brand-researchが.research/以下に報告書を作成した後。- ユーザーがブランドカラー、フォント、トーンノートを貼り付け、「{ブランド名} ブランドをコード化して」と指示した場合。
入力
.research/brand-{slug}-{date}.json(推奨)またはマークダウン形式の報告書- 既存の
Synthex/packages/brand-config/src/brands/{slug}.ts(差分確認用)
方法
- 報告書が
BrandConfigの必須フィールドをすべてカバーしていることを検証します(Synthex/packages/brand-config/src/types.tsを参照)。フィールドが不足している場合は処理をブロックし、remotion-brand-researchに補完を依頼します。 - 境界コントラクトを適用します — カラー16進数コード / タイポグラフィスケール / スペーシング / コンポーネント / レイアウトは
.design.mdに、音声 / ナレーション / モーション / オーディエンス / チャンネル / 禁止ワード / ロゴパス / 署名は.tsに配置します。Pi-Dev-Ops/remotion-studio/src/brands/CONTRACT.mdを参照してください。 - 各色について、パレットの色数が5未満であるか、WCAG-AA(
text on primary)に失敗する場合、remotion-colour-familyを実行します。カラーファミリースキルは、.design.mdのcolors:セクションに直接挿入可能なYAMLブロックを出力します。 - モーションについて、
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 のワークスペースリンクを介して Pi-Dev-Ops のローカルコピーを読み取ります。 - スラッグが新しい場合は、
Synthex/packages/brand-config/src/brands/index.tsを更新します(types.tsのBrandSlugユニオンも拡張します)。 Pi-Dev-Ops/remotion-studio/src/brands/{slug}.mdに、.tsと.design.mdの両方から読み取った人間可読な9セクションのプロジェクションを再生成します。セクション2(カラーパレット)、3(タイポグラフィ)、4(コンポーネント)、5(レイアウト)は.design.mdから取得し、セクション1、6、7、8、9は.tsと補足的な散文から取得します。
出力
ブランドごとに3つの編集済みファイル:
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— 9セクションの人間可読なプロジェクション(両方から再生成、手動編集禁止)
さらに、 Pi-Dev-Ops/packages/brand-config/src/brands/{slug}.design.md へのランタイムミラーリング(#2 のコピー — ブランド設定の統合によりローカルコピーが削除されるまで同期を維持)。
9セクションの .md プロジェクションは、.ts + .design.md の投影であり、並列する情報源ではありません。いずれかのソースが変更されるたびに再生成し、手動で編集しないでください。セクションの順序は固定です:
- ビジュアルテーマと雰囲気(
.tsの音声+オーディエンスの散文から) - カラーパレットと役割(
.design.mdのcolors:を反映したテーブル、ダークバリアントの行が定義されている場合はそれも含む) - タイポグラフィルール(
.design.mdのtypography:およびライセンス追跡のためのBrandTypographyのファミリー/ウェイトから) - コンポーネントスタイリング(
.design.mdのcomponents:から) - レイアウト原則(
.design.mdのspacing.outer-margin-*およびBrandLogo.safeAreaPxから) - 奥行きとエレベーション(
.design.mdのエレベーションに関する散文から) - Do's and Don'ts(
.tsのdoNotとvoice.forbiddenWords、および.design.mdの Do's/Don'ts セクションを連結) - レスポンシブ動作(
.tsのアスペクト比、.design.mdの比率ごとのタイプスケールから) - エージェントプロンプトガイド(
{colors.*}とmotion.signatureトークンを呼び出すリテラル例を1つ含む)
さらに、以下の内容を要約したPR(またはローカル差分)を作成します:
- ソース報告書のパス
- 入力されたフィールドと創業者レビューに委ねられたフィールド
- リントステータス(
design.md lintのエラー/警告、フォントライセンス、コントラスト) - 出力された3つのファイルすべて(
.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ファイル(最大1つを引用)
再利用されるユーティリティ
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プロジェクション内でビジュアルスクールアンカーとして最大1つを引用します。逐語的にコピーしないでください。- 参照プロジェクション:
remotion-studio/src/brands/ra.mdはミラーリングする正規の例です。