mcpField
P
playwright-api

playwright-api

github.com/microsoft开发98.8k84 次安装今天更新
代码仓库

关于 playwright-api

面向修改 Playwright API 的贡献者仓库技能，按顺序说明 API 定义、实现、协议通道、dispatcher、测试与 lint 流程。

主要功能

  1. 01API 定义与实现步骤
  2. 02协议通道更新指引
  3. 03Dispatcher 实现指引
  4. 04测试位置与命令
  5. 05Lint 流程

适用场景

  1. 01添加 Playwright API 方法
  2. 02更新 API 参数或选项
  3. 03测试 API 改动

安装

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

$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 的 channel
  • Watch 会启动并重新生成 protocol channel 的类型
  • 根据需要，在 packages/playwright/src/server/dispatchers/xxxDispatcher.ts 中实现 dispatcher 处理程序
  • 处理程序只应将调用路由到 packages/playwright-core/src/server/xxx.ts 中对应的方法
  • 将新测试放在 tests/page/xxx.spec.ts 中，或根据需要创建新的测试文件

构建

  • 假定 Watch 正在运行，并且所有内容都是最新的。

测试

  • 如果测试只使用 page，请优先将其放在 tests/page/xxx.spec.ts 中，并使用 page fixture。如果需要使用 browser context，请将其放在 tests/library/xxx.spec.ts 中。
  • 运行 npm test：npm run ctest <file>

代码检查

  • 最后运行 npm run flint 进行代码检查。

评论

支持 Markdown