lang-typescript

Name: lang-typescript
Availability: InStock
Author: xiaolai

Detect public TypeScript and JavaScript APIs and map symbols to source origins.

6|Updated Feb 28, 2026

Search Tags:#typescript #documentation #javascript #jsdoc #tsdoc #api-detection

Ready to run

npx skills add https://github.com/xiaolai/docs-guardian-for-claude --skill lang-typescript-xiaolai

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: lang-typescript
Source: https://github.com/xiaolai/docs-guardian-for-claude/tree/main/skills/docs-guardian/languages/typescript
Command: npx skills add https://github.com/xiaolai/docs-guardian-for-claude --skill lang-typescript-xiaolai

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

TypeScript/JavaScript projects often lack a clear, consistent mapping from public code symbols to documentation. This Skill identifies public API elements across TS/JS code and aligns documentation with source definitions.

Core Features & Use Cases

Detects public APIs across functions, classes, interfaces, types, enums, and React components.
Respects barrel files by resolving origins to the actual source symbols for accurate documentation.
Enforces JSDoc/TSDoc standards and supports API surface analysis, documentation planning, and auditing workflows.

Quick Start

Analyze your project with the adapter to surface public APIs and prepare documentation.

Frequently Asked Questions about lang-typescript

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

FAQPage Schema

How do I detect public APIs across TypeScript and JavaScript source files?▼

To detect public APIs across TypeScript and JavaScript source files, analyze exports, interfaces, types, enums, and React components. This process maps public symbols to their origin sources, including barrel files, producing a coherent API documentation plan.

How do I resolve barrel file re-exports to their actual source symbols for documentation?▼

Resolving barrel file re-exports to their actual source symbols requires tracing exports back to their original definitions in .ts or .tsx files. This ensures accurate documentation mapping and prevents documenting the barrel aggregator itself.

Can I enforce JSDoc and TSDoc formatting standards for React component props and return types?▼

Yes, you can enforce JSDoc and TSDoc formatting standards for React component props and return types. The enforcement applies to parameters, returns, and prop documentation requirements across TS/JS projects of varying sizes.

What is the best way to plan API documentation for a TypeScript project?▼

The best way to plan API documentation for a TypeScript project is to perform API surface analysis by detecting public functions and classes. This aligns documentation with source definitions and enforces JSDoc/TSDoc standards for auditing workflows.

Does this API detection approach work with both JavaScript and TypeScript projects?▼

Yes, this API detection approach works with both JavaScript and TypeScript projects. It implements detection across source files including .ts, .tsx, .js, and .jsx, ensuring JSDoc/TSDoc formatting and accurate symbol mapping.