Rules

eslint-plugin-tsdoc-require-2 enforces API documentation with three complementary rule families.

Rule family overview

Family	Purpose	Start here when
require	Require a TSDoc block (/** ... */) on selected declarations.	You need a documentation baseline first.
required-tags	Require specific tags (for example @param, @returns, @remarks) through individual require-* rules.	You want documentation completeness and consistency.
restrict-tags	Allow-list or deny-list tags to control vocabulary and compatibility.	You need a strict tag policy (for example strict TSDoc vs loose JSDoc/TypeDoc tags).

How the families work together

Use them in this order:

1. Presence: require ensures docs exist.
2. Completeness: require-* rules ensure required tags exist.
3. Vocabulary: restrict-tags ensures only approved tags are used.

This sequencing reduces confusion because tag rules only matter once comments exist.

Practical configuration pattern

Use a preset for the baseline, then add focused overrides.

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

export default [
 tsdocRequire.configs.recommended,
 {
  rules: {
   "tsdoc-require-2/require-param": ["error", { enforceFor: ["function"] }],
   "tsdoc-require-2/require-returns": ["error", { enforceFor: ["function"] }],
   "tsdoc-require-2/restrict-tags": [
    "error",
    {
     mode: "deny",
     tags: ["@typedef", "@callback"],
    },
   ],
  },
 },
];

Where to start

• New adoption: Getting Started
• Preset selection: Presets Overview
• Rule family details:
  • tsdoc-require-2/require
  • tsdoc-require-2/required-tags family
  • tsdoc-require-2/restrict-tags