What does the cui-jsdoc skill help with?

It provides standardized patterns and automated tools for documenting JavaScript codebases using JSDoc, ensuring that functions, classes, and modules are clearly explained.

Does it support modern Web Components?

Absolutely. It includes specific documentation patterns for Lit components, including properties, events, and CSS custom properties.

Can this skill detect missing documentation?

Yes, it includes a violation analysis workflow that can scan directories to identify missing JSDoc blocks for exported functions, classes, and constructors.

Is it compatible with my existing ESLint setup?

Yes, the skill is designed to work alongside ESLint, providing configuration recommendations to enforce documentation rules automatically.

How do I validate my JSDoc using this skill?

You can use the provided analysis script via the command line to check for missing documentation or syntax issues across your entire project.

JSDoc Documentation Standards

Name: JSDoc Documentation Standards
Author: cuioss

bycuioss

0•

内容管理

Standardizes JSDoc documentation across JavaScript projects to ensure clear, maintainable, and type-safe codebases.

This skill provides comprehensive JSDoc documentation standards for JavaScript projects, covering core syntax, mandatory tags, and advanced patterns for Web Components and asynchronous functions. It streamlines the documentation workflow by offering specific writing guidelines, ESLint integration, and automated analysis scripts that detect missing or malformed doc blocks. By enforcing these standards, developers can ensure high-quality API documentation, better IDE intellisense, and improved codebase maintainability through predictable and well-documented structures.

主要功能

01ESLint-integrated rules for documentation completeness and syntax

02Guidelines for type annotations, union types, and custom typedefs

03Specialized documentation support for Lit and Web Components

04Standardized JSDoc patterns for functions, classes, and modules

05Automated violation analysis script for missing or invalid JSDoc

060 GitHub stars

使用场景

01Enforcing documentation standards across large JavaScript monorepos

02Automating documentation audits during CI/CD or code reviews

03Standardizing documentation for public-facing API libraries and Web Components

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add cuioss/plan-marshall cui-jsdoc

For use in Claude.ai and ChatGPT

Download Skill