skills.rest
sisense
sisenseOFFICIAL
Explore all skills by this author →
Website𝕏@sisenseGitHub

check-public-api

Detect public API export and TSDoc tag violations in TypeScript barrels.

38|15|Updated Jul 26, 2023
Search Tags:#typescript#lint#tsdoc#public-api#api-surface#barrels
One-click install
npx skills add https://github.com/sisense/compose-sdk-monorepo --skill check-public-api
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: check-public-api
Source: https://github.com/sisense/compose-sdk-monorepo/tree/main/.claude/skills/check-public-api
Command: npx skills add https://github.com/sisense/compose-sdk-monorepo --skill check-public-api

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Auditing and enforcing proper public API exposure in sdk-ui by verifying exports and TSDoc tags to prevent regression and misdocumentation.

Core Features & Use Cases

  • Validates barrel exports to ensure no wildcard exports and that each exported symbol carries the barrel's TSDoc tag.
  • Checks that public API references resolve through the TypeScript compiler to prevent broken imports.
  • Use Case: Before merging changes that touch public interfaces, run this skill to catch missing tags or misconfigurations.

Quick Start

Run yarn public-api-check to surface violations and guide fixes.

Frequently Asked Questions about check-public-api

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

FAQPage Schema
How do I audit barrel exports for missing TSDoc tags in TypeScript?▼

To audit barrel exports for missing TSDoc tags in TypeScript, use the public-api-check skill to detect violations and ensure each exported symbol carries the required barrel tag.

What is a public API surface check and when do I need it?▼

A public API surface check validates TypeScript barrel exports and TSDoc tags to prevent undocumented or broken APIs, needed when auditing changes to public-api barrels or preparing merge requests.

How do I prevent wildcard exports in my TypeScript public API barrels?▼

To prevent wildcard exports in TypeScript public API barrels, run a validation check that surfaces violations and ensures each exported symbol carries the required barrel TSDoc tag.

Does the public API check verify TypeScript compiler resolution for barrel exports?▼

Yes, the public API check verifies TypeScript compiler resolution for public-api barrels to ensure public API references resolve correctly and prevent broken imports.

How do I catch undocumented public API exports before merging changes?▼

To catch undocumented public API exports before merging changes, run the public-api-check to surface missing TSDoc tags and misconfigurations that touch public interfaces.

What's the best way to keep public API surfaces clean and compliant in TypeScript?▼

The best way to keep public API surfaces clean and compliant is to run a validation check that detects TSDoc tag violations and verifies TypeScript compiler resolution for barrel exports.

Related Skills

Explore More Software Engineering Skills→
chiubakachiubaka
1

barrel-surface-curation

Validate TypeScript barrel file structures to enforce public API boundaries.

Community
Intermediate
erclxerclx
2

claude-address-review

Apply code fixes and update documentation for GitHub pull request review findings.

Community
Advanced
MatthieuszMatthieusz

coding-standards

Validate TypeScript code against predefined coding standards using static analysis tools.

Community
Advanced
shllgshllg

tsdoc

Generate TypeScript documentation from TSDoc annotations for the night-orch project.

Community
Intermediate