Skip to main content

实现新选项

指定选项的方式​

有多种指定选项的方式：

  • 可通过 Node.JS 调用的 API 可直接接受参数。
  • 影响渲染的选项可以添加到 Remotion Studio 中的渲染对话框。
  • 如果操作可作为 CLI 命令使用，则选项也应作为 CLI 标志添加。
  • 配置 文件也可用于指定多个选项。
    note

    在执行 CLI 命令时不应读取配置文件，否则应忽略其值。

选项解析​

应按以下顺序解析选项：

直接传递给 Node.JS API
2
 通过 Remotion Studio 中的渲染 UI 指定
3
 通过 CLI 标志 指定
4
 通过 配置文件 指定
5
 回退到默认值

命名​

应使用 camelCase 命名 Node.JS 中的选项，使用 hyphen-case 命名 CLI 接受的选项。

接受数值的选项应在名称中包含单位。例如，应使用 durationInFrames 而不是 duration 或 timeoutInMilliseconds 而不是 timeout。

文档​

应在 API 参考 和 CLI 参考 中记录选项。

请注意选项从哪个版本开始可用。

测试 CLI 更改​

请查看贡献文档中的 运行 CLI 部分。

添加 CLI 自动完成​

在 cli-autocomplete 包的 src/source.ts 中，您可以添加新选项。使用 Fig 的用户将能够准确自动完成您的功能。

参见​