jsdoc-tsdoc

Solid

JavaScript and TypeScript documentation generation using JSDoc and TSDoc. Parse source code, generate API documentation, validate coverage, and integrate with TypeDoc for comprehensive developer documentation.

AI & Automation 814 stars 53 forks Updated today MIT

Install

View on GitHub

Quality Score: 98/100

Stars 20%
97
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# JSDoc/TSDoc Skill Generate and validate JavaScript and TypeScript documentation using industry-standard JSDoc and TSDoc conventions with TypeDoc integration. ## Capabilities - Parse JSDoc comments from JavaScript source code - Parse TSDoc comments from TypeScript source code - Generate API documentation with TypeDoc - Validate documentation coverage and completeness - Enforce documentation standards with ESLint plugins - Support custom JSDoc/TSDoc tags - Type inference and documentation alignment - Generate multiple output formats (HTML, Markdown, JSON) ## Usage Invoke this skill when you need to: - Document JavaScript/TypeScript libraries and APIs - Generate API reference documentation - Audit documentation coverage - Set up automated documentation pipelines - Validate doc comments match implementation ## Inputs | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | projectPath | string | Yes | Root path of the JS/TS project | | entryPoints | array | No | Specific files/directories to document | | outputDir | string | No | Documentation output directory (default: docs) | | outputFormat | string | No | html, markdown, json (default: html) | | includePrivate | boolean | No | Include private members (default: false) | | coverageThreshold | number | No | Minimum documentation coverage % | | customTags | array | No | Additional JSDoc/TSDoc tags to recognize | ### Input Example ```json { "projectPath": "./packages/sdk", "entryP...

Details

Author
a5c-ai
Repository
a5c-ai/babysitter
Created
4 months ago
Last Updated
today
Language
JavaScript
License
MIT

Related Skills