generate-doc-ts-js-vue

Generate standardized JSDoc and contextual comments for TypeScript, JavaScript, and Vue SFC files.

Updated May 6, 2026

Search Tags:#typescript #documentation #refactoring #vue #code-quality #jsdoc

Ready to run

npx skills add https://github.com/johan-Rm/agents --skill generate-doc-ts-js-vue

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: generate-doc-ts-js-vue
Source: https://github.com/johan-Rm/agents/tree/main/skills/generate-doc-ts-js-vue
Command: npx skills add https://github.com/johan-Rm/agents --skill generate-doc-ts-js-vue

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill addresses the lack of consistent, high-quality documentation in TypeScript, JavaScript, and Vue SFC projects by automating the insertion of JSDoc and contextual comments without altering business logic.

Core Features & Use Cases

Standardized JSDoc: Automatically generates documentation for exported functions, composables, and server handlers.
Contextual Commenting: Adds meaningful explanations for lifecycle hooks, watchers, and client-only SSR blocks.
Use Case: Use this skill to document a complex Nuxt composable or a server handler to ensure that team members understand the intent behind specific logic, query parameters, and side effects.

Quick Start

Use the generate-doc-ts-js-vue skill to analyze the provided source file and inject appropriate JSDoc and comments based on the defined documentation standards.

Frequently Asked Questions about generate-doc-ts-js-vue

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

FAQPage Schema

How do I generate JSDoc for TypeScript and Vue SFC files?▼

JSDoc comments for Vue SFC files target exported functions, composables, and server handlers to explain specific logic, query parameters, and side effects to team members. Contextual comments are also added for lifecycle hooks, watchers, and client-only SSR blocks.

Can I automatically add contextual comments to Vue lifecycle hooks and SSR blocks?▼

Yes, you can automatically add contextual comments to Vue lifecycle hooks, watchers, and client-only SSR blocks. This contextual commenting mechanism provides meaningful explanations for specific logic without altering the underlying business logic.

Does this documentation generator support JavaScript and Nuxt composables?▼

This documentation generator supports JavaScript, TypeScript, and Vue SFC files, including Nuxt composables and server handlers. It ensures team members understand the intent behind specific logic by automating the insertion of standardized JSDoc.

What is the best way to document exported functions without changing business logic?▼

The best way to document exported functions without changing business logic is to automate the insertion of standardized JSDoc and contextual comments. This approach targets specific code structures to improve maintainability and readability safely.

Are there specific JSDoc tag conventions required for SSR and client-side logic?▼

Yes, specific JSDoc tag conventions are required for SSR and client-side logic, and the generated documentation must adhere to French language documentation standards to ensure consistent code quality across the project.