eslint-plugin-tsdoc-require-2 1.2.1 → 1.2.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +103 -101
- package/dist/internal/require-tag-factory.cjs +40 -48
- package/dist/internal/require-tag-factory.d.ts +7 -8
- package/dist/internal/require-tag-factory.d.ts.map +1 -1
- package/dist/internal/require-tag-factory.js +41 -49
- package/dist/internal/require-tag-factory.js.map +1 -1
- package/dist/plugin.cjs +9 -2
- package/dist/plugin.d.ts.map +1 -1
- package/dist/plugin.js +9 -2
- package/dist/plugin.js.map +1 -1
- package/dist/rules/require-tag-rules.js +112 -112
- package/dist/rules/require.cjs +39 -47
- package/dist/rules/require.d.ts +3 -3
- package/dist/rules/require.d.ts.map +1 -1
- package/dist/rules/require.js +40 -48
- package/dist/rules/require.js.map +1 -1
- package/dist/rules/required-tags/require-abstract.cjs +1 -3
- package/dist/rules/required-tags/require-abstract.d.ts.map +1 -1
- package/dist/rules/required-tags/require-abstract.js +1 -3
- package/dist/rules/required-tags/require-abstract.js.map +1 -1
- package/dist/rules/required-tags/require-alpha.cjs +1 -3
- package/dist/rules/required-tags/require-alpha.d.ts.map +1 -1
- package/dist/rules/required-tags/require-alpha.js +1 -3
- package/dist/rules/required-tags/require-alpha.js.map +1 -1
- package/dist/rules/required-tags/require-author.cjs +1 -3
- package/dist/rules/required-tags/require-author.d.ts.map +1 -1
- package/dist/rules/required-tags/require-author.js +1 -3
- package/dist/rules/required-tags/require-author.js.map +1 -1
- package/dist/rules/required-tags/require-beta.cjs +1 -3
- package/dist/rules/required-tags/require-beta.d.ts.map +1 -1
- package/dist/rules/required-tags/require-beta.js +1 -3
- package/dist/rules/required-tags/require-beta.js.map +1 -1
- package/dist/rules/required-tags/require-category.cjs +1 -3
- package/dist/rules/required-tags/require-category.d.ts.map +1 -1
- package/dist/rules/required-tags/require-category.js +1 -3
- package/dist/rules/required-tags/require-category.js.map +1 -1
- package/dist/rules/required-tags/require-class.cjs +1 -3
- package/dist/rules/required-tags/require-class.d.ts.map +1 -1
- package/dist/rules/required-tags/require-class.js +1 -3
- package/dist/rules/required-tags/require-class.js.map +1 -1
- package/dist/rules/required-tags/require-decorator.cjs +1 -3
- package/dist/rules/required-tags/require-decorator.d.ts.map +1 -1
- package/dist/rules/required-tags/require-decorator.js +1 -3
- package/dist/rules/required-tags/require-decorator.js.map +1 -1
- package/dist/rules/required-tags/require-default-value.cjs +1 -3
- package/dist/rules/required-tags/require-default-value.d.ts.map +1 -1
- package/dist/rules/required-tags/require-default-value.js +1 -3
- package/dist/rules/required-tags/require-default-value.js.map +1 -1
- package/dist/rules/required-tags/require-deprecated.cjs +1 -3
- package/dist/rules/required-tags/require-deprecated.d.ts.map +1 -1
- package/dist/rules/required-tags/require-deprecated.js +1 -3
- package/dist/rules/required-tags/require-deprecated.js.map +1 -1
- package/dist/rules/required-tags/require-document.cjs +1 -3
- package/dist/rules/required-tags/require-document.d.ts.map +1 -1
- package/dist/rules/required-tags/require-document.js +1 -3
- package/dist/rules/required-tags/require-document.js.map +1 -1
- package/dist/rules/required-tags/require-enum.cjs +1 -3
- package/dist/rules/required-tags/require-enum.d.ts.map +1 -1
- package/dist/rules/required-tags/require-enum.js +1 -3
- package/dist/rules/required-tags/require-enum.js.map +1 -1
- package/dist/rules/required-tags/require-event-property.cjs +1 -3
- package/dist/rules/required-tags/require-event-property.d.ts.map +1 -1
- package/dist/rules/required-tags/require-event-property.js +1 -3
- package/dist/rules/required-tags/require-event-property.js.map +1 -1
- package/dist/rules/required-tags/require-event.cjs +1 -3
- package/dist/rules/required-tags/require-event.d.ts.map +1 -1
- package/dist/rules/required-tags/require-event.js +1 -3
- package/dist/rules/required-tags/require-event.js.map +1 -1
- package/dist/rules/required-tags/require-example.cjs +1 -3
- package/dist/rules/required-tags/require-example.d.ts.map +1 -1
- package/dist/rules/required-tags/require-example.js +1 -3
- package/dist/rules/required-tags/require-example.js.map +1 -1
- package/dist/rules/required-tags/require-expand.cjs +1 -3
- package/dist/rules/required-tags/require-expand.d.ts.map +1 -1
- package/dist/rules/required-tags/require-expand.js +1 -3
- package/dist/rules/required-tags/require-expand.js.map +1 -1
- package/dist/rules/required-tags/require-experimental.cjs +1 -3
- package/dist/rules/required-tags/require-experimental.d.ts.map +1 -1
- package/dist/rules/required-tags/require-experimental.js +1 -3
- package/dist/rules/required-tags/require-experimental.js.map +1 -1
- package/dist/rules/required-tags/require-function.cjs +1 -3
- package/dist/rules/required-tags/require-function.d.ts.map +1 -1
- package/dist/rules/required-tags/require-function.js +1 -3
- package/dist/rules/required-tags/require-function.js.map +1 -1
- package/dist/rules/required-tags/require-group.cjs +1 -3
- package/dist/rules/required-tags/require-group.d.ts.map +1 -1
- package/dist/rules/required-tags/require-group.js +1 -3
- package/dist/rules/required-tags/require-group.js.map +1 -1
- package/dist/rules/required-tags/require-hidden.cjs +1 -3
- package/dist/rules/required-tags/require-hidden.d.ts.map +1 -1
- package/dist/rules/required-tags/require-hidden.js +1 -3
- package/dist/rules/required-tags/require-hidden.js.map +1 -1
- package/dist/rules/required-tags/require-hideconstructor.cjs +1 -3
- package/dist/rules/required-tags/require-hideconstructor.d.ts.map +1 -1
- package/dist/rules/required-tags/require-hideconstructor.js +1 -3
- package/dist/rules/required-tags/require-hideconstructor.js.map +1 -1
- package/dist/rules/required-tags/require-ignore.cjs +1 -3
- package/dist/rules/required-tags/require-ignore.d.ts.map +1 -1
- package/dist/rules/required-tags/require-ignore.js +1 -3
- package/dist/rules/required-tags/require-ignore.js.map +1 -1
- package/dist/rules/required-tags/require-import.cjs +1 -3
- package/dist/rules/required-tags/require-import.d.ts.map +1 -1
- package/dist/rules/required-tags/require-import.js +1 -3
- package/dist/rules/required-tags/require-import.js.map +1 -1
- package/dist/rules/required-tags/require-include.cjs +1 -3
- package/dist/rules/required-tags/require-include.d.ts.map +1 -1
- package/dist/rules/required-tags/require-include.js +1 -3
- package/dist/rules/required-tags/require-include.js.map +1 -1
- package/dist/rules/required-tags/require-inherit-doc.cjs +1 -3
- package/dist/rules/required-tags/require-inherit-doc.d.ts.map +1 -1
- package/dist/rules/required-tags/require-inherit-doc.js +1 -3
- package/dist/rules/required-tags/require-inherit-doc.js.map +1 -1
- package/dist/rules/required-tags/require-inline.cjs +1 -3
- package/dist/rules/required-tags/require-inline.d.ts.map +1 -1
- package/dist/rules/required-tags/require-inline.js +1 -3
- package/dist/rules/required-tags/require-inline.js.map +1 -1
- package/dist/rules/required-tags/require-interface.cjs +1 -3
- package/dist/rules/required-tags/require-interface.d.ts.map +1 -1
- package/dist/rules/required-tags/require-interface.js +1 -3
- package/dist/rules/required-tags/require-interface.js.map +1 -1
- package/dist/rules/required-tags/require-internal.cjs +1 -3
- package/dist/rules/required-tags/require-internal.d.ts.map +1 -1
- package/dist/rules/required-tags/require-internal.js +1 -3
- package/dist/rules/required-tags/require-internal.js.map +1 -1
- package/dist/rules/required-tags/require-label.cjs +1 -3
- package/dist/rules/required-tags/require-label.d.ts.map +1 -1
- package/dist/rules/required-tags/require-label.js +1 -3
- package/dist/rules/required-tags/require-label.js.map +1 -1
- package/dist/rules/required-tags/require-license.cjs +1 -3
- package/dist/rules/required-tags/require-license.d.ts.map +1 -1
- package/dist/rules/required-tags/require-license.js +1 -3
- package/dist/rules/required-tags/require-license.js.map +1 -1
- package/dist/rules/required-tags/require-link.cjs +1 -3
- package/dist/rules/required-tags/require-link.d.ts.map +1 -1
- package/dist/rules/required-tags/require-link.js +1 -3
- package/dist/rules/required-tags/require-link.js.map +1 -1
- package/dist/rules/required-tags/require-merge-module-with.cjs +1 -3
- package/dist/rules/required-tags/require-merge-module-with.d.ts.map +1 -1
- package/dist/rules/required-tags/require-merge-module-with.js +1 -3
- package/dist/rules/required-tags/require-merge-module-with.js.map +1 -1
- package/dist/rules/required-tags/require-module.cjs +1 -3
- package/dist/rules/required-tags/require-module.d.ts.map +1 -1
- package/dist/rules/required-tags/require-module.js +1 -3
- package/dist/rules/required-tags/require-module.js.map +1 -1
- package/dist/rules/required-tags/require-namespace.cjs +1 -3
- package/dist/rules/required-tags/require-namespace.d.ts.map +1 -1
- package/dist/rules/required-tags/require-namespace.js +1 -3
- package/dist/rules/required-tags/require-namespace.js.map +1 -1
- package/dist/rules/required-tags/require-overload.cjs +1 -3
- package/dist/rules/required-tags/require-overload.d.ts.map +1 -1
- package/dist/rules/required-tags/require-overload.js +1 -3
- package/dist/rules/required-tags/require-overload.js.map +1 -1
- package/dist/rules/required-tags/require-override.cjs +1 -3
- package/dist/rules/required-tags/require-override.d.ts.map +1 -1
- package/dist/rules/required-tags/require-override.js +1 -3
- package/dist/rules/required-tags/require-override.js.map +1 -1
- package/dist/rules/required-tags/require-package-documentation.cjs +1 -3
- package/dist/rules/required-tags/require-package-documentation.d.ts.map +1 -1
- package/dist/rules/required-tags/require-package-documentation.js +1 -3
- package/dist/rules/required-tags/require-package-documentation.js.map +1 -1
- package/dist/rules/required-tags/require-param.cjs +1 -3
- package/dist/rules/required-tags/require-param.d.ts.map +1 -1
- package/dist/rules/required-tags/require-param.js +1 -3
- package/dist/rules/required-tags/require-param.js.map +1 -1
- package/dist/rules/required-tags/require-primary-export.cjs +1 -3
- package/dist/rules/required-tags/require-primary-export.d.ts.map +1 -1
- package/dist/rules/required-tags/require-primary-export.js +1 -3
- package/dist/rules/required-tags/require-primary-export.js.map +1 -1
- package/dist/rules/required-tags/require-private-remarks.cjs +1 -3
- package/dist/rules/required-tags/require-private-remarks.d.ts.map +1 -1
- package/dist/rules/required-tags/require-private-remarks.js +1 -3
- package/dist/rules/required-tags/require-private-remarks.js.map +1 -1
- package/dist/rules/required-tags/require-private.cjs +1 -3
- package/dist/rules/required-tags/require-private.d.ts.map +1 -1
- package/dist/rules/required-tags/require-private.js +1 -3
- package/dist/rules/required-tags/require-private.js.map +1 -1
- package/dist/rules/required-tags/require-property.cjs +1 -3
- package/dist/rules/required-tags/require-property.d.ts.map +1 -1
- package/dist/rules/required-tags/require-property.js +1 -3
- package/dist/rules/required-tags/require-property.js.map +1 -1
- package/dist/rules/required-tags/require-protected.cjs +1 -3
- package/dist/rules/required-tags/require-protected.d.ts.map +1 -1
- package/dist/rules/required-tags/require-protected.js +1 -3
- package/dist/rules/required-tags/require-protected.js.map +1 -1
- package/dist/rules/required-tags/require-public.cjs +1 -3
- package/dist/rules/required-tags/require-public.d.ts.map +1 -1
- package/dist/rules/required-tags/require-public.js +1 -3
- package/dist/rules/required-tags/require-public.js.map +1 -1
- package/dist/rules/required-tags/require-readonly.cjs +1 -3
- package/dist/rules/required-tags/require-readonly.d.ts.map +1 -1
- package/dist/rules/required-tags/require-readonly.js +1 -3
- package/dist/rules/required-tags/require-readonly.js.map +1 -1
- package/dist/rules/required-tags/require-remarks.cjs +1 -3
- package/dist/rules/required-tags/require-remarks.d.ts.map +1 -1
- package/dist/rules/required-tags/require-remarks.js +1 -3
- package/dist/rules/required-tags/require-remarks.js.map +1 -1
- package/dist/rules/required-tags/require-returns.cjs +1 -3
- package/dist/rules/required-tags/require-returns.d.ts.map +1 -1
- package/dist/rules/required-tags/require-returns.js +1 -3
- package/dist/rules/required-tags/require-returns.js.map +1 -1
- package/dist/rules/required-tags/require-sealed.cjs +1 -3
- package/dist/rules/required-tags/require-sealed.d.ts.map +1 -1
- package/dist/rules/required-tags/require-sealed.js +1 -3
- package/dist/rules/required-tags/require-sealed.js.map +1 -1
- package/dist/rules/required-tags/require-see.cjs +1 -3
- package/dist/rules/required-tags/require-see.d.ts.map +1 -1
- package/dist/rules/required-tags/require-see.js +1 -3
- package/dist/rules/required-tags/require-see.js.map +1 -1
- package/dist/rules/required-tags/require-since.cjs +1 -3
- package/dist/rules/required-tags/require-since.d.ts.map +1 -1
- package/dist/rules/required-tags/require-since.js +1 -3
- package/dist/rules/required-tags/require-since.js.map +1 -1
- package/dist/rules/required-tags/require-sort-strategy.cjs +1 -3
- package/dist/rules/required-tags/require-sort-strategy.d.ts.map +1 -1
- package/dist/rules/required-tags/require-sort-strategy.js +1 -3
- package/dist/rules/required-tags/require-sort-strategy.js.map +1 -1
- package/dist/rules/required-tags/require-summary.cjs +1 -3
- package/dist/rules/required-tags/require-summary.d.ts.map +1 -1
- package/dist/rules/required-tags/require-summary.js +1 -3
- package/dist/rules/required-tags/require-summary.js.map +1 -1
- package/dist/rules/required-tags/require-template.cjs +1 -3
- package/dist/rules/required-tags/require-template.d.ts.map +1 -1
- package/dist/rules/required-tags/require-template.js +1 -3
- package/dist/rules/required-tags/require-template.js.map +1 -1
- package/dist/rules/required-tags/require-throws.cjs +1 -3
- package/dist/rules/required-tags/require-throws.d.ts.map +1 -1
- package/dist/rules/required-tags/require-throws.js +1 -3
- package/dist/rules/required-tags/require-throws.js.map +1 -1
- package/dist/rules/required-tags/require-type-param.cjs +1 -3
- package/dist/rules/required-tags/require-type-param.d.ts.map +1 -1
- package/dist/rules/required-tags/require-type-param.js +1 -3
- package/dist/rules/required-tags/require-type-param.js.map +1 -1
- package/dist/rules/required-tags/require-use-declared-type.cjs +1 -3
- package/dist/rules/required-tags/require-use-declared-type.d.ts.map +1 -1
- package/dist/rules/required-tags/require-use-declared-type.js +1 -3
- package/dist/rules/required-tags/require-use-declared-type.js.map +1 -1
- package/dist/rules/required-tags/require-virtual.cjs +1 -3
- package/dist/rules/required-tags/require-virtual.d.ts.map +1 -1
- package/dist/rules/required-tags/require-virtual.js +1 -3
- package/dist/rules/required-tags/require-virtual.js.map +1 -1
- package/dist/rules/restrict-tags.cjs +40 -48
- package/dist/rules/restrict-tags.d.ts +3 -3
- package/dist/rules/restrict-tags.d.ts.map +1 -1
- package/dist/rules/restrict-tags.js +41 -49
- package/dist/rules/restrict-tags.js.map +1 -1
- package/docs/rules/getting-started.md +27 -27
- package/docs/rules/index.md +22 -22
- package/docs/rules/presets/all.md +1 -3
- package/docs/rules/presets/detailed.md +1 -3
- package/docs/rules/presets/index.md +75 -75
- package/docs/rules/presets/jsdoc.md +1 -3
- package/docs/rules/presets/packages.md +1 -3
- package/docs/rules/presets/recommended.md +1 -3
- package/docs/rules/presets/tsdoc.md +1 -3
- package/docs/rules/presets/typedoc-strict.md +1 -3
- package/docs/rules/presets/typedoc.md +1 -3
- package/docs/rules/require.md +53 -44
- package/docs/rules/required-tags/require-abstract.md +31 -30
- package/docs/rules/required-tags/require-alpha.md +18 -9
- package/docs/rules/required-tags/require-author.md +31 -30
- package/docs/rules/required-tags/require-beta.md +18 -9
- package/docs/rules/required-tags/require-category.md +30 -31
- package/docs/rules/required-tags/require-class.md +11 -10
- package/docs/rules/required-tags/require-decorator.md +18 -9
- package/docs/rules/required-tags/require-default-value.md +18 -9
- package/docs/rules/required-tags/require-deprecated.md +18 -9
- package/docs/rules/required-tags/require-document.md +31 -30
- package/docs/rules/required-tags/require-enum.md +13 -12
- package/docs/rules/required-tags/require-event-property.md +18 -9
- package/docs/rules/required-tags/require-event.md +31 -30
- package/docs/rules/required-tags/require-example.md +17 -10
- package/docs/rules/required-tags/require-expand.md +31 -30
- package/docs/rules/required-tags/require-experimental.md +18 -9
- package/docs/rules/required-tags/require-function.md +11 -13
- package/docs/rules/required-tags/require-group.md +31 -30
- package/docs/rules/required-tags/require-hidden.md +32 -31
- package/docs/rules/required-tags/require-hideconstructor.md +31 -30
- package/docs/rules/required-tags/require-ignore.md +31 -30
- package/docs/rules/required-tags/require-import.md +30 -31
- package/docs/rules/required-tags/require-include.md +31 -32
- package/docs/rules/required-tags/require-inherit-doc.md +18 -9
- package/docs/rules/required-tags/require-inline.md +31 -30
- package/docs/rules/required-tags/require-interface.md +14 -13
- package/docs/rules/required-tags/require-internal.md +18 -9
- package/docs/rules/required-tags/require-label.md +18 -9
- package/docs/rules/required-tags/require-license.md +31 -30
- package/docs/rules/required-tags/require-link.md +18 -9
- package/docs/rules/required-tags/require-merge-module-with.md +31 -30
- package/docs/rules/required-tags/require-module.md +14 -13
- package/docs/rules/required-tags/require-namespace.md +31 -30
- package/docs/rules/required-tags/require-overload.md +31 -30
- package/docs/rules/required-tags/require-override.md +18 -9
- package/docs/rules/required-tags/require-package-documentation.md +14 -13
- package/docs/rules/required-tags/require-param.md +14 -13
- package/docs/rules/required-tags/require-primary-export.md +31 -30
- package/docs/rules/required-tags/require-private-remarks.md +18 -11
- package/docs/rules/required-tags/require-private.md +31 -30
- package/docs/rules/required-tags/require-property.md +31 -30
- package/docs/rules/required-tags/require-protected.md +31 -30
- package/docs/rules/required-tags/require-public.md +19 -10
- package/docs/rules/required-tags/require-readonly.md +19 -10
- package/docs/rules/required-tags/require-remarks.md +12 -10
- package/docs/rules/required-tags/require-returns.md +14 -13
- package/docs/rules/required-tags/require-sealed.md +19 -10
- package/docs/rules/required-tags/require-see.md +19 -10
- package/docs/rules/required-tags/require-since.md +30 -31
- package/docs/rules/required-tags/require-sort-strategy.md +31 -30
- package/docs/rules/required-tags/require-summary.md +31 -30
- package/docs/rules/required-tags/require-template.md +31 -30
- package/docs/rules/required-tags/require-throws.md +20 -19
- package/docs/rules/required-tags/require-type-param.md +14 -13
- package/docs/rules/required-tags/require-use-declared-type.md +31 -30
- package/docs/rules/required-tags/require-virtual.md +20 -11
- package/docs/rules/required-tags.md +40 -38
- package/docs/rules/restrict-tags.md +68 -60
- package/package.json +67 -80
|
@@ -6,16 +6,16 @@ Use one preset as your baseline, then add rule overrides for project-specific po
|
|
|
6
6
|
|
|
7
7
|
## How to choose quickly
|
|
8
8
|
|
|
9
|
-
| If you want...
|
|
10
|
-
|
|
|
11
|
-
| Minimal comment presence enforcement
|
|
12
|
-
| More narrative context in docs
|
|
13
|
-
| Package-level docs for published libraries
|
|
14
|
-
| JSDoc-style function tag discipline
|
|
15
|
-
| TSDoc-first function + type-parameter docs with tag restrictions | [`tsdoc`](./tsdoc.md)
|
|
16
|
-
| TypeDoc declaration-kind tagging
|
|
17
|
-
| Strict TypeDoc workflow with module/remarks and restricted tags
|
|
18
|
-
| Maximum strictness for audits or experiments
|
|
9
|
+
| If you want... | Start with |
|
|
10
|
+
| ---------------------------------------------------------------- | --------------------------------------- |
|
|
11
|
+
| Minimal comment presence enforcement | [`recommended`](./recommended.md) |
|
|
12
|
+
| More narrative context in docs | [`detailed`](./detailed.md) |
|
|
13
|
+
| Package-level docs for published libraries | [`packages`](./packages.md) |
|
|
14
|
+
| JSDoc-style function tag discipline | [`jsdoc`](./jsdoc.md) |
|
|
15
|
+
| TSDoc-first function + type-parameter docs with tag restrictions | [`tsdoc`](./tsdoc.md) |
|
|
16
|
+
| TypeDoc declaration-kind tagging | [`typedoc`](./typedoc.md) |
|
|
17
|
+
| Strict TypeDoc workflow with module/remarks and restricted tags | [`typedoc-strict`](./typedoc-strict.md) |
|
|
18
|
+
| Maximum strictness for audits or experiments | [`all`](./all.md) |
|
|
19
19
|
|
|
20
20
|
## Preset catalog
|
|
21
21
|
|
|
@@ -71,66 +71,66 @@ kept in sync with the README.
|
|
|
71
71
|
- [🟦](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.
|
|
72
72
|
- [⚫](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.
|
|
73
73
|
|
|
74
|
-
| Rule
|
|
75
|
-
|
|
|
76
|
-
| [`tsdoc-require-2/require`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/require)
|
|
77
|
-
| [`tsdoc-require-2/require-abstract`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-abstract)
|
|
78
|
-
| [`tsdoc-require-2/require-alpha`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-alpha)
|
|
79
|
-
| [`tsdoc-require-2/require-author`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-author)
|
|
80
|
-
| [`tsdoc-require-2/require-beta`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-beta)
|
|
81
|
-
| [`tsdoc-require-2/require-category`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-category)
|
|
82
|
-
| [`tsdoc-require-2/require-class`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-class)
|
|
83
|
-
| [`tsdoc-require-2/require-decorator`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-decorator)
|
|
84
|
-
| [`tsdoc-require-2/require-default-value`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-default-value)
|
|
85
|
-
| [`tsdoc-require-2/require-deprecated`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-deprecated)
|
|
86
|
-
| [`tsdoc-require-2/require-document`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-document)
|
|
87
|
-
| [`tsdoc-require-2/require-enum`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-enum)
|
|
88
|
-
| [`tsdoc-require-2/require-event`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-event)
|
|
89
|
-
| [`tsdoc-require-2/require-event-property`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-event-property)
|
|
90
|
-
| [`tsdoc-require-2/require-example`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-example)
|
|
91
|
-
| [`tsdoc-require-2/require-expand`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-expand)
|
|
92
|
-
| [`tsdoc-require-2/require-experimental`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-experimental)
|
|
93
|
-
| [`tsdoc-require-2/require-function`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-function)
|
|
94
|
-
| [`tsdoc-require-2/require-group`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-group)
|
|
95
|
-
| [`tsdoc-require-2/require-hidden`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-hidden)
|
|
96
|
-
| [`tsdoc-require-2/require-hideconstructor`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-hideconstructor)
|
|
97
|
-
| [`tsdoc-require-2/require-ignore`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-ignore)
|
|
98
|
-
| [`tsdoc-require-2/require-import`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-import)
|
|
99
|
-
| [`tsdoc-require-2/require-include`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-include)
|
|
100
|
-
| [`tsdoc-require-2/require-inherit-doc`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-inherit-doc)
|
|
101
|
-
| [`tsdoc-require-2/require-inline`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-inline)
|
|
102
|
-
| [`tsdoc-require-2/require-interface`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-interface)
|
|
103
|
-
| [`tsdoc-require-2/require-internal`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-internal)
|
|
104
|
-
| [`tsdoc-require-2/require-label`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-label)
|
|
105
|
-
| [`tsdoc-require-2/require-license`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-license)
|
|
106
|
-
| [`tsdoc-require-2/require-link`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-link)
|
|
107
|
-
| [`tsdoc-require-2/require-merge-module-with`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-merge-module-with)
|
|
108
|
-
| [`tsdoc-require-2/require-module`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-module)
|
|
109
|
-
| [`tsdoc-require-2/require-namespace`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-namespace)
|
|
110
|
-
| [`tsdoc-require-2/require-overload`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-overload)
|
|
111
|
-
| [`tsdoc-require-2/require-override`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-override)
|
|
112
|
-
| [`tsdoc-require-2/require-package-documentation`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-package-documentation) |
|
|
113
|
-
| [`tsdoc-require-2/require-param`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-param)
|
|
114
|
-
| [`tsdoc-require-2/require-primary-export`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-primary-export)
|
|
115
|
-
| [`tsdoc-require-2/require-private`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-private)
|
|
116
|
-
| [`tsdoc-require-2/require-private-remarks`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-private-remarks)
|
|
117
|
-
| [`tsdoc-require-2/require-property`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-property)
|
|
118
|
-
| [`tsdoc-require-2/require-protected`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-protected)
|
|
119
|
-
| [`tsdoc-require-2/require-public`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-public)
|
|
120
|
-
| [`tsdoc-require-2/require-readonly`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-readonly)
|
|
121
|
-
| [`tsdoc-require-2/require-remarks`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-remarks)
|
|
122
|
-
| [`tsdoc-require-2/require-returns`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-returns)
|
|
123
|
-
| [`tsdoc-require-2/require-sealed`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-sealed)
|
|
124
|
-
| [`tsdoc-require-2/require-see`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-see)
|
|
125
|
-
| [`tsdoc-require-2/require-since`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-since)
|
|
126
|
-
| [`tsdoc-require-2/require-sort-strategy`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-sort-strategy)
|
|
127
|
-
| [`tsdoc-require-2/require-summary`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-summary)
|
|
128
|
-
| [`tsdoc-require-2/require-template`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-template)
|
|
129
|
-
| [`tsdoc-require-2/require-throws`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-throws)
|
|
130
|
-
| [`tsdoc-require-2/require-type-param`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-type-param)
|
|
131
|
-
| [`tsdoc-require-2/require-use-declared-type`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-use-declared-type)
|
|
132
|
-
| [`tsdoc-require-2/require-virtual`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-virtual)
|
|
133
|
-
| [`tsdoc-require-2/restrict-tags`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/restrict-tags)
|
|
74
|
+
| Rule | Fix | Preset key |
|
|
75
|
+
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
76
|
+
| [`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) |
|
|
77
|
+
| [`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) |
|
|
78
|
+
| [`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) |
|
|
79
|
+
| [`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) |
|
|
80
|
+
| [`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) |
|
|
81
|
+
| [`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) |
|
|
82
|
+
| [`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) |
|
|
83
|
+
| [`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) |
|
|
84
|
+
| [`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) |
|
|
85
|
+
| [`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) |
|
|
86
|
+
| [`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) |
|
|
87
|
+
| [`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) |
|
|
88
|
+
| [`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) |
|
|
89
|
+
| [`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) |
|
|
90
|
+
| [`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) |
|
|
91
|
+
| [`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) |
|
|
92
|
+
| [`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) |
|
|
93
|
+
| [`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) |
|
|
94
|
+
| [`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) |
|
|
95
|
+
| [`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) |
|
|
96
|
+
| [`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) |
|
|
97
|
+
| [`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) |
|
|
98
|
+
| [`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) |
|
|
99
|
+
| [`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) |
|
|
100
|
+
| [`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) |
|
|
101
|
+
| [`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) |
|
|
102
|
+
| [`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) |
|
|
103
|
+
| [`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) |
|
|
104
|
+
| [`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) |
|
|
105
|
+
| [`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) |
|
|
106
|
+
| [`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) |
|
|
107
|
+
| [`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) |
|
|
108
|
+
| [`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) |
|
|
109
|
+
| [`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) |
|
|
110
|
+
| [`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) |
|
|
111
|
+
| [`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) |
|
|
112
|
+
| [`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) |
|
|
113
|
+
| [`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) |
|
|
114
|
+
| [`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) |
|
|
115
|
+
| [`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) |
|
|
116
|
+
| [`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) |
|
|
117
|
+
| [`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) |
|
|
118
|
+
| [`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) |
|
|
119
|
+
| [`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) |
|
|
120
|
+
| [`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) |
|
|
121
|
+
| [`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) |
|
|
122
|
+
| [`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) |
|
|
123
|
+
| [`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) |
|
|
124
|
+
| [`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) |
|
|
125
|
+
| [`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) |
|
|
126
|
+
| [`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) |
|
|
127
|
+
| [`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) |
|
|
128
|
+
| [`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) |
|
|
129
|
+
| [`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) |
|
|
130
|
+
| [`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) |
|
|
131
|
+
| [`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) |
|
|
132
|
+
| [`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) |
|
|
133
|
+
| [`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) |
|
|
134
134
|
|
|
135
135
|
<!-- END_PRESETS_MATRIX -->
|
|
136
136
|
|
|
@@ -142,12 +142,12 @@ Use one preset baseline, then add an override block.
|
|
|
142
142
|
import tsdocRequire from "eslint-plugin-tsdoc-require-2";
|
|
143
143
|
|
|
144
144
|
export default [
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
},
|
|
145
|
+
tsdocRequire.configs.tsdoc,
|
|
146
|
+
{
|
|
147
|
+
rules: {
|
|
148
|
+
"tsdoc-require-2/require": ["error", { exportMode: "all" }],
|
|
150
149
|
},
|
|
150
|
+
},
|
|
151
151
|
];
|
|
152
152
|
```
|
|
153
153
|
|
|
@@ -32,9 +32,7 @@ This preset scopes the tag rules to functions only. It does not require `@remark
|
|
|
32
32
|
```ts
|
|
33
33
|
import tsdocRequire from "eslint-plugin-tsdoc-require-2";
|
|
34
34
|
|
|
35
|
-
export default [
|
|
36
|
-
tsdocRequire.configs.jsdoc,
|
|
37
|
-
];
|
|
35
|
+
export default [tsdocRequire.configs.jsdoc];
|
|
38
36
|
```
|
|
39
37
|
|
|
40
38
|
## When to choose a different preset
|
|
@@ -29,9 +29,7 @@ Compared to `detailed`, this adds package-level documentation intent.
|
|
|
29
29
|
```ts
|
|
30
30
|
import tsdocRequire from "eslint-plugin-tsdoc-require-2";
|
|
31
31
|
|
|
32
|
-
export default [
|
|
33
|
-
tsdocRequire.configs.packages,
|
|
34
|
-
];
|
|
32
|
+
export default [tsdocRequire.configs.packages];
|
|
35
33
|
```
|
|
36
34
|
|
|
37
35
|
## Practical guidance
|
|
@@ -25,9 +25,7 @@ This preset only checks that comments exist. It does **not** require tags like `
|
|
|
25
25
|
```ts
|
|
26
26
|
import tsdocRequire from "eslint-plugin-tsdoc-require-2";
|
|
27
27
|
|
|
28
|
-
export default [
|
|
29
|
-
tsdocRequire.configs.recommended,
|
|
30
|
-
];
|
|
28
|
+
export default [tsdocRequire.configs.recommended];
|
|
31
29
|
```
|
|
32
30
|
|
|
33
31
|
## When to choose a stricter preset
|
|
@@ -40,9 +40,7 @@ Compared to `typedoc`, this preset adds:
|
|
|
40
40
|
```ts
|
|
41
41
|
import tsdocRequire from "eslint-plugin-tsdoc-require-2";
|
|
42
42
|
|
|
43
|
-
export default [
|
|
44
|
-
tsdocRequire.configs["typedoc-strict"],
|
|
45
|
-
];
|
|
43
|
+
export default [tsdocRequire.configs["typedoc-strict"]];
|
|
46
44
|
```
|
|
47
45
|
|
|
48
46
|
## Common customization
|
package/docs/rules/require.md
CHANGED
|
@@ -31,7 +31,7 @@ When `exportMode: "all"` is enabled, the same checks also apply to non-exported
|
|
|
31
31
|
|
|
32
32
|
If exported APIs are undocumented, consumers have to infer contracts from implementation details.
|
|
33
33
|
|
|
34
|
-
This rule is the foundation for the plugin
|
|
34
|
+
This rule is the foundation for the plugin's policy model:
|
|
35
35
|
|
|
36
36
|
- [`required-tags`](./required-tags.md) rules validate comment content.
|
|
37
37
|
- [`restrict-tags`](./restrict-tags.md) validates tag vocabulary.
|
|
@@ -43,7 +43,7 @@ This rule is the foundation for the plugin’s policy model:
|
|
|
43
43
|
export class MissingDocs {}
|
|
44
44
|
|
|
45
45
|
interface Shape {
|
|
46
|
-
|
|
46
|
+
radius: number;
|
|
47
47
|
}
|
|
48
48
|
|
|
49
49
|
export { Shape };
|
|
@@ -60,7 +60,7 @@ export class DocumentedClass {}
|
|
|
60
60
|
|
|
61
61
|
/** Shape shared in the public API. */
|
|
62
62
|
interface Shape {
|
|
63
|
-
|
|
63
|
+
radius: number;
|
|
64
64
|
}
|
|
65
65
|
|
|
66
66
|
export { Shape };
|
|
@@ -85,20 +85,20 @@ This rule accepts one optional object.
|
|
|
85
85
|
|
|
86
86
|
```ts
|
|
87
87
|
type Options = [
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
88
|
+
{
|
|
89
|
+
enforceFor?: Array<
|
|
90
|
+
| "class"
|
|
91
|
+
| "enum"
|
|
92
|
+
| "function"
|
|
93
|
+
| "interface"
|
|
94
|
+
| "namespace"
|
|
95
|
+
| "object"
|
|
96
|
+
| "type"
|
|
97
|
+
| "variable"
|
|
98
|
+
>;
|
|
99
|
+
exportMode?: "all" | "exported" | "non-exported";
|
|
100
|
+
includeNonExported?: boolean;
|
|
101
|
+
},
|
|
102
102
|
];
|
|
103
103
|
```
|
|
104
104
|
|
|
@@ -106,11 +106,20 @@ Default options:
|
|
|
106
106
|
|
|
107
107
|
```ts
|
|
108
108
|
[
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
109
|
+
{
|
|
110
|
+
enforceFor: [
|
|
111
|
+
"class",
|
|
112
|
+
"enum",
|
|
113
|
+
"function",
|
|
114
|
+
"interface",
|
|
115
|
+
"namespace",
|
|
116
|
+
"object",
|
|
117
|
+
"type",
|
|
118
|
+
"variable",
|
|
119
|
+
],
|
|
120
|
+
exportMode: "exported",
|
|
121
|
+
},
|
|
122
|
+
];
|
|
114
123
|
```
|
|
115
124
|
|
|
116
125
|
### `enforceFor`
|
|
@@ -123,19 +132,19 @@ Example flat config that only enforces docs for classes and functions:
|
|
|
123
132
|
import tsdocRequire from "eslint-plugin-tsdoc-require-2";
|
|
124
133
|
|
|
125
134
|
export default [
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
},
|
|
136
|
-
],
|
|
135
|
+
{
|
|
136
|
+
plugins: {
|
|
137
|
+
"tsdoc-require-2": tsdocRequire,
|
|
138
|
+
},
|
|
139
|
+
rules: {
|
|
140
|
+
"tsdoc-require-2/require": [
|
|
141
|
+
"error",
|
|
142
|
+
{
|
|
143
|
+
enforceFor: ["class", "function"],
|
|
137
144
|
},
|
|
145
|
+
],
|
|
138
146
|
},
|
|
147
|
+
},
|
|
139
148
|
];
|
|
140
149
|
```
|
|
141
150
|
|
|
@@ -153,19 +162,19 @@ Example flat config:
|
|
|
153
162
|
import tsdocRequire from "eslint-plugin-tsdoc-require-2";
|
|
154
163
|
|
|
155
164
|
export default [
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
},
|
|
166
|
-
],
|
|
165
|
+
{
|
|
166
|
+
plugins: {
|
|
167
|
+
"tsdoc-require-2": tsdocRequire,
|
|
168
|
+
},
|
|
169
|
+
rules: {
|
|
170
|
+
"tsdoc-require-2/require": [
|
|
171
|
+
"error",
|
|
172
|
+
{
|
|
173
|
+
exportMode: "all",
|
|
167
174
|
},
|
|
175
|
+
],
|
|
168
176
|
},
|
|
177
|
+
},
|
|
169
178
|
];
|
|
170
179
|
```
|
|
171
180
|
|