add-cli-option は何をしますか?
新しいRemotion CLIまたは設定オプションを追加するには、AnyRemotionOptionを作成し、CLIパースを登録し、設定セッターを配線し、ドキュメントを更新します。コマンドラインフラグやRemotionオプションの追加・変換時に使用してください。
手順
- 新しいオプションの型定義 — 型安全なオプションを
AnyRemotionOptionとして定義します。 - CLI引数パースの登録 — コマンドラインから値を受け取るためのパース処理を登録します。
- 設定セッターとの連携 — Remotionの設定システム(
Configオブジェクト)に値を書き込むセッター関数を作成します。 - ドキュメントの更新 — 新しいオプションの説明、デフォルト値、使用例を関連ドキュメントに追加します。
例
import { AnyRemotionOption } from "remotion";
export const myNewOption: AnyRemotionOption = {
name: "my-option",
cliFlag: "my-option" as const,
description: "新しいオプションの説明",
docLink: "https://remotion.dev/docs/my-option",
type: "string" as const,
defaultValue: "default-value",
};
注意事項
- 既存のオプションとの競合を避けてください。
- すべての変更はTypeScriptの型チェックをパスする必要があります。
- ドキュメントは必ず日本語(または対象ロケール)で記述してください。