sanitize-docs

Generate and complete JSDoc comments for public TypeScript functions and classes.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/JuantoC/BlueStack-Test-Automation-Framework --skill sanitize-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: sanitize-docs
Source: https://github.com/JuantoC/BlueStack-Test-Automation-Framework/tree/main/.claude/skills/sanitize-docs
Command: npx skills add https://github.com/JuantoC/BlueStack-Test-Automation-Framework --skill sanitize-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Revisa y documenta funciones, clases y métodos públicos de archivos TypeScript del proyecto BlueStack con JSDoc completo y comentarios inline, asegurando que la API pública esté bien descrita para IA y equipos de desarrollo.

Core Features & Use Cases

  • Genera y completa JSDoc en TypeScript para funciones y clases públicas sin documentación, siguiendo las convenciones de wiki y plantillas.
  • Respeta JSDoc existente y evita modificar lógica de código; propone mejoras de documentación sin cambiar el comportamiento.
  • Soporta revisiones por carpeta o archivo, reportando cambios como diffs para revisión.

Quick Start

Ejecuta el escáner de JSDoc en una ruta objetivo y aplica las plantillas para generar o completar la documentación de la API pública.

Frequently Asked Questions about sanitize-docs

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

FAQPage Schema
How do I automate JSDoc generation for public TypeScript APIs?

Yes, you can scan TypeScript source files by specific folder or individual file. The tool reports documentation gaps and provides diffs for review, allowing targeted API documentation updates across your project.

How do I ensure new JSDoc comments follow existing wiki-first conventions?

No, the tool strictly avoids modifying code logic. It only proposes documentation improvements by completing JSDoc comments and inline documentation for public TypeScript APIs, ensuring existing behavior remains unchanged.

What is the best way to find missing JSDoc in a TypeScript project?

The best way to find missing JSDoc in a TypeScript project is using static analysis to scan public APIs. This tool identifies undocumented functions, classes, and methods, reporting gaps as diffs for easy review and completion.

Does the JSDoc scanner modify existing correct comments in TypeScript files?

No, the scanner leaves existing correct JSDoc untouched. It focuses on generating and completing missing documentation for public TypeScript APIs, providing diffs for review without overwriting valid existing comments.