mcpField
D
deprecate-api

deprecate-api

github.com/remotion-dev開発68.6k368 回インストール今日更新
リポジトリ

deprecate-api について

Remotion の公開 API に一貫した非推奨注釈とドキュメント形式を適用するスキルです。利用可能な非推奨 API を対象とし、削除済み API や未標準化の規則との境界も示します。

主な機能

  1. 01JSDoc @deprecated 注釈
  2. 02ドキュメント見出しの取り消し線
  3. 03代替案を示す Deprecated 告知
  4. 04公開 API の適用範囲の整理

活用シーン

  1. 01TypeScript API に代替案を注記
  2. 02非推奨のプロパティやオプションの文書更新
  3. 03API 削除の扱いが規則の範囲内か確認

インストール

コマンドをコピーしてターミナルで実行します。

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

インストール後、Claude Code で/deprecate-apiを入力して読み込まれたか確認します。

詳細

Remotion における API の非推奨化

利用可能な状態を保ったまま公開 API を非推奨にすることは、次の 3 か所で表現します。

  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?`~~

フロントマターの title は変更しません。それ以外にフロントマターのタイトルしか使用していないページには、取り消し線を付けた見出しを明示的に設けます。

Deprecated という名前の info アドモニションを見出しの直後に配置し、代替手段がある場合はその内容を示します。

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

対象範囲

実行時の警告、サイドバーのバッジ、リリースノート、削除バージョン、削除時の動作は、現在、API の非推奨化に関する規約として標準化されていません。

削除済みの API は、この規約の対象外です。移行を目的として引き続きドキュメントに記載する場合はありますが、アノテーションを付ける公開シンボルはすでに存在しません。

コメント

Markdown 対応