// JSDoc writing rules for AI-powered documentation generation. Use when writing JSDoc, documenting functions, or adding code comments.
| name | jsdoc-guide |
| description | JSDoc writing rules for AI-powered documentation generation. Use when writing JSDoc, documenting functions, or adding code comments. |
| allowed-tools | Read, Edit |
All exported functions require 4 mandatory tags:
/**
* @description One-line summary.
* @param {Type} name - Description.
* @returns {Type} Description.
* @example
* const result = useHook(input);
*/
// ✅ Good
@description Debounces a value and returns it after the specified delay.
// ❌ Bad
@description Does something with a value.
@param {T} value - The value to debounce.
@param {number} [delay=300] - Optional delay in ms.
@param {Object} options - Configuration object.
// Simple
@returns {T} The debounced value.
// Tuple
@returns {[boolean, () => void]} [state, toggle]
@example
const [search, setSearch] = useState('');
const debouncedSearch = useDebounce(search, 300);
Design React APIs and abstractions in a React-like way. Covers declarative interfaces, lifecycle-safe abstractions, minimal surfaces, zero-dependency bias, type safety, and documentation.
Review React hooks against design philosophy. Checks return values, SSR safety, state design, effect usage, TypeScript patterns, and performance.
Write React hooks following design philosophy. Covers naming, return values, SSR safety, state design, effect patterns, TypeScript, and performance.
Create branches following repo conventions. Use when creating branches, starting new features.
PR/code review. 100% coverage, SSR safety, JSDoc validation. Use when reviewing code, checking PRs.
Create commits following repo conventions. Use when committing changes, creating commit messages.