mcpField
D
deprecate-api

deprecate-api

github.com/remotion-dev开发68.6k368 次安装今天更新
代码仓库

关于 deprecate-api

用于统一 Remotion 公共 API 弃用标注和文档格式的技能，涵盖仍可用的弃用 API，并说明已移除 API 与未标准化约定的边界。

主要功能

  1. 01添加 JSDoc @deprecated 注释
  2. 02文档标题使用删除线
  3. 03添加含替代方案的 Deprecated 提示
  4. 04界定公共 API 适用范围

适用场景

  1. 01为 TypeScript API 标注替代方案
  2. 02更新已弃用属性或选项的文档
  3. 03确认 API 移除行为是否在规范范围内

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/remotion-dev/remotion --skill deprecate-api

安装后在 Claude Code 中输入/deprecate-api确认已加载。

详细介绍

Remotion 中的 API 弃用

仍然可用的公共 API，其弃用状态通过以下三个位置体现：

  1. 在公共 TypeScript API 上添加 JSDoc @deprecated 注解。
  2. 为 API 的文档标题添加删除线格式。
  3. 在该标题正下方添加名为 Deprecated 的 info 提示框。

这些约定适用于函数、组件、钩子、类型、属性、选项及其他公共 API。

TypeScript 表示方式

公共符号带有 JSDoc @deprecated 注解。如果存在替代项，该注解会注明替代项，并可链接到其文档。

/**
 * @deprecated Use `newApi()` instead: https://www.remotion.dev/docs/new-api
 */
export const oldApi = () => {};

注解应添加在使用者实际接触到的位置。对于重新导出或兼容性别名，应将注解添加到导出的符号上，而不是未弃用的实现上。

文档表示方式

弃用 API 的名称在标题中使用双波浪号删除线。<AvailableFrom> 保持在删除线之外。

# ~~oldApi()~~<AvailableFrom v="4.0.0" />

对于属性或选项：

### ~~`oldOption?`~~

frontmatter 中的 title 保持不变。若页面原本只依赖 frontmatter 标题，则应添加带有删除线的显式标题。

名为 Deprecated 的 info 提示框应紧跟在标题后面；如果存在替代项，应在其中指向该替代项。

:::info Deprecated
Use [`newApi()`](/docs/new-api) instead.
:::

适用范围

运行时警告、侧边栏徽标、发行说明、移除版本和移除行为，目前尚未纳入 API 弃用的标准。

已移除的 API 不属于本约定。为了帮助迁移，相关文档可以保留，但已移除的 API 不再有可添加注解的公共符号。

评论

支持 Markdown