eslint-plugin-tsdoc-require-2 1.0.2 → 1.0.3

package/docs/rules/required-tags/require-deprecated.md

@@ -0,0 +1,57 @@
+# tsdoc-require-2/require-deprecated
+
+Require the `@deprecated` tag in TSDoc blocks for exported declarations.
+
+## Rule details
+
+By default, this rule reports exported declarations (and supported default exports) that have TSDoc but are missing `@deprecated`. Set `includeNonExported: true` to also check non-exported top-level declarations.
+
+It supports the same options as [`tsdoc-require-2/require`](../require.md):
+
+- `enforceFor`: choose which declaration kinds are checked.
+- `includeNonExported`: when `true`, also check non-exported top-level declarations (default: `false`).
+
+## Options
+
+```json
+{
+  "rules": {
+    "tsdoc-require-2/require-deprecated": [
+      "error",
+      {
+        "enforceFor": ["class", "function", "interface", "type", "enum", "variable", "object"]
+      }
+    ]
+  }
+}
+```
+
+## Examples
+
+### ❌ Incorrect
+
+```ts
+/**
+ * Performs a task.
+ */
+export function runTask(value: string): string {
+  return value;
+}
+```
+
+### ✅ Correct
+
+```ts
+/**
+ * Performs a task.
+ * @deprecated
+ */
+export function runTask(value: string): string {
+  return value;
+}
+```
+
+## Further reading
+
+- TSDoc tag reference: <https://tsdoc.org/pages/tags/deprecated/>
+- Rule index: [required-tags](../required-tags.md)

package/docs/rules/required-tags/require-event-property.md

@@ -0,0 +1,57 @@
+# tsdoc-require-2/require-event-property
+
+Require the `@eventProperty` tag in TSDoc blocks for exported declarations.
+
+## Rule details
+
+By default, this rule reports exported declarations (and supported default exports) that have TSDoc but are missing `@eventProperty`. Set `includeNonExported: true` to also check non-exported top-level declarations.
+
+It supports the same options as [`tsdoc-require-2/require`](../require.md):
+
+- `enforceFor`: choose which declaration kinds are checked.
+- `includeNonExported`: when `true`, also check non-exported top-level declarations (default: `false`).
+
+## Options
+
+```json
+{
+  "rules": {
+    "tsdoc-require-2/require-event-property": [
+      "error",
+      {
+        "enforceFor": ["class", "function", "interface", "type", "enum", "variable", "object"]
+      }
+    ]
+  }
+}
+```
+
+## Examples
+
+### ❌ Incorrect
+
+```ts
+/**
+ * Performs a task.
+ */
+export function runTask(value: string): string {
+  return value;
+}
+```
+
+### ✅ Correct
+
+```ts
+/**
+ * Performs a task.
+ * @eventProperty
+ */
+export function runTask(value: string): string {
+  return value;
+}
+```
+
+## Further reading
+
+- TSDoc tag reference: <https://tsdoc.org/pages/tags/eventproperty/>
+- Rule index: [required-tags](../required-tags.md)

package/docs/rules/required-tags/require-example.md

@@ -0,0 +1,57 @@
+# tsdoc-require-2/require-example
+
+Require the `@example` tag in TSDoc blocks for exported declarations.
+
+## Rule details
+
+By default, this rule reports exported declarations (and supported default exports) that have TSDoc but are missing `@example`. Set `includeNonExported: true` to also check non-exported top-level declarations.
+
+It supports the same options as [`tsdoc-require-2/require`](../require.md):
+
+- `enforceFor`: choose which declaration kinds are checked.
+- `includeNonExported`: when `true`, also check non-exported top-level declarations (default: `false`).
+
+## Options
+
+```json
+{
+  "rules": {
+    "tsdoc-require-2/require-example": [
+      "error",
+      {
+        "enforceFor": ["class", "function", "interface", "type", "enum", "variable", "object"]
+      }
+    ]
+  }
+}
+```
+
+## Examples
+
+### ❌ Incorrect
+
+```ts
+/**
+ * Performs a task.
+ */
+export function runTask(value: string): string {
+  return value;
+}
+```
+
+### ✅ Correct
+
+```ts
+/**
+ * Performs a task.
+ * @example
+ */
+export function runTask(value: string): string {
+  return value;
+}
+```
+
+## Further reading
+
+- TSDoc tag reference: <https://tsdoc.org/pages/tags/example/>
+- Rule index: [required-tags](../required-tags.md)

