tsdoc

TSDoc-focused preset with function/type-parameter requirements and compatibility-tag restrictions.

What this preset is for

Use tsdoc when you want a strong TSDoc baseline with both required content and vocabulary controls.

This preset works well for:

• TypeScript library APIs
• SDKs with strict documentation standards
• teams standardizing on TSDoc over mixed JSDoc/TypeDoc conventions

What this preset enables

• tsdoc-require-2/require
• tsdoc-require-2/require-remarks
• tsdoc-require-2/require-param with enforceFor: ["function"]
• tsdoc-require-2/require-returns with enforceFor: ["function"]
• tsdoc-require-2/require-throws with enforceFor: ["function"]
• tsdoc-require-2/require-type-param with enforceFor: ["class", "function", "interface", "type"]
• tsdoc-require-2/restrict-tags in deny mode for TypeDoc compatibility tags

Why this preset is different from jsdoc

jsdoc focuses on function tags only. tsdoc adds stronger TSDoc structure (@remarks, @typeParam) and stricter tag vocabulary.

Config key

tsdocRequire.configs.tsdoc

Flat Config example

import tsdocRequire from "eslint-plugin-tsdoc-require-2";

export default [tsdocRequire.configs.tsdoc];

Common customization

If your docs intentionally use some TypeDoc tags, override restrict-tags.tags instead of disabling restrict-tags entirely.