eslint-plugin-tsdoc-require-2 1.0.6 → 1.0.8

package/docs/rules/presets/all.md

@@ -0,0 +1,100 @@
+# all
+
+Enables every rule provided by this plugin, including all require-tag rules and `restrict-tags`.
+
+## What this preset is for
+
+Use `all` for auditing or policy design, not as a day-one default.
+
+Good use cases:
+
+- evaluating full rule coverage on an existing codebase
+- running one-time migration assessments
+- building a custom strict preset by starting from maximum coverage
+
+## Why this preset is risky as a default
+
+`all` enables niche tag requirements that most teams do not want globally.
+
+If enabled immediately in an established repository, expect a large number of violations and higher maintenance cost.
+
+A safer pattern is to start with `recommended`, `tsdoc`, or `typedoc-strict`, then add individual rules intentionally.
+
+## Config key
+
+`tsdocRequire.configs.all`
+
+## Flat Config example
+
+```ts
+import tsdocRequire from "eslint-plugin-tsdoc-require-2";
+
+export default [
+    tsdocRequire.configs.all,
+];
+```
+
+## Adoption tip
+
+During migration, run this preset as warnings first and promote selected rules to errors after cleanup.
+
+## Rules in this preset
+
+- [`tsdoc-require-2/require`](../require.md)
+- [`tsdoc-require-2/restrict-tags`](../restrict-tags.md)
+- [`tsdoc-require-2/require-abstract`](../required-tags/require-abstract.md)
+- [`tsdoc-require-2/require-alpha`](../required-tags/require-alpha.md)
+- [`tsdoc-require-2/require-author`](../required-tags/require-author.md)
+- [`tsdoc-require-2/require-beta`](../required-tags/require-beta.md)
+- [`tsdoc-require-2/require-category`](../required-tags/require-category.md)
+- [`tsdoc-require-2/require-class`](../required-tags/require-class.md)
+- [`tsdoc-require-2/require-decorator`](../required-tags/require-decorator.md)
+- [`tsdoc-require-2/require-default-value`](../required-tags/require-default-value.md)
+- [`tsdoc-require-2/require-deprecated`](../required-tags/require-deprecated.md)
+- [`tsdoc-require-2/require-document`](../required-tags/require-document.md)
+- [`tsdoc-require-2/require-enum`](../required-tags/require-enum.md)
+- [`tsdoc-require-2/require-event`](../required-tags/require-event.md)
+- [`tsdoc-require-2/require-event-property`](../required-tags/require-event-property.md)
+- [`tsdoc-require-2/require-example`](../required-tags/require-example.md)
+- [`tsdoc-require-2/require-expand`](../required-tags/require-expand.md)
+- [`tsdoc-require-2/require-experimental`](../required-tags/require-experimental.md)
+- [`tsdoc-require-2/require-function`](../required-tags/require-function.md)
+- [`tsdoc-require-2/require-group`](../required-tags/require-group.md)
+- [`tsdoc-require-2/require-hidden`](../required-tags/require-hidden.md)
+- [`tsdoc-require-2/require-hideconstructor`](../required-tags/require-hideconstructor.md)
+- [`tsdoc-require-2/require-ignore`](../required-tags/require-ignore.md)
+- [`tsdoc-require-2/require-import`](../required-tags/require-import.md)
+- [`tsdoc-require-2/require-include`](../required-tags/require-include.md)
+- [`tsdoc-require-2/require-inherit-doc`](../required-tags/require-inherit-doc.md)
+- [`tsdoc-require-2/require-inline`](../required-tags/require-inline.md)
+- [`tsdoc-require-2/require-interface`](../required-tags/require-interface.md)
+- [`tsdoc-require-2/require-internal`](../required-tags/require-internal.md)
+- [`tsdoc-require-2/require-label`](../required-tags/require-label.md)
+- [`tsdoc-require-2/require-license`](../required-tags/require-license.md)
+- [`tsdoc-require-2/require-link`](../required-tags/require-link.md)
+- [`tsdoc-require-2/require-merge-module-with`](../required-tags/require-merge-module-with.md)
+- [`tsdoc-require-2/require-module`](../required-tags/require-module.md)
+- [`tsdoc-require-2/require-namespace`](../required-tags/require-namespace.md)
+- [`tsdoc-require-2/require-overload`](../required-tags/require-overload.md)
+- [`tsdoc-require-2/require-override`](../required-tags/require-override.md)
+- [`tsdoc-require-2/require-package-documentation`](../required-tags/require-package-documentation.md)
+- [`tsdoc-require-2/require-param`](../required-tags/require-param.md)
+- [`tsdoc-require-2/require-primary-export`](../required-tags/require-primary-export.md)
+- [`tsdoc-require-2/require-private`](../required-tags/require-private.md)
+- [`tsdoc-require-2/require-private-remarks`](../required-tags/require-private-remarks.md)
+- [`tsdoc-require-2/require-property`](../required-tags/require-property.md)
+- [`tsdoc-require-2/require-protected`](../required-tags/require-protected.md)
+- [`tsdoc-require-2/require-public`](../required-tags/require-public.md)
+- [`tsdoc-require-2/require-readonly`](../required-tags/require-readonly.md)
+- [`tsdoc-require-2/require-remarks`](../required-tags/require-remarks.md)
+- [`tsdoc-require-2/require-returns`](../required-tags/require-returns.md)
+- [`tsdoc-require-2/require-sealed`](../required-tags/require-sealed.md)
+- [`tsdoc-require-2/require-see`](../required-tags/require-see.md)
+- [`tsdoc-require-2/require-since`](../required-tags/require-since.md)
+- [`tsdoc-require-2/require-sort-strategy`](../required-tags/require-sort-strategy.md)
+- [`tsdoc-require-2/require-summary`](../required-tags/require-summary.md)
+- [`tsdoc-require-2/require-template`](../required-tags/require-template.md)
+- [`tsdoc-require-2/require-throws`](../required-tags/require-throws.md)
+- [`tsdoc-require-2/require-type-param`](../required-tags/require-type-param.md)
+- [`tsdoc-require-2/require-use-declared-type`](../required-tags/require-use-declared-type.md)
+- [`tsdoc-require-2/require-virtual`](../required-tags/require-virtual.md)