package/docs/rules/required-tags/require-experimental.md

@@ -0,0 +1,57 @@
+# tsdoc-require-2/require-experimental
+
+Require the `@experimental` tag in TSDoc blocks for exported declarations.
+
+## Rule details
+
+By default, this rule reports exported declarations (and supported default exports) that have TSDoc but are missing `@experimental`. Set `includeNonExported: true` to also check non-exported top-level declarations.
+
+It supports the same options as [`tsdoc-require-2/require`](../require.md):
+
+- `enforceFor`: choose which declaration kinds are checked.
+- `includeNonExported`: when `true`, also check non-exported top-level declarations (default: `false`).
+
+## Options
+
+```json
+{
+  "rules": {
+    "tsdoc-require-2/require-experimental": [
+      "error",
+      {
+        "enforceFor": ["class", "function", "interface", "type", "enum", "variable", "object"]
+      }
+    ]
+  }
+}
+```
+
+## Examples
+
+### ❌ Incorrect
+
+```ts
+/**
+ * Performs a task.
+ */
+export function runTask(value: string): string {
+  return value;
+}
+```
+
+### ✅ Correct
+
+```ts
+/**
+ * Performs a task.
+ * @experimental
+ */
+export function runTask(value: string): string {
+  return value;
+}
+```
+
+## Further reading
+
+- TSDoc tag reference: <https://tsdoc.org/pages/tags/experimental/>
+- Rule index: [required-tags](../required-tags.md)

package/docs/rules/required-tags/require-inherit-doc.md

@@ -0,0 +1,57 @@
+# tsdoc-require-2/require-inherit-doc
+
+Require the `@inheritDoc` tag in TSDoc blocks for exported declarations.
+
+## Rule details
+
+By default, this rule reports exported declarations (and supported default exports) that have TSDoc but are missing `@inheritDoc`. Set `includeNonExported: true` to also check non-exported top-level declarations.
+
+It supports the same options as [`tsdoc-require-2/require`](../require.md):
+
+- `enforceFor`: choose which declaration kinds are checked.
+- `includeNonExported`: when `true`, also check non-exported top-level declarations (default: `false`).
+
+## Options
+
+```json
+{
+  "rules": {
+    "tsdoc-require-2/require-inherit-doc": [
+      "error",
+      {
+        "enforceFor": ["class", "function", "interface", "type", "enum", "variable", "object"]
+      }
+    ]
+  }
+}
+```
+
+## Examples
+
+### ❌ Incorrect
+
+```ts
+/**
+ * Performs a task.
+ */
+export function runTask(value: string): string {
+  return value;
+}
+```
+
+### ✅ Correct
+
+```ts
+/**
+ * Performs a task.
+ * @inheritDoc
+ */
+export function runTask(value: string): string {
+  return value;
+}
+```
+
+## Further reading
+
+- TSDoc tag reference: <https://tsdoc.org/pages/tags/inheritdoc/>
+- Rule index: [required-tags](../required-tags.md)

package/docs/rules/required-tags/require-internal.md

@@ -0,0 +1,57 @@
+# tsdoc-require-2/require-internal
+
+Require the `@internal` tag in TSDoc blocks for exported declarations.
+
+## Rule details
+
+By default, this rule reports exported declarations (and supported default exports) that have TSDoc but are missing `@internal`. Set `includeNonExported: true` to also check non-exported top-level declarations.
+
+It supports the same options as [`tsdoc-require-2/require`](../require.md):
+
+- `enforceFor`: choose which declaration kinds are checked.
+- `includeNonExported`: when `true`, also check non-exported top-level declarations (default: `false`).
+
+## Options
+
+```json
+{
+  "rules": {
+    "tsdoc-require-2/require-internal": [
+      "error",
+      {
+        "enforceFor": ["class", "function", "interface", "type", "enum", "variable", "object"]
+      }
+    ]
+  }
+}
+```
+
+## Examples
+
+### ❌ Incorrect
+
+```ts
+/**
+ * Performs a task.
+ */
+export function runTask(value: string): string {
+  return value;
+}
+```
+
+### ✅ Correct
+
+```ts
+/**
+ * Performs a task.
+ * @internal
+ */
+export function runTask(value: string): string {
+  return value;
+}
+```
+
+## Further reading
+
+- TSDoc tag reference: <https://tsdoc.org/pages/tags/internal/>
+- Rule index: [required-tags](../required-tags.md)

