jsdoc-authoring

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'.