How does it integrate with ESLint?

The skill provides specific ESLint plugin configurations and rules to ensure documentation remains synchronized with your code automatically.

Can this skill find missing documentation automatically?

Yes, it includes a workflow to analyze directories for JSDoc violations, categorizing issues as CRITICAL for exported APIs or WARNINGS for internal functions.

Does it support modern frontend frameworks?

It specifically includes patterns for Web Components and Lit elements, covering properties, events, and CSS custom properties.

What documentation tags are required by this skill?

For public functions, the skill requires a brief description, @param (with types), @returns, and @throws for all possible errors.

CUI JSDoc Standards

Name: CUI JSDoc Standards
Author: JongminChung

byJongminChung

•

콘텐츠 관리

Standardizes JavaScript documentation using JSDoc to ensure consistent, high-quality code comments and automated API validation.

The cui-jsdoc skill provides a comprehensive framework for documenting JavaScript functions, classes, modules, and web components within the CUI ecosystem. It goes beyond simple templates by integrating ESLint rules, providing specialized patterns for Lit web components, and offering a robust analysis workflow to detect missing or malformed documentation. By enforcing strict requirements for parameters, return values, and error handling, it empowers developers to maintain self-documenting codebases that are easy to navigate, audit, and automate.

주요 기능

01Standardized templates for functions, classes, modules, and custom types

02Specialized documentation patterns for Lit and vanilla web components

03Detailed writing style guidelines emphasizing active voice and clear API communication

04Automated JSDoc violation analysis with severity-based reporting (CRITICAL to SUGGESTION)

052 GitHub stars

06Integrated ESLint configuration for automated documentation linting and validation

사용 사례

01Auditing large JavaScript repositories for missing or incomplete API documentation

02Integrating documentation quality checks into CI/CD pipelines via ESLint and Python scripts

03Standardizing documentation style across a team to improve codebase maintainability

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add jongminchung/engineering cui-jsdoc

For use in Claude.ai and ChatGPT

Download Skill