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

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

@@ -26,19 +26,19 @@ Flat config example (function-focused scope):
 import tsdocRequire from "eslint-plugin-tsdoc-require-2";
 
 export default [
-  {
-    plugins: {
-      "tsdoc-require-2": tsdocRequire,
-    },
-    rules: {
-      "tsdoc-require-2/require-throws": [
-        "error",
-        {
-          enforceFor: ["function"],
-        },
-      ],
+ {
+  plugins: {
+   "tsdoc-require-2": tsdocRequire,
+  },
+  rules: {
+   "tsdoc-require-2/require-throws": [
+    "error",
+    {
+     enforceFor: ["function"],
     },
+   ],
   },
+ },
 ];
 ```
 
@@ -51,11 +51,11 @@ export default [
  * Loads a user by ID.
  */
 export function loadUser(id: string): string {
-  if (id.length === 0) {
-    throw new Error("id is required");
-  }
+ if (id.length === 0) {
+  throw new Error("id is required");
+ }
 
-  return id;
+ return id;
 }
 ```
 
@@ -64,14 +64,15 @@ export function loadUser(id: string): string {
 ```ts
 /**
  * Loads a user by ID.
+ *
  * @throws Error when the id is empty.
  */
 export function loadUser(id: string): string {
-  if (id.length === 0) {
-    throw new Error("id is required");
-  }
+ if (id.length === 0) {
+  throw new Error("id is required");
+ }
 
-  return id;
+ return id;
 }
 ```
 

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

@@ -26,19 +26,19 @@ Flat config example (generic declarations only):
 import tsdocRequire from "eslint-plugin-tsdoc-require-2";
 
 export default [
-  {
-    plugins: {
-      "tsdoc-require-2": tsdocRequire,
-    },
-    rules: {
-      "tsdoc-require-2/require-type-param": [
-        "error",
-        {
-          enforceFor: ["class", "function", "interface", "type"],
-        },
-      ],
+ {
+  plugins: {
+   "tsdoc-require-2": tsdocRequire,
+  },
+  rules: {
+   "tsdoc-require-2/require-type-param": [
+    "error",
+    {
+     enforceFor: ["class", "function", "interface", "type"],
     },
+   ],
   },
+ },
 ];
 ```
 
@@ -51,7 +51,7 @@ export default [
  * Wraps data in a typed container.
  */
 export function wrap<T>(value: T): { value: T } {
-  return { value };
+ return { value };
 }
 ```
 
@@ -60,10 +60,11 @@ export function wrap<T>(value: T): { value: T } {
 ```ts
 /**
  * Wraps data in a typed container.
+ *
  * @typeParam T - Value type stored in the wrapper.
  */
 export function wrap<T>(value: T): { value: T } {
-  return { value };
+ return { value };
 }
 ```
 

package/docs/rules/required-tags/require-use-declared-type.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.
+ *
  * @useDeclaredType
  */
 export function taggedFunction(value: string): string {
-    return value;
+ return value;
 }
 ```
 

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

@@ -15,14 +15,22 @@ It supports the same options as [`tsdoc-require-2/require`](../require.md):
 
 ```json
 {
-  "rules": {
-    "tsdoc-require-2/require-virtual": [
-      "error",
-      {
-        "enforceFor": ["class", "function", "interface", "type", "enum", "variable", "object"]
-      }
+ "rules": {
+  "tsdoc-require-2/require-virtual": [
+   "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,14 +52,15 @@ export function runTask(value: string): string {
 ```ts
 /**
  * Performs a task.
- * @virtual
+ *
+ * @abstract
  */
 export function runTask(value: string): string {
-  return value;
+ return value;
 }
 ```
 
 ## Further reading
 
 - TSDoc tag reference: <https://tsdoc.org/pages/tags/virtual/>
-- Rule index: [required-tags](../required-tags.md)
+- Rule index: [required-tags](../required-tags.md)

package/docs/rules/required-tags.md

@@ -42,14 +42,14 @@ Together, these rules turn documentation from optional prose into a consistent A
  * Creates a user record.
  */
 export function createUser(name: string): string {
-  return name;
+ return name;
 }
 ```
 
 With:
 
 ```ts
-["error", { enforceFor: ["function"] }]
+["error", { enforceFor: ["function"] }];
 ```
 
 for `tsdoc-require-2/require-param` and `tsdoc-require-2/require-returns`.
@@ -59,11 +59,13 @@ for `tsdoc-require-2/require-param` and `tsdoc-require-2/require-returns`.
 ```ts
 /**
  * Creates a user record.
+ *
  * @param name - User display name.
+ *
  * @returns Persisted user ID.
  */
 export function createUser(name: string): string {
-  return name;
+ return name;
 }
 ```
 
@@ -82,20 +84,20 @@ Each `require-*` rule accepts the same option shape:
 
 ```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;
+ },
 ];
 ```
 
@@ -103,20 +105,20 @@ Default options:
 
 ```ts
 [
-  {
-    enforceFor: [
-      "class",
-      "enum",
-      "function",
-      "interface",
-      "namespace",
-      "object",
-      "type",
-      "variable",
-    ],
-    exportMode: "exported",
-  },
-]
+ {
+  enforceFor: [
+   "class",
+   "enum",
+   "function",
+   "interface",
+   "namespace",
+   "object",
+   "type",
+   "variable",
+  ],
+  exportMode: "exported",
+ },
+];
 ```
 
 ### Rules in this family
@@ -184,14 +186,14 @@ Default options:
 import tsdocRequire from "eslint-plugin-tsdoc-require-2";
 
 export default [
-  tsdocRequire.configs.recommended,
-  {
-    rules: {
-      "tsdoc-require-2/require-param": ["error", { enforceFor: ["function"] }],
-      "tsdoc-require-2/require-returns": ["error", { enforceFor: ["function"] }],
-      "tsdoc-require-2/require-throws": ["error", { enforceFor: ["function"] }],
-    },
+ tsdocRequire.configs.recommended,
+ {
+  rules: {
+   "tsdoc-require-2/require-param": ["error", { enforceFor: ["function"] }],
+   "tsdoc-require-2/require-returns": ["error", { enforceFor: ["function"] }],
+   "tsdoc-require-2/require-throws": ["error", { enforceFor: ["function"] }],
   },
+ },
 ];
 ```
 

package/docs/rules/restrict-tags.md

@@ -44,10 +44,11 @@ Use it with:
 ```ts
 /**
  * Calculates a value.
+ *
  * @typedef ResultShape
  */
 export function calculate(): number {
-  return 1;
+ return 1;
 }
 ```
 
@@ -58,10 +59,12 @@ With default configuration (`mode: "deny"`).
 ```ts
 /**
  * Calculates a value.
- * @remarks Uses plain TSDoc tags.
+ *
+ * @remarks
+ *   Uses plain TSDoc tags.
  */
 export function calculate(): number {
-  return 1;
+ return 1;
 }
 ```
 
@@ -80,22 +83,22 @@ With default configuration (`mode: "deny"`).
 
 ```ts
 type Options = [
-  {
-    enforceFor?: Array<
-      | "class"
-      | "enum"
-      | "function"
-      | "interface"
-      | "namespace"
-      | "object"
-      | "type"
-      | "variable"
-    >;
-    exportMode?: "all" | "exported" | "non-exported";
-    includeNonExported?: boolean;
-    mode?: "allow" | "deny";
-    tags?: Array<`@${string}`>;
-  },
+ {
+  enforceFor?: Array<
+   | "class"
+   | "enum"
+   | "function"
+   | "interface"
+   | "namespace"
+   | "object"
+   | "type"
+   | "variable"
+  >;
+  exportMode?: "all" | "exported" | "non-exported";
+  includeNonExported?: boolean;
+  mode?: "allow" | "deny";
+  tags?: Array<`@${string}`>;
+ },
 ];
 ```
 
@@ -103,31 +106,31 @@ Default options:
 
 ```ts
 [
-  {
-    enforceFor: [
-      "class",
-      "enum",
-      "function",
-      "interface",
-      "namespace",
-      "object",
-      "type",
-      "variable",
-    ],
-    exportMode: "exported",
-    mode: "deny",
-    tags: [
-      "@augments",
-      "@callback",
-      "@extends",
-      "@jsx",
-      "@satisfies",
-      "@type",
-      "@typedef",
-      "@yields",
-    ],
-  },
-]
+ {
+  enforceFor: [
+   "class",
+   "enum",
+   "function",
+   "interface",
+   "namespace",
+   "object",
+   "type",
+   "variable",
+  ],
+  exportMode: "exported",
+  mode: "deny",
+  tags: [
+   "@augments",
+   "@callback",
+   "@extends",
+   "@jsx",
+   "@satisfies",
+   "@type",
+   "@typedef",
+   "@yields",
+  ],
+ },
+];
 ```
 
 ### Allow mode example
@@ -137,18 +140,21 @@ Default options:
 ```ts
 /**
  * Calculates a value.
- * @remarks Useful details.
+ *
+ * @remarks
+ *   Useful details.
+ *
  * @deprecated Use newCalculate instead.
  */
 export function calculate(): number {
-  return 1;
+ return 1;
 }
 ```
 
 With:
 
 ```ts
-["error", { mode: "allow", tags: ["@remarks"] }]
+["error", { mode: "allow", tags: ["@remarks"] }];
 ```
 
 #### Valid in allow mode
@@ -156,17 +162,19 @@ With:
 ```ts
 /**
  * Calculates a value.
- * @remarks Useful details.
+ *
+ * @remarks
+ *   Useful details.
  */
 export function calculate(): number {
-  return 1;
+ return 1;
 }
 ```
 
 With:
 
 ```ts
-["error", { mode: "allow", tags: ["@remarks"] }]
+["error", { mode: "allow", tags: ["@remarks"] }];
 ```
 
 ## ESLint flat config example
@@ -175,18 +183,18 @@ With:
 import tsdocRequire from "eslint-plugin-tsdoc-require-2";
 
 export default [
-  tsdocRequire.configs.tsdoc,
-  {
-    rules: {
-      "tsdoc-require-2/restrict-tags": [
-        "error",
-        {
-          mode: "deny",
-          tags: ["@typedef", "@callback"],
-        },
-      ],
+ tsdocRequire.configs.tsdoc,
+ {
+  rules: {
+   "tsdoc-require-2/restrict-tags": [
+    "error",
+    {
+     mode: "deny",
+     tags: ["@typedef", "@callback"],
     },
+   ],
   },
+ },
 ];
 ```