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

package/docs/rules/presets/jsdoc.md

@@ -32,9 +32,7 @@ This preset scopes the tag rules to functions only. It does not require `@remark
 ```ts
 import tsdocRequire from "eslint-plugin-tsdoc-require-2";
 
-export default [
-    tsdocRequire.configs.jsdoc,
-];
+export default [tsdocRequire.configs.jsdoc];
 ```
 
 ## When to choose a different preset

package/docs/rules/presets/packages.md

@@ -29,9 +29,7 @@ Compared to `detailed`, this adds package-level documentation intent.
 ```ts
 import tsdocRequire from "eslint-plugin-tsdoc-require-2";
 
-export default [
-    tsdocRequire.configs.packages,
-];
+export default [tsdocRequire.configs.packages];
 ```
 
 ## Practical guidance

package/docs/rules/presets/recommended.md

@@ -25,9 +25,7 @@ This preset only checks that comments exist. It does **not** require tags like `
 ```ts
 import tsdocRequire from "eslint-plugin-tsdoc-require-2";
 
-export default [
-    tsdocRequire.configs.recommended,
-];
+export default [tsdocRequire.configs.recommended];
 ```
 
 ## When to choose a stricter preset

package/docs/rules/presets/tsdoc.md

@@ -35,9 +35,7 @@ This preset works well for:
 ```ts
 import tsdocRequire from "eslint-plugin-tsdoc-require-2";
 
-export default [
-    tsdocRequire.configs.tsdoc,
-];
+export default [tsdocRequire.configs.tsdoc];
 ```
 
 ## Common customization

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

@@ -40,9 +40,7 @@ Compared to `typedoc`, this preset adds:
 ```ts
 import tsdocRequire from "eslint-plugin-tsdoc-require-2";
 
-export default [
-    tsdocRequire.configs["typedoc-strict"],
-];
+export default [tsdocRequire.configs["typedoc-strict"]];
 ```
 
 ## Common customization

package/docs/rules/presets/typedoc.md

@@ -34,9 +34,7 @@ This preset is useful for codebases that:
 ```ts
 import tsdocRequire from "eslint-plugin-tsdoc-require-2";
 
-export default [
-    tsdocRequire.configs.typedoc,
-];
+export default [tsdocRequire.configs.typedoc];
 ```
 
 ## Next step

package/docs/rules/require.md

@@ -31,7 +31,7 @@ When `exportMode: "all"` is enabled, the same checks also apply to non-exported
 
 If exported APIs are undocumented, consumers have to infer contracts from implementation details.
 
-This rule is the foundation for the plugin’s policy model:
+This rule is the foundation for the plugin's policy model:
 
 - [`required-tags`](./required-tags.md) rules validate comment content.
 - [`restrict-tags`](./restrict-tags.md) validates tag vocabulary.
@@ -43,7 +43,7 @@ This rule is the foundation for the plugin’s policy model:
 export class MissingDocs {}
 
 interface Shape {
-  radius: number;
+ radius: number;
 }
 
 export { Shape };
@@ -60,7 +60,7 @@ export class DocumentedClass {}
 
 /** Shape shared in the public API. */
 interface Shape {
-  radius: number;
+ radius: number;
 }
 
 export { Shape };
@@ -85,20 +85,20 @@ This rule accepts one optional object.
 
 ```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;
+ },
 ];
 ```
 
@@ -106,11 +106,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",
+ },
+];
 ```
 
 ### `enforceFor`
@@ -123,19 +132,19 @@ Example flat config that only enforces docs for classes and functions:
 import tsdocRequire from "eslint-plugin-tsdoc-require-2";
 
 export default [
-  {
-    plugins: {
-      "tsdoc-require-2": tsdocRequire,
-    },
-    rules: {
-      "tsdoc-require-2/require": [
-        "error",
-        {
-          enforceFor: ["class", "function"],
-        },
-      ],
+ {
+  plugins: {
+   "tsdoc-require-2": tsdocRequire,
+  },
+  rules: {
+   "tsdoc-require-2/require": [
+    "error",
+    {
+     enforceFor: ["class", "function"],
     },
+   ],
   },
+ },
 ];
 ```
 
@@ -153,19 +162,19 @@ Example flat config:
 import tsdocRequire from "eslint-plugin-tsdoc-require-2";
 
 export default [
-  {
-    plugins: {
-      "tsdoc-require-2": tsdocRequire,
-    },
-    rules: {
-      "tsdoc-require-2/require": [
-        "error",
-        {
-          exportMode: "all",
-        },
-      ],
+ {
+  plugins: {
+   "tsdoc-require-2": tsdocRequire,
+  },
+  rules: {
+   "tsdoc-require-2/require": [
+    "error",
+    {
+     exportMode: "all",
     },
+   ],
   },
+ },
 ];
 ```
 

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

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

@@ -15,14 +15,22 @@ It supports the same options as [`tsdoc-require-2/require`](../require.md):
 
 ```json
 {
-  "rules": {
-    "tsdoc-require-2/require-alpha": [
-      "error",
-      {
-        "enforceFor": ["class", "function", "interface", "type", "enum", "variable", "object"]
-      }
+ "rules": {
+  "tsdoc-require-2/require-alpha": [
+   "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.
+ *
  * @alpha
  */
 export function runTask(value: string): string {
-  return value;
+ return value;
 }
 ```
 

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

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

@@ -15,14 +15,22 @@ It supports the same options as [`tsdoc-require-2/require`](../require.md):
 
 ```json
 {
-  "rules": {
-    "tsdoc-require-2/require-beta": [
-      "error",
-      {
-        "enforceFor": ["class", "function", "interface", "type", "enum", "variable", "object"]
-      }
+ "rules": {
+  "tsdoc-require-2/require-beta": [
+   "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.
+ *
  * @beta
  */
 export function runTask(value: string): string {
-  return value;
+ return value;
 }
 ```
 

package/docs/rules/required-tags/require-category.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,9 @@ export function taggedFunction(value: string): string {
 ```ts
 /**
  * Performs a tagged operation.
- * @category
  */
 export function taggedFunction(value: string): string {
-    return value;
+ return value;
 }
 ```
 

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

@@ -26,14 +26,14 @@ Flat config example (class-only scope):
 import tsdocRequire from "eslint-plugin-tsdoc-require-2";
 
 export default [
-    {
-        plugins: {
-            "tsdoc-require-2": tsdocRequire,
-        },
-        rules: {
-            "tsdoc-require-2/require-class": ["error", { enforceFor: ["class"] }],
-        },
-    },
+ {
+  plugins: {
+   "tsdoc-require-2": tsdocRequire,
+  },
+  rules: {
+   "tsdoc-require-2/require-class": ["error", { enforceFor: ["class"] }],
+  },
+ },
 ];
 ```
 
@@ -44,7 +44,7 @@ export default [
  * Represents a cache entry.
  */
 export class CacheEntry {
-    public constructor(public readonly key: string) {}
+ public constructor(public readonly key: string) {}
 }
 ```
 
@@ -53,10 +53,11 @@ export class CacheEntry {
 ```ts
 /**
  * Represents a cache entry.
+ *
  * @class
  */
 export class CacheEntry {
-    public constructor(public readonly key: string) {}
+ public constructor(public readonly key: string) {}
 }
 ```