skills.rest
videojs
videojsOFFICIAL
Explore all skills by this author →
WebsiteGitHub

review-api

Review Video.js TypeScript APIs for inference, composition, extensibility, and packaging issues.

931|91|Updated Aug 13, 2025
Search Tags:#packaging#extensibility#type inference#typeScript#video.js#API review#Code Audit
One-click install
npx skills add https://github.com/videojs/v10 --skill review-api
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: review-api
Source: https://github.com/videojs/v10/tree/main/.agents/skills/review-api
Command: npx skills add https://github.com/videojs/v10 --skill review-api

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Reviewing TypeScript API changes for correctness, compatibility, and design consistency is time-consuming and easy to get wrong, especially across a modular media player framework like Video.js v10. This Skill performs structured, read-only API audits so design problems surface before they ship.

Core Features & Use Cases

  • Public Surface Analysis: Defines the changed or proposed public API surface and checks compatibility constraints, runtime behavior, naming, defaults, and lifecycle.
  • Checklist-Driven Audits: Uses a reference checklist covering types, API surface, extensibility, progressive disclosure, and packaging (ESM, sideEffects, subpaths, peer deps).
  • Evidence-Based Findings: Ties every finding to a concrete caller, failure mode, or maintenance cost, reported by severity with location, user impact, and the smallest viable improvement.
  • Use Case: Before merging a new player factory API, run a review to catch inference failures, boolean traps, or packaging mistakes that would break downstream consumers.

Quick Start

Review this new player factory API for inference, compatibility, and packaging issues.

Frequently Asked Questions about review-api

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I review a TypeScript API before merging?▼

Define the changed public surface and compatibility constraints first, then check runtime behavior, inference, naming, defaults, composition, and packaging. Report findings by severity with concrete evidence and the smallest viable improvement.

What should a TypeScript API design review checklist include?▼

Cover inference-first types, no boolean traps or overloads, composition-based extensibility, explicit middleware ordering, zero-config defaults, and packaging checks like ESM-first output, accurate sideEffects flags, and correct peer dependencies.

Does this API review modify my source code?▼

No, the review is read-only. It reads the implementation, public exports, callers, types, tests, and design records, then reports prioritized findings without editing any files.

Can I review only part of an API surface?▼

Yes, load only the checklist sections relevant to the surface under review, such as types or packaging. The audit scope adapts to the changed or proposed API rather than requiring a full review.

What packaging issues does an API review catch?▼

It checks for ESM-first output, accurate sideEffects markings, shallow subpath exports, correct peer dependencies that are not bundled, and tree-shakeable exports.

Related Skills

Explore More Software Engineering Skills→
Arize-aiArize-ai
1.2k

js-docs-sync

Verify and update hand-written docs/ documentation in JS packages against source code.

Official
Intermediate
majunbaomajunbao

implementation-strategy

Plan compatibility boundaries for runtime and API changes before editing code.

Community
Intermediate
jeremyaryjeremyary
7

status

Run linting, type checks, tests, and dependency audits with pass/fail reporting.

Community
Intermediate
robotijnrobotijn
3

backwards-compatibility-checker

Detect breaking changes across APIs and enforce semantic versioning compliance.

Community
Advanced