eslint-plugin-tsdoc-require-2 1.2.2 → 1.2.3

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

@@ -15,14 +15,22 @@ It supports the same options as [`tsdoc-require-2/require`](../require.md):
 
 ```json
 {
-  "rules": {
-    "tsdoc-require-2/require-decorator": [
-      "error",
-      {
-        "enforceFor": ["class", "function", "interface", "type", "enum", "variable", "object"]
-      }
+ "rules": {
+  "tsdoc-require-2/require-decorator": [
+   "error",
+   {
+    "enforceFor": [
+     "class",
+     "function",
+     "interface",
+     "type",
+     "enum",
+     "variable",
+     "object"
     ]
-  }
+   }
+  ]
+ }
 }
 ```
 
@@ -35,7 +43,7 @@ It supports the same options as [`tsdoc-require-2/require`](../require.md):
  * Performs a task.
  */
 export function runTask(value: string): string {
-  return value;
+ return value;
 }
 ```
 
@@ -44,10 +52,11 @@ export function runTask(value: string): string {
 ```ts
 /**
  * Performs a task.
+ *
  * @decorator
  */
 export function runTask(value: string): string {
-  return value;
+ return value;
 }
 ```
 

package/docs/rules/required-tags/require-default-value.md

@@ -15,14 +15,22 @@ It supports the same options as [`tsdoc-require-2/require`](../require.md):
 
 ```json
 {
-  "rules": {
-    "tsdoc-require-2/require-default-value": [
-      "error",
-      {
-        "enforceFor": ["class", "function", "interface", "type", "enum", "variable", "object"]
-      }
+ "rules": {
+  "tsdoc-require-2/require-default-value": [
+   "error",
+   {
+    "enforceFor": [
+     "class",
+     "function",
+     "interface",
+     "type",
+     "enum",
+     "variable",
+     "object"
     ]
-  }
+   }
+  ]
+ }
 }
 ```
 
@@ -35,7 +43,7 @@ It supports the same options as [`tsdoc-require-2/require`](../require.md):
  * Performs a task.
  */
 export function runTask(value: string): string {
-  return value;
+ return value;
 }
 ```
 
@@ -44,10 +52,11 @@ export function runTask(value: string): string {
 ```ts
 /**
  * Performs a task.
+ *
  * @defaultValue
  */
 export function runTask(value: string): string {
-  return value;
+ return value;
 }
 ```
 

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

@@ -15,14 +15,22 @@ It supports the same options as [`tsdoc-require-2/require`](../require.md):
 
 ```json
 {
-  "rules": {
-    "tsdoc-require-2/require-deprecated": [
-      "error",
-      {
-        "enforceFor": ["class", "function", "interface", "type", "enum", "variable", "object"]
-      }
+ "rules": {
+  "tsdoc-require-2/require-deprecated": [
+   "error",
+   {
+    "enforceFor": [
+     "class",
+     "function",
+     "interface",
+     "type",
+     "enum",
+     "variable",
+     "object"
     ]
-  }
+   }
+  ]
+ }
 }
 ```
 
@@ -35,7 +43,7 @@ It supports the same options as [`tsdoc-require-2/require`](../require.md):
  * Performs a task.
  */
 export function runTask(value: string): string {
-  return value;
+ return value;
 }
 ```
 
@@ -44,10 +52,11 @@ export function runTask(value: string): string {
 ```ts
 /**
  * Performs a task.
+ *
  * @deprecated
  */
 export function runTask(value: string): string {
-  return value;
+ return value;
 }
 ```
 

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

@@ -16,20 +16,20 @@ This rule accepts the same options as [`tsdoc-require-2/require`](../require.md)
 
   ```ts
   type Options = [
-      {
-          enforceFor?: Array<
-              | "class"
-              | "enum"
-              | "function"
-              | "interface"
-              | "namespace"
-              | "object"
-              | "type"
-              | "variable"
-          >;
-          exportMode?: "all" | "exported" | "non-exported";
-          includeNonExported?: boolean;
-      },
+   {
+    enforceFor?: Array<
+     | "class"
+     | "enum"
+     | "function"
+     | "interface"
+     | "namespace"
+     | "object"
+     | "type"
+     | "variable"
+    >;
+    exportMode?: "all" | "exported" | "non-exported";
+    includeNonExported?: boolean;
+   },
   ];
   ```
 
@@ -37,20 +37,20 @@ This rule accepts the same options as [`tsdoc-require-2/require`](../require.md)
 
   ```ts
   [
-      {
-          enforceFor: [
-              "class",
-              "enum",
-              "function",
-              "interface",
-              "namespace",
-              "object",
-              "type",
-              "variable",
-          ],
-          exportMode: "exported",
-      },
-  ]
+   {
+    enforceFor: [
+     "class",
+     "enum",
+     "function",
+     "interface",
+     "namespace",
+     "object",
+     "type",
+     "variable",
+    ],
+    exportMode: "exported",
+   },
+  ];
   ```
 
 ## ❌ Incorrect
@@ -60,7 +60,7 @@ This rule accepts the same options as [`tsdoc-require-2/require`](../require.md)
  * Performs a tagged operation.
  */
 export function taggedFunction(value: string): string {
-    return value;
+ return value;
 }
 ```
 
@@ -69,10 +69,11 @@ export function taggedFunction(value: string): string {
 ```ts
 /**
  * Performs a tagged operation.
+ *
  * @document
  */
 export function taggedFunction(value: string): string {
-    return value;
+ return value;
 }
 ```
 

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

@@ -26,14 +26,14 @@ Flat config example (enum-only scope):
 import tsdocRequire from "eslint-plugin-tsdoc-require-2";
 
 export default [
-    {
-        plugins: {
-            "tsdoc-require-2": tsdocRequire,
-        },
-        rules: {
-            "tsdoc-require-2/require-enum": ["error", { enforceFor: ["enum"] }],
-        },
-    },
+ {
+  plugins: {
+   "tsdoc-require-2": tsdocRequire,
+  },
+  rules: {
+   "tsdoc-require-2/require-enum": ["error", { enforceFor: ["enum"] }],
+  },
+ },
 ];
 ```
 
@@ -44,8 +44,8 @@ export default [
  * Status values accepted by the API.
  */
 export enum Status {
-    Ready = "ready",
-    Running = "running",
+ Ready = "ready",
+ Running = "running",
 }
 ```
 
@@ -54,11 +54,12 @@ export enum Status {
 ```ts
 /**
  * Status values accepted by the API.
+ *
  * @enum
  */
 export enum Status {
-    Ready = "ready",
-    Running = "running",
+ Ready = "ready",
+ Running = "running",
 }
 ```
 

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

@@ -15,14 +15,22 @@ It supports the same options as [`tsdoc-require-2/require`](../require.md):
 
 ```json
 {
-  "rules": {
-    "tsdoc-require-2/require-event-property": [
-      "error",
-      {
-        "enforceFor": ["class", "function", "interface", "type", "enum", "variable", "object"]
-      }
+ "rules": {
+  "tsdoc-require-2/require-event-property": [
+   "error",
+   {
+    "enforceFor": [
+     "class",
+     "function",
+     "interface",
+     "type",
+     "enum",
+     "variable",
+     "object"
     ]
-  }
+   }
+  ]
+ }
 }
 ```
 
@@ -35,7 +43,7 @@ It supports the same options as [`tsdoc-require-2/require`](../require.md):
  * Performs a task.
  */
 export function runTask(value: string): string {
-  return value;
+ return value;
 }
 ```
 
@@ -44,10 +52,11 @@ export function runTask(value: string): string {
 ```ts
 /**
  * Performs a task.
+ *
  * @eventProperty
  */
 export function runTask(value: string): string {
-  return value;
+ return value;
 }
 ```
 

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

@@ -16,20 +16,20 @@ This rule accepts the same options as [`tsdoc-require-2/require`](../require.md)
 
   ```ts
   type Options = [
-      {
-          enforceFor?: Array<
-              | "class"
-              | "enum"
-              | "function"
-              | "interface"
-              | "namespace"
-              | "object"
-              | "type"
-              | "variable"
-          >;
-          exportMode?: "all" | "exported" | "non-exported";
-          includeNonExported?: boolean;
-      },
+   {
+    enforceFor?: Array<
+     | "class"
+     | "enum"
+     | "function"
+     | "interface"
+     | "namespace"
+     | "object"
+     | "type"
+     | "variable"
+    >;
+    exportMode?: "all" | "exported" | "non-exported";
+    includeNonExported?: boolean;
+   },
   ];
   ```
 
@@ -37,20 +37,20 @@ This rule accepts the same options as [`tsdoc-require-2/require`](../require.md)
 
   ```ts
   [
-      {
-          enforceFor: [
-              "class",
-              "enum",
-              "function",
-              "interface",
-              "namespace",
-              "object",
-              "type",
-              "variable",
-          ],
-          exportMode: "exported",
-      },
-  ]
+   {
+    enforceFor: [
+     "class",
+     "enum",
+     "function",
+     "interface",
+     "namespace",
+     "object",
+     "type",
+     "variable",
+    ],
+    exportMode: "exported",
+   },
+  ];
   ```
 
 ## ❌ Incorrect
@@ -60,7 +60,7 @@ This rule accepts the same options as [`tsdoc-require-2/require`](../require.md)
  * Performs a tagged operation.
  */
 export function taggedFunction(value: string): string {
-    return value;
+ return value;
 }
 ```
 
@@ -69,10 +69,11 @@ export function taggedFunction(value: string): string {
 ```ts
 /**
  * Performs a tagged operation.
+ *
  * @event
  */
 export function taggedFunction(value: string): string {
-    return value;
+ return value;
 }
 ```
 

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

@@ -15,14 +15,22 @@ It supports the same options as [`tsdoc-require-2/require`](../require.md):
 
 ```json
 {
-  "rules": {
-    "tsdoc-require-2/require-example": [
-      "error",
-      {
-        "enforceFor": ["class", "function", "interface", "type", "enum", "variable", "object"]
-      }
+ "rules": {
+  "tsdoc-require-2/require-example": [
+   "error",
+   {
+    "enforceFor": [
+     "class",
+     "function",
+     "interface",
+     "type",
+     "enum",
+     "variable",
+     "object"
     ]
-  }
+   }
+  ]
+ }
 }
 ```
 
@@ -35,7 +43,7 @@ It supports the same options as [`tsdoc-require-2/require`](../require.md):
  * Performs a task.
  */
 export function runTask(value: string): string {
-  return value;
+ return value;
 }
 ```
 
@@ -44,10 +52,9 @@ export function runTask(value: string): string {
 ```ts
 /**
  * Performs a task.
- * @example
  */
 export function runTask(value: string): string {
-  return value;
+ return value;
 }
 ```
 

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

@@ -16,20 +16,20 @@ This rule accepts the same options as [`tsdoc-require-2/require`](../require.md)
 
   ```ts
   type Options = [
-      {
-          enforceFor?: Array<
-              | "class"
-              | "enum"
-              | "function"
-              | "interface"
-              | "namespace"
-              | "object"
-              | "type"
-              | "variable"
-          >;
-          exportMode?: "all" | "exported" | "non-exported";
-          includeNonExported?: boolean;
-      },
+   {
+    enforceFor?: Array<
+     | "class"
+     | "enum"
+     | "function"
+     | "interface"
+     | "namespace"
+     | "object"
+     | "type"
+     | "variable"
+    >;
+    exportMode?: "all" | "exported" | "non-exported";
+    includeNonExported?: boolean;
+   },
   ];
   ```
 
@@ -37,20 +37,20 @@ This rule accepts the same options as [`tsdoc-require-2/require`](../require.md)
 
   ```ts
   [
-      {
-          enforceFor: [
-              "class",
-              "enum",
-              "function",
-              "interface",
-              "namespace",
-              "object",
-              "type",
-              "variable",
-          ],
-          exportMode: "exported",
-      },
-  ]
+   {
+    enforceFor: [
+     "class",
+     "enum",
+     "function",
+     "interface",
+     "namespace",
+     "object",
+     "type",
+     "variable",
+    ],
+    exportMode: "exported",
+   },
+  ];
   ```
 
 ## ❌ Incorrect
@@ -60,7 +60,7 @@ This rule accepts the same options as [`tsdoc-require-2/require`](../require.md)
  * Performs a tagged operation.
  */
 export function taggedFunction(value: string): string {
-    return value;
+ return value;
 }
 ```
 
@@ -69,10 +69,11 @@ export function taggedFunction(value: string): string {
 ```ts
 /**
  * Performs a tagged operation.
+ *
  * @expand
  */
 export function taggedFunction(value: string): string {
-    return value;
+ return value;
 }
 ```
 

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

@@ -15,14 +15,22 @@ It supports the same options as [`tsdoc-require-2/require`](../require.md):
 
 ```json
 {
-  "rules": {
-    "tsdoc-require-2/require-experimental": [
-      "error",
-      {
-        "enforceFor": ["class", "function", "interface", "type", "enum", "variable", "object"]
-      }
+ "rules": {
+  "tsdoc-require-2/require-experimental": [
+   "error",
+   {
+    "enforceFor": [
+     "class",
+     "function",
+     "interface",
+     "type",
+     "enum",
+     "variable",
+     "object"
     ]
-  }
+   }
+  ]
+ }
 }
 ```
 
@@ -35,7 +43,7 @@ It supports the same options as [`tsdoc-require-2/require`](../require.md):
  * Performs a task.
  */
 export function runTask(value: string): string {
-  return value;
+ return value;
 }
 ```
 
@@ -44,10 +52,11 @@ export function runTask(value: string): string {
 ```ts
 /**
  * Performs a task.
+ *
  * @experimental
  */
 export function runTask(value: string): string {
-  return value;
+ return value;
 }
 ```
 

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

@@ -26,17 +26,14 @@ Flat config example (function-only scope):
 import tsdocRequire from "eslint-plugin-tsdoc-require-2";
 
 export default [
-    {
-        plugins: {
-            "tsdoc-require-2": tsdocRequire,
-        },
-        rules: {
-            "tsdoc-require-2/require-function": [
-                "error",
-                { enforceFor: ["function"] },
-            ],
-        },
-    },
+ {
+  plugins: {
+   "tsdoc-require-2": tsdocRequire,
+  },
+  rules: {
+   "tsdoc-require-2/require-function": ["error", { enforceFor: ["function"] }],
+  },
+ },
 ];
 ```
 
@@ -47,7 +44,7 @@ export default [
  * Creates a stable slug for a title.
  */
 export function toSlug(value: string): string {
-    return value.trim().toLowerCase();
+ return value.trim().toLowerCase();
 }
 ```
 
@@ -56,10 +53,11 @@ export function toSlug(value: string): string {
 ```ts
 /**
  * Creates a stable slug for a title.
+ *
  * @function
  */
 export function toSlug(value: string): string {
-    return value.trim().toLowerCase();
+ return value.trim().toLowerCase();
 }
 ```