Skip to main content

typedoc-strict

Stricter TypeDoc preset that also requires module remarks and denies compatibility-only block tags.

What this preset is for​

Use typedoc-strict when you want TypeDoc-oriented declaration tagging plus stricter narrative and tag vocabulary discipline.

This preset is a good fit for:

  • public SDKs with strict documentation standards
  • multi-package libraries with clear module-level docs requirements
  • teams that need consistent TypeDoc-friendly output with reduced tag sprawl

What this preset enables​

Why this preset is stricter than typedoc​

Compared to typedoc, this preset adds:

  • module-level docs (@module)
  • narrative context (@remarks)
  • explicit tag vocabulary restrictions

Config key​

tsdocRequire.configs["typedoc-strict"]

Flat Config example​

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

export default [tsdocRequire.configs["typedoc-strict"]];

Common customization​

If your project intentionally uses some denied tags, override restrict-tags.tags with a narrower deny list instead of disabling the rule.