playwright-api について
Playwright API を変更するコントリビューター向けのリポジトリスキルです。API 定義、実装、プロトコルチャネル、ディスパッチャー、テスト、lint の順序を示します。
主な機能
- 01API 定義と実装の手順
- 02プロトコルチャネル更新のガイド
- 03ディスパッチャー実装のガイド
- 04テスト配置とコマンド
- 05lint の手順
活用シーン
- 01Playwright API メソッドの追加
- 02API パラメーターやオプションの更新
- 03API 変更のテスト
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ microsoft/ playwright --skill playwright-apiインストール後、Claude Code で/playwright-apiを入力して読み込まれたか確認します。
詳細
API
API の追加と変更
- 実装を行う前に、手順を確認し、これから行う作業を理解して計画してください。一部の手順はほかの手順の前提となるため、順番どおりに進めることが重要です。
docs/api/class-xxx.mdで API を定義(または更新)します。新しいメソッド、パラメーター、オプションには、package.json のバージョン(-next を除く)を使用します。- Watch が実行され、API の型が再生成されます。
packages/playwright/src/client/xxx.tsで新しい API を実装します。- 必要に応じて、
packages/protocol/src/protocol.ymlで API のチャネルを定義(または更新)します。 - Watch が実行され、プロトコルチャネルの型が再生成されます。
- 必要に応じて、
packages/playwright/src/server/dispatchers/xxxDispatcher.tsでディスパッチャーハンドラーを実装します。 - ハンドラーは、呼び出しを対応する
packages/playwright-core/src/server/xxx.tsのメソッドに渡すだけにします。 - 新しいテストは
tests/page/xxx.spec.tsに配置します。必要であれば、新しいテストファイルを作成してください。
ビルド
- Watch が実行されており、すべてが最新の状態であることを前提とします。
テスト
- テストで page しか使用しない場合は、
tests/page/xxx.spec.tsに配置し、page フィクスチャを使用してください。ブラウザーコンテキストを使用する必要がある場合は、tests/library/xxx.spec.tsに配置してください。 npm run ctest <file>として npm test を実行します。
Lint
- 最後に
npm run flintで lint を実行します。
コメント
Markdown 対応