Agent Skills
› videojs/video.js
› review-api
review-api
GitHub用于审查 TypeScript API 的设计、兼容性、类型推断及架构合理性，不修改代码。通过检查公开接口、调用方和测试，评估运行时行为与维护成本，输出按严重程度排序的具体改进建议。
触发场景
审查新提出的 API 设计
评估现有接口的兼容性与维护成本
进行架构或类型推断审计
安装
npx skills add videojs/video.js --skill review-api -g -y
SKILL.md
Frontmatter
{
"name": "review-api",
"description": "Review Video.js TypeScript APIs without editing code. Use for inference, state, extensibility, composition, packaging, or architecture audits."
}
API review
Read the implementation, public exports, callers, types, tests, and relevant design records.
- Define the changed or proposed public surface and compatibility constraints.
- Check runtime behavior, inference, naming, defaults, composition, escape hatches, lifecycle, packaging, and adjacent API consistency.
- Use
references/checklist.mdfor a broad audit; load only the sections relevant to the surface. - Tie every finding to a concrete caller, failure mode, or maintenance cost.
Report findings by severity with the location, user impact, evidence, and smallest viable improvement. Separate correctness or compatibility problems from preferences. Do not score the API or invent issues to fill a template.
Example
Input: “Review this new player factory API.”
Output: Prioritized findings tied to concrete callers, inference failures, compatibility risks, or maintenance costs.
版本历史
- 8a0a3d8 当前 2026-10-20 08:03