package/docs/rules/required-tags/require-label.md

@@ -0,0 +1,57 @@
+# tsdoc-require-2/require-label
+
+Require the `@label` tag in TSDoc blocks for exported declarations.
+
+## Rule details
+
+By default, this rule reports exported declarations (and supported default exports) that have TSDoc but are missing `@label`. Set `includeNonExported: true` to also check non-exported top-level declarations.
+
+It supports the same options as [`tsdoc-require-2/require`](../require.md):
+
+- `enforceFor`: choose which declaration kinds are checked.
+- `includeNonExported`: when `true`, also check non-exported top-level declarations (default: `false`).
+
+## Options
+
+```json
+{
+  "rules": {
+    "tsdoc-require-2/require-label": [
+      "error",
+      {
+        "enforceFor": ["class", "function", "interface", "type", "enum", "variable", "object"]
+      }
+    ]
+  }
+}
+```
+
+## Examples
+
+### ❌ Incorrect
+
+```ts
+/**
+ * Performs a task.
+ */
+export function runTask(value: string): string {
+  return value;
+}
+```
+
+### ✅ Correct
+
+```ts
+/**
+ * Performs a task.
+ * @label
+ */
+export function runTask(value: string): string {
+  return value;
+}
+```
+
+## Further reading
+
+- TSDoc tag reference: <https://tsdoc.org/pages/tags/label/>
+- Rule index: [required-tags](../required-tags.md)

package/docs/rules/required-tags/require-link.md

@@ -0,0 +1,57 @@
+# tsdoc-require-2/require-link
+
+Require the `@link` tag in TSDoc blocks for exported declarations.
+
+## Rule details
+
+By default, this rule reports exported declarations (and supported default exports) that have TSDoc but are missing `@link`. Set `includeNonExported: true` to also check non-exported top-level declarations.
+
+It supports the same options as [`tsdoc-require-2/require`](../require.md):
+
+- `enforceFor`: choose which declaration kinds are checked.
+- `includeNonExported`: when `true`, also check non-exported top-level declarations (default: `false`).
+
+## Options
+
+```json
+{
+  "rules": {
+    "tsdoc-require-2/require-link": [
+      "error",
+      {
+        "enforceFor": ["class", "function", "interface", "type", "enum", "variable", "object"]
+      }
+    ]
+  }
+}
+```
+
+## Examples
+
+### ❌ Incorrect
+
+```ts
+/**
+ * Performs a task.
+ */
+export function runTask(value: string): string {
+  return value;
+}
+```
+
+### ✅ Correct
+
+```ts
+/**
+ * Performs a task.
+ * @link
+ */
+export function runTask(value: string): string {
+  return value;
+}
+```
+
+## Further reading
+
+- TSDoc tag reference: <https://tsdoc.org/pages/tags/link/>
+- Rule index: [required-tags](../required-tags.md)

package/docs/rules/required-tags/require-override.md

@@ -0,0 +1,57 @@
+# tsdoc-require-2/require-override
+
+Require the `@override` tag in TSDoc blocks for exported declarations.
+
+## Rule details
+
+By default, this rule reports exported declarations (and supported default exports) that have TSDoc but are missing `@override`. Set `includeNonExported: true` to also check non-exported top-level declarations.
+
+It supports the same options as [`tsdoc-require-2/require`](../require.md):
+
+- `enforceFor`: choose which declaration kinds are checked.
+- `includeNonExported`: when `true`, also check non-exported top-level declarations (default: `false`).
+
+## Options
+
+```json
+{
+  "rules": {
+    "tsdoc-require-2/require-override": [
+      "error",
+      {
+        "enforceFor": ["class", "function", "interface", "type", "enum", "variable", "object"]
+      }
+    ]
+  }
+}
+```
+
+## Examples
+
+### ❌ Incorrect
+
+```ts
+/**
+ * Performs a task.
+ */
+export function runTask(value: string): string {
+  return value;
+}
+```
+
+### ✅ Correct
+
+```ts
+/**
+ * Performs a task.
+ * @override
+ */
+export function runTask(value: string): string {
+  return value;
+}
+```
+
+## Further reading
+
+- TSDoc tag reference: <https://tsdoc.org/pages/tags/override/>
+- Rule index: [required-tags](../required-tags.md)

package/docs/rules/required-tags/require-package-documentation.md

