api-reports

Regenerate API Extractor reports and manage release tags in a monorepo.

Updated Jan 7, 2026
One-click install
npx skills add https://github.com/tylerbutler/repo-overlays --skill api-reports
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-reports
Source: https://github.com/tylerbutler/repo-overlays/tree/main/tylerbutler/FluidFramework/api-reports/.claude/skills/api-reports
Command: npx skills add https://github.com/tylerbutler/repo-overlays --skill api-reports

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill streamlines the management of API Extractor reports and release tag entry points within the Fluid Framework monorepo, simplifying the process of tracking API changes and ensuring consistency.

Core Features & Use Cases

  • API Report Generation: Regenerate API Extractor reports after code changes.
  • Release Tag Management: Update and manage TSDoc release tags (@public, @beta, @alpha, etc.) for exported symbols.
  • Entry Point Configuration: Ensure correct package.json exports configurations for different API visibility levels.
  • Debugging: Assist in diagnosing and resolving API Extractor errors.

Quick Start

Use the api-reports skill to regenerate API reports for the packages/dds/tree directory.

Frequently Asked Questions about api-reports

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

FAQPage Schema
How do I regenerate API Extractor reports in a TypeScript monorepo?

To manage release tags, you update TSDoc annotations like `@public`, `@beta`, or `@alpha` on exported symbols. This Skill helps manage these tags to define API visibility levels and entry points within the monorepo.

Why does API Extractor fail when validating package exports?

API Extractor validation fails when `package.json` exports configurations do not match the defined API visibility levels. You need to ensure correct entry point configurations and strict adherence to TSDoc conventions to resolve these errors.

What is the best way to track API surface changes in a monorepo?

Tracking API surface changes is best handled by regenerating API Extractor reports and managing release tag entry points. This approach simplifies tracking API modifications and enforces consistency across packages in the monorepo.

Do I need TSDoc conventions to use API Extractor for code quality checks?

Yes, strict adherence to TSDoc conventions is required when using API Extractor. Proper TSDoc annotations are necessary to manage release tags and ensure the generated API reports accurately reflect your code quality.