jsdoc-authoring

Enforce canonical JSDoc standards for JavaScript and TypeScript projects.

3|1|Updated Jan 15, 2026

Search Tags:#code quality #typescript #documentation #javascript #jsdoc #typing

Ready to run

npx skills add https://github.com/Ilenburg1993/chatgpt-docker-puppeteer --skill jsdoc-authoring

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: jsdoc-authoring
Source: https://github.com/Ilenburg1993/chatgpt-docker-puppeteer/tree/main/.github/skills/jsdoc-authoring
Command: npx skills add https://github.com/Ilenburg1993/chatgpt-docker-puppeteer --skill jsdoc-authoring

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill addresses the challenge of maintaining clear, robust, and type-safe JavaScript codebases by enforcing strict JSDoc standards, ensuring better IntelliSense and reducing runtime errors without migrating to TypeScript.

Core Features & Use Cases

JSDoc Enforcement: Applies canonical JSDoc standards for parameters, return types, and object definitions.
Type Safety: Enhances JavaScript code safety through @ts-check and explicit type annotations in JSDoc.
Use Case: When refactoring a complex JavaScript module, use this Skill to ensure all exported functions have precise @param and @returns tags, and that option objects are clearly defined with @typedef, improving maintainability and developer experience.

Quick Start

Use the jsdoc-authoring skill to add explicit @param and @returns tags to all exported functions in the file '/src/utils/helpers.js'.

Frequently Asked Questions about jsdoc-authoring

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

FAQPage Schema

How do I enforce JSDoc type annotations to prevent implicit any errors in JavaScript?▼

You can enforce JSDoc type annotations by applying canonical `@param`, `@returns`, and `@typedef` tags alongside `@ts-check` for static analysis, which eliminates implicit `any` types and hardens public API contracts.

What is the best way to add type safety to a JavaScript project without migrating to TypeScript?▼

Adding type safety without migrating to TypeScript involves using strict JSDoc standards with `@ts-check` for static analysis, ensuring better IntelliSense and reducing runtime errors through explicit type definitions.

How do I define complex object types in JSDoc for better IntelliSense?▼

Define complex object types in JSDoc by using explicit `@typedef` annotations to clearly structure option objects, resolving malformed typedefs and improving maintainability alongside `@param` and `@returns` tags.

Can I use JSDoc authoring standards with Node.js 24 ESM?▼

Yes, canonical JSDoc authoring standards are designed for JavaScript and TypeScript projects using Node.js 24 ESM, enabling automated hardening of public API contracts and static analysis within that environment.

Does JSDoc work with TypeScript projects to improve code contracts?▼

JSDoc works with TypeScript projects by enforcing explicit type annotations and leveraging `@ts-check`, addressing common type-safety issues to improve IntelliSense and reduce runtime errors across both languages.

Why does my JavaScript module lack proper type checking despite using JSDoc?▼

Your JavaScript module lacks proper type checking due to malformed typedefs or missing explicit `@param` and `@returns` tags, which this Skill addresses by automating canonical JSDoc standards and `@ts-check` integration.