@@ -0,0 +1,57 @@
+# tsdoc-require-2/require-package-documentation
+
+Require the `@packageDocumentation` tag in TSDoc blocks for exported declarations.
+
+## Rule details
+
+By default, this rule reports exported declarations (and supported default exports) that have TSDoc but are missing `@packageDocumentation`. Set `includeNonExported: true` to also check non-exported top-level declarations.
+
+It supports the same options as [`tsdoc-require-2/require`](../require.md):
+
+- `enforceFor`: choose which declaration kinds are checked.
+- `includeNonExported`: when `true`, also check non-exported top-level declarations (default: `false`).
+
+## Options
+
+```json
+{
+  "rules": {
+    "tsdoc-require-2/require-package-documentation": [
+      "error",
+      {
+        "enforceFor": ["class", "function", "interface", "type", "enum", "variable", "object"]
+      }
+    ]
+  }
+}
+```
+
+## Examples
+
+### ❌ Incorrect
+
+```ts
+/**
+ * Performs a task.
+ */
+export function runTask(value: string): string {
+  return value;
+}
+```
+
+### ✅ Correct
+
+```ts
+/**
+ * Performs a task.
+ * @packageDocumentation
+ */
+export function runTask(value: string): string {
+  return value;
+}
+```
+
+## Further reading
+
+- TSDoc tag reference: <https://tsdoc.org/pages/tags/packagedocumentation/>
+- Rule index: [required-tags](../required-tags.md)

package/docs/rules/required-tags/require-param.md

@@ -0,0 +1,57 @@
+# tsdoc-require-2/require-param
+
+Require the `@param` tag in TSDoc blocks for exported declarations.
+
+## Rule details
+
+By default, this rule reports exported declarations (and supported default exports) that have TSDoc but are missing `@param`. Set `includeNonExported: true` to also check non-exported top-level declarations.
+
+It supports the same options as [`tsdoc-require-2/require`](../require.md):
+
+- `enforceFor`: choose which declaration kinds are checked.
+- `includeNonExported`: when `true`, also check non-exported top-level declarations (default: `false`).
+
+## Options
+
+```json
+{
+  "rules": {
+    "tsdoc-require-2/require-param": [
+      "error",
+      {
+        "enforceFor": ["class", "function", "interface", "type", "enum", "variable", "object"]
+      }
+    ]
+  }
+}
+```
+
+## Examples
+
+### ❌ Incorrect
+
+```ts
+/**
+ * Performs a task.
+ */
+export function runTask(value: string): string {
+  return value;
+}
+```
+
+### ✅ Correct
+
+```ts
+/**
+ * Performs a task.
+ * @param
+ */
+export function runTask(value: string): string {
+  return value;
+}
+```
+
+## Further reading
+
+- TSDoc tag reference: <https://tsdoc.org/pages/tags/param/>
+- Rule index: [required-tags](../required-tags.md)

package/docs/rules/required-tags/require-private-remarks.md

@@ -0,0 +1,57 @@
+# tsdoc-require-2/require-private-remarks
+
+Require the `@privateRemarks` tag in TSDoc blocks for exported declarations.
+
+## Rule details
+
+By default, this rule reports exported declarations (and supported default exports) that have TSDoc but are missing `@privateRemarks`. Set `includeNonExported: true` to also check non-exported top-level declarations.
+
+It supports the same options as [`tsdoc-require-2/require`](../require.md):
+
+- `enforceFor`: choose which declaration kinds are checked.
+- `includeNonExported`: when `true`, also check non-exported top-level declarations (default: `false`).
+
+## Options
+
+```json
+{
+  "rules": {
+    "tsdoc-require-2/require-private-remarks": [
+      "error",
+      {
+        "enforceFor": ["class", "function", "interface", "type", "enum", "variable", "object"]
+      }
+    ]
+  }
+}
+```
+
+## Examples
+
+### ❌ Incorrect
+
+```ts
+/**
+ * Performs a task.
+ */
+export function runTask(value: string): string {
+  return value;
+}
+```
+
+### ✅ Correct
+
+```ts
+/**
+ * Performs a task.
+ * @privateRemarks
+ */
+export function runTask(value: string): string {
+  return value;
+}
+```
+
+## Further reading
+
+- TSDoc tag reference: <https://tsdoc.org/pages/tags/privateremarks/>
+- Rule index: [required-tags](../required-tags.md)