package/docs/rules/presets/detailed.md

@@ -0,0 +1,41 @@
+# detailed
+
+Adds `@remarks` requirements on top of `recommended` for richer top-level docs.
+
+## What this preset is for
+
+Use `detailed` when comment presence alone is not enough and each declaration needs brief narrative context.
+
+`@remarks` is useful for:
+
+- behavior caveats
+- compatibility notes
+- rollout/deprecation guidance
+
+## What this preset enables
+
+- [`tsdoc-require-2/require`](../require.md)
+- [`tsdoc-require-2/require-remarks`](../required-tags/require-remarks.md)
+
+Compared to `recommended`, this adds structural pressure for richer docs without introducing broad tag policy yet.
+
+## Config key
+
+`tsdocRequire.configs.detailed`
+
+## Flat Config example
+
+```ts
+import tsdocRequire from "eslint-plugin-tsdoc-require-2";
+
+export default [
+    tsdocRequire.configs.detailed,
+];
+```
+
+## Trade-offs
+
+- More authoring effort than `recommended`.
+- Better long-term clarity for teams maintaining shared APIs.
+
+If you need function-signature tags (`@param`, `@returns`, `@throws`) next, move to [`jsdoc`](./jsdoc.md) or [`tsdoc`](./tsdoc.md).

package/docs/rules/presets/index.md

@@ -0,0 +1,156 @@
+# Presets Overview
+
+Presets are curated rule bundles that help you adopt `eslint-plugin-tsdoc-require-2` in controlled stages.
+
+Use one preset as your baseline, then add rule overrides for project-specific policy.
+
+## How to choose quickly
+
+| If you want... | Start with |
+| --- | --- |
+| Minimal comment presence enforcement | [`recommended`](./recommended.md) |
+| More narrative context in docs | [`detailed`](./detailed.md) |
+| Package-level docs for published libraries | [`packages`](./packages.md) |
+| JSDoc-style function tag discipline | [`jsdoc`](./jsdoc.md) |
+| TSDoc-first function + type-parameter docs with tag restrictions | [`tsdoc`](./tsdoc.md) |
+| TypeDoc declaration-kind tagging | [`typedoc`](./typedoc.md) |
+| Strict TypeDoc workflow with module/remarks and restricted tags | [`typedoc-strict`](./typedoc-strict.md) |
+| Maximum strictness for audits or experiments | [`all`](./all.md) |
+
+## Preset catalog
+
+- [`recommended`](./recommended.md): Require docs to exist.
+- [`detailed`](./detailed.md): `recommended` + require `@remarks`.
+- [`packages`](./packages.md): `detailed` + require `@packageDocumentation`.
+- [`typedoc`](./typedoc.md): TypeDoc declaration-kind tags.
+- [`typedoc-strict`](./typedoc-strict.md): `typedoc` + module/remarks + restricted tags.
+- [`tsdoc`](./tsdoc.md): TSDoc-style function/type tags + restricted tags.
+- [`jsdoc`](./jsdoc.md): Function-oriented JSDoc-style tags.
+- [`all`](./all.md): Every plugin rule.
+
+## Preset migration ladder
+
+Most teams succeed with this progression:
+
+1. `recommended`
+2. `detailed` or `jsdoc`
+3. `tsdoc` or `typedoc` / `typedoc-strict`
+
+Jumping straight to `all` is usually expensive and noisy unless your codebase already has consistent docs.
+
+## How rules compose inside presets
+
+Each preset combines the same three policy layers in different strengths:
+
+1. **Presence layer**: `tsdoc-require-2/require`
+2. **Required content layer**: one or more `require-*` tag rules
+3. **Vocabulary control layer**: optional `tsdoc-require-2/restrict-tags`
+
+This composition is why preset choice matters: two presets can include similar rules but express different documentation policy.
+
+## Matrix overview
+
+The matrix below is generated by `scripts/sync-presets-rules-matrix.mjs` and
+kept in sync with the README.
+
+<!-- BEGIN_PRESETS_MATRIX -->
+
+### Preset matrix
+
+- `Fix` legend:
+  - `🔧` = autofixable
+  - `💡` = suggestions available
+  - `—` = report only
+- `Preset key` legend:
+  - [🟢](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/recommended) — [`tsdocRequire.configs.recommended`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/recommended) — Minimal baseline TSDoc enforcement.
+  - [🟡](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/detailed) — [`tsdocRequire.configs.detailed`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/detailed) — Require comments plus @remarks.
+  - [🟠](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/packages) — [`tsdocRequire.configs.packages`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/packages) — Package docs baseline with @packageDocumentation.
+  - [🔵](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/typedoc) — [`tsdocRequire.configs.typedoc`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/typedoc) — Conservative TypeDoc declaration-kind tags.
+  - [🔴](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/typedoc-strict) — [`tsdocRequire.configs["typedoc-strict"]`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/typedoc-strict) — Strict TypeDoc with module/remarks and tag restrictions.
+  - [🟣](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/tsdoc) — [`tsdocRequire.configs.tsdoc`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/tsdoc) — TSDoc-focused baseline with function/type tags plus tag restrictions.
+  - [🟦](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/jsdoc) — [`tsdocRequire.configs.jsdoc`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/jsdoc) — JSDoc-style function-tag baseline.
+  - [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) — [`tsdocRequire.configs.all`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) — All plugin rules. Use for audits and deliberate strictness.
+
+| Rule | Fix | Preset key |
+| --- | :---: | --- |
+| [`tsdoc-require-2/require`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/require) | — | [🟢](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/recommended) [🟡](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/detailed) [🟠](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/packages) [🔵](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/typedoc) [🔴](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/typedoc-strict) [🟣](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/tsdoc) [🟦](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/jsdoc) [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-abstract`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-abstract) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-alpha`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-alpha) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-author`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-author) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-beta`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-beta) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-category`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-category) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-class`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-class) | — | [🔵](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/typedoc) [🔴](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/typedoc-strict) [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-decorator`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-decorator) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-default-value`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-default-value) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-deprecated`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-deprecated) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-document`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-document) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-enum`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-enum) | — | [🔵](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/typedoc) [🔴](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/typedoc-strict) [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-event`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-event) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-event-property`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-event-property) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-example`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-example) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-expand`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-expand) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-experimental`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-experimental) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-function`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-function) | — | [🔵](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/typedoc) [🔴](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/typedoc-strict) [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-group`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-group) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-hidden`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-hidden) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-hideconstructor`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-hideconstructor) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-ignore`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-ignore) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-import`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-import) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-include`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-include) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-inherit-doc`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-inherit-doc) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-inline`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-inline) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-interface`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-interface) | — | [🔵](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/typedoc) [🔴](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/typedoc-strict) [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-internal`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-internal) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-label`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-label) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-license`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-license) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-link`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-link) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-merge-module-with`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-merge-module-with) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-module`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-module) | — | [🔴](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/typedoc-strict) [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-namespace`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-namespace) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-overload`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-overload) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-override`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-override) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-package-documentation`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-package-documentation) | — | [🟠](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/packages) [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-param`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-param) | — | [🟣](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/tsdoc) [🟦](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/jsdoc) [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-primary-export`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-primary-export) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-private`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-private) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-private-remarks`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-private-remarks) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-property`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-property) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-protected`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-protected) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-public`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-public) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-readonly`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-readonly) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-remarks`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-remarks) | — | [🟡](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/detailed) [🟠](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/packages) [🔴](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/typedoc-strict) [🟣](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/tsdoc) [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-returns`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-returns) | — | [🟣](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/tsdoc) [🟦](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/jsdoc) [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-sealed`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-sealed) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-see`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-see) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-since`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-since) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-sort-strategy`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-sort-strategy) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-summary`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-summary) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-template`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-template) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-throws`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-throws) | — | [🟣](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/tsdoc) [🟦](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/jsdoc) [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-type-param`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-type-param) | — | [🟣](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/tsdoc) [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-use-declared-type`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-use-declared-type) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/require-virtual`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-virtual) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+| [`tsdoc-require-2/restrict-tags`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/restrict-tags) | — | [🔴](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/typedoc-strict) [🟣](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/tsdoc) [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
+
+<!-- END_PRESETS_MATRIX -->
+
+## Flat Config usage pattern
+
+Use one preset baseline, then add an override block.
+
+```ts
+import tsdocRequire from "eslint-plugin-tsdoc-require-2";
+
+export default [
+  tsdocRequire.configs.tsdoc,
+  {
+    rules: {
+      "tsdoc-require-2/require": ["error", { exportMode: "all" }],
+    },
+  },
+];
+```
+
+Avoid stacking multiple presets unless you intentionally want merge-order behavior.
+
+For setup steps, see [Getting Started](../getting-started.md).

package/docs/rules/presets/jsdoc.md

@@ -0,0 +1,43 @@
+# jsdoc
+
+JSDoc-leaning preset focused on function documentation tags (`@param`, `@returns`, `@throws`).
+
+## What this preset is for
+
+Use `jsdoc` when you want a function-signature documentation baseline that feels familiar to JSDoc-heavy teams.
+
+It is a practical option for:
+
+- mixed JS/TS repositories
+- teams migrating toward stronger docs without full TSDoc strictness
+- service codebases that mainly care about function contracts
+
+## What this preset enables
+
+- [`tsdoc-require-2/require`](../require.md)
+- [`tsdoc-require-2/require-param`](../required-tags/require-param.md) with `enforceFor: ["function"]`
+- [`tsdoc-require-2/require-returns`](../required-tags/require-returns.md) with `enforceFor: ["function"]`
+- [`tsdoc-require-2/require-throws`](../required-tags/require-throws.md) with `enforceFor: ["function"]`
+
+## Important behavior detail
+
+This preset scopes the tag rules to functions only. It does not require `@remarks`, `@typeParam`, or tag restrictions.
+
+## Config key
+
+`tsdocRequire.configs.jsdoc`
+
+## Flat Config example
+
+```ts
+import tsdocRequire from "eslint-plugin-tsdoc-require-2";
+
+export default [
+    tsdocRequire.configs.jsdoc,
+];
+```
+
+## When to choose a different preset
+
+- Choose [`tsdoc`](./tsdoc.md) when you need stronger TSDoc conventions and restricted tag vocabulary.
+- Choose [`recommended`](./recommended.md) when function tags would create too much migration noise initially.

package/docs/rules/presets/packages.md

@@ -0,0 +1,41 @@
+# packages
+
+Package-focused preset for package entrypoint and module-level narrative docs.
+
+## What this preset is for
+
+Use `packages` when you publish libraries/SDKs and want package-level documentation quality, not only declaration-level comments.
+
+This preset is useful for:
+
+- npm packages with public entrypoints
+- monorepo packages with independent docs contracts
+- API libraries that rely on `@packageDocumentation`
+
+## What this preset enables
+
+- [`tsdoc-require-2/require`](../require.md)
+- [`tsdoc-require-2/require-remarks`](../required-tags/require-remarks.md)
+- [`tsdoc-require-2/require-package-documentation`](../required-tags/require-package-documentation.md)
+
+Compared to `detailed`, this adds package-level documentation intent.
+
+## Config key
+
+`tsdocRequire.configs.packages`
+
+## Flat Config example
+
+```ts
+import tsdocRequire from "eslint-plugin-tsdoc-require-2";
+
+export default [
+    tsdocRequire.configs.packages,
+];
+```
+
+## Practical guidance
+
+- Start here for library repos where docs are part of the public contract.
+- Pair with [`tsdoc`](./tsdoc.md) if you also need strict function/type tag policy.
+- If package-level docs are not relevant, `detailed` is usually a better baseline.

package/docs/rules/presets/recommended.md

@@ -0,0 +1,37 @@
+# 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
+
+- [`tsdoc-require-2/require`](../require.md)
+
+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
+
+```ts
+import tsdocRequire from "eslint-plugin-tsdoc-require-2";
+
+export default [
+    tsdocRequire.configs.recommended,
+];
+```
+
+## When to choose a stricter preset
+
+- Move to [`detailed`](./detailed.md) when every doc block should include `@remarks`.
+- Move to [`jsdoc`](./jsdoc.md) or [`tsdoc`](./tsdoc.md) when function/tag contracts matter.
+- Move to [`packages`](./packages.md) for package-level API docs.

package/docs/rules/presets/tsdoc.md

@@ -0,0 +1,45 @@
+# 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`](../require.md)
+- [`tsdoc-require-2/require-remarks`](../required-tags/require-remarks.md)
+- [`tsdoc-require-2/require-param`](../required-tags/require-param.md) with `enforceFor: ["function"]`
+- [`tsdoc-require-2/require-returns`](../required-tags/require-returns.md) with `enforceFor: ["function"]`
+- [`tsdoc-require-2/require-throws`](../required-tags/require-throws.md) with `enforceFor: ["function"]`
+- [`tsdoc-require-2/require-type-param`](../required-tags/require-type-param.md) with `enforceFor: ["class", "function", "interface", "type"]`
+- [`tsdoc-require-2/restrict-tags`](../restrict-tags.md) 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
+
+```ts
+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.

package/docs/rules/presets/typedoc-strict.md

@@ -0,0 +1,50 @@
+# 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
+
+- [`tsdoc-require-2/require`](../require.md)
+- [`tsdoc-require-2/require-class`](../required-tags/require-class.md) with `enforceFor: ["class"]`
+- [`tsdoc-require-2/require-enum`](../required-tags/require-enum.md) with `enforceFor: ["enum"]`
+- [`tsdoc-require-2/require-function`](../required-tags/require-function.md) with `enforceFor: ["function"]`
+- [`tsdoc-require-2/require-interface`](../required-tags/require-interface.md) with `enforceFor: ["interface"]`
+- [`tsdoc-require-2/require-module`](../required-tags/require-module.md) with `enforceFor: ["namespace"]`
+- [`tsdoc-require-2/require-remarks`](../required-tags/require-remarks.md)
+- [`tsdoc-require-2/restrict-tags`](../restrict-tags.md) in deny mode for TypeDoc compatibility tags
+
+## 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
+
+```ts
+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.

package/docs/rules/presets/typedoc.md

@@ -0,0 +1,44 @@
+# typedoc
+
+Conservative TypeDoc-oriented preset with declaration-kind tags that are safe to infer.
+
+## What this preset is for
+
+Use `typedoc` when your documentation pipeline expects explicit TypeDoc-style declaration tags.
+
+This preset is useful for codebases that:
+
+- generate docs with TypeDoc
+- want explicit declaration classification tags
+- are not ready for broader strictness from `typedoc-strict`
+
+## What this preset enables
+
+- [`tsdoc-require-2/require`](../require.md)
+- [`tsdoc-require-2/require-class`](../required-tags/require-class.md) with `enforceFor: ["class"]`
+- [`tsdoc-require-2/require-enum`](../required-tags/require-enum.md) with `enforceFor: ["enum"]`
+- [`tsdoc-require-2/require-function`](../required-tags/require-function.md) with `enforceFor: ["function"]`
+- [`tsdoc-require-2/require-interface`](../required-tags/require-interface.md) with `enforceFor: ["interface"]`
+
+## Trade-offs
+
+- Focused on declaration-kind tags, not broader narrative or function-signature tag coverage.
+- Does not include `restrict-tags`; add it manually if tag vocabulary control matters.
+
+## Config key
+
+`tsdocRequire.configs.typedoc`
+
+## Flat Config example
+
+```ts
+import tsdocRequire from "eslint-plugin-tsdoc-require-2";
+
+export default [
+    tsdocRequire.configs.typedoc,
+];
+```
+
+## Next step
+
+Move to [`typedoc-strict`](./typedoc-strict.md) for module-level remarks and tag restrictions.