add-cli-option 是做什麼的?
新增一個 Remotion CLI 或設定選項,透過建立 AnyRemotionOption、註冊 CLI 解析、連結設定 setter 並更新文件。在新增或轉換命令列旗標或 Remotion 選項時使用。
步驟說明
- 建立選項定義:在
packages/core/src/options/目錄下建立一個新的AnyRemotionOption實例,包含名稱、類型、預設值與說明。 - 註冊 CLI 解析:在
packages/cli/src/parse-command-line.ts或對應的 CLI 解析檔案中,將新選項對應的命令列旗標(例如--my-flag)註冊到解析器中。 - 連結 config setter:在
packages/core/src/config/中的適當模組內,實作設定 setter 與 getter,並將 CLI 解析結果傳遞給 config。 - 更新文件:修改
packages/docs/docs/cli/或packages/docs/docs/config/下的說明文件,以包含新選項的用法與範例。 - 測試與驗證:新增測試案例確保選項在不同情境下正常運作,包括 CLI 傳入與 config 物件設定。
注意:若選項用於轉換現有環境變數或設定,務必同時廢棄舊有方式並提供遷移指南。