Skip to main content

recommended

Baseline preset that enforces TSDoc comment presence with tsdoc-require-2/require.

What this preset is for​

Use recommended when you need a low-friction starting point:

  • enforce that API declarations are documented
  • avoid immediate tag-level migration work
  • establish a consistent baseline before adopting stricter tag policy

What this preset enables​

This preset only checks that comments exist. It does not require tags like @param or @returns, and it does not restrict tag vocabulary.

Config key​

tsdocRequire.configs.recommended

Flat Config example​

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

export default [tsdocRequire.configs.recommended];

When to choose a stricter preset​

  • Move to detailed when every doc block should include @remarks.
  • Move to jsdoc or tsdoc when function/tag contracts matter.
  • Move to packages for package-level API docs.