Will it overwrite my existing JSDoc comments?

No, the skill is designed with content preservation in mind, focusing on fixing errors and adding missing required tags rather than replacing your existing descriptions.

What is the difference between 'missing' and 'syntax' scopes?

The 'missing' scope only flags elements that lack documentation entirely, while the 'syntax' scope checks existing JSDoc blocks for completeness and correct tag usage.

Does it support modern Web Component frameworks?

Yes, it specifically includes documentation patterns for Lit components, including specialized handling for properties, events, and CSS custom properties.

Can I run the analysis on specific files instead of the whole project?

Yes, the skill supports targeted analysis for individual files or specific directories, allowing you to focus on a single module at a time.

How does this skill detect missing JSDoc documentation?

The skill uses an integrated analysis script that scans source files for exported functions, classes, and modules, identifying those that lack JSDoc blocks or required tags like @param and @returns.

JSDoc Fixer & Standards

Name: JSDoc Fixer & Standards
Author: cuioss

bycuioss

•

개발자 도구

Automates the identification and repair of JSDoc violations while enforcing professional documentation standards for JavaScript and Web Components.

The JSDoc Fixer & Standards skill provides an automated orchestration layer for maintaining high-quality documentation across JavaScript projects. It enables Claude to detect missing documentation for public APIs, validate JSDoc syntax against ESLint rules, and apply standardized patterns for functions, classes, and Lit-based web components. By integrating directly with a violation analysis script, it helps developers prioritize documentation debt by categorizing issues into critical, warning, and suggestion levels. This ensures that codebase documentation remains consistent, reliable, and useful for IDE intellisense without requiring manual audits of every source file.

주요 기능

01Identification of missing @param, @returns, and @throws tags in public APIs

021 GitHub stars

03Content-preserving fixes for JSDoc syntax and structural errors

04Automated JSDoc violation analysis with severity-based reporting

05Directory-wide documentation audits via integrated Python scripts

06Standardized documentation patterns for Lit Web Components and custom types

사용 사례

01Updating legacy codebases to comply with modern JSDoc and ESLint standards

02Standardizing documentation across teams using Lit-based Web Components

03Ensuring complete documentation for public-facing APIs before a release

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add cuioss/plan-marshall js-fix-jsdoc

For use in Claude.ai and ChatGPT

Download Skill