jsdoc-tag-lines

Normalize blank lines between a JSDoc description and tag groups.

• Rule ID: tai-kun/jsdoc-tag-lines
• Auto-fix: Yes

Requires one blank line between the description and the first tag, and between different tag groups. Blank lines inside the same tag group are removed.

Configuration

Add the rule to lint.rules in vite.config.ts to enable it.

"tai-kun/jsdoc-tag-lines": "error",

Examples

Invalid

/**
 * Get a value.
 * @param value The value.
 * @returns The result.
 */

Valid

/**
 * Get a value.
 *
 * @param value The value.
 *
 * @returns The result.
 */

Notes

• Comments containing @example or fenced code are ignored.
• Blank lines inside the description are preserved.
• The fix replaces the whole comment.

Related rules

• jsdoc-tag-order
• jsdoc-param-order