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

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

@@ -0,0 +1,57 @@
+# tsdoc-require-2/require-virtual
+
+Require the `@virtual` 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 `@virtual`. 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-virtual": [
+      "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.
+ * @virtual
+ */
+export function runTask(value: string): string {
+  return value;
+}
+```
+
+## Further reading
+
+- TSDoc tag reference: <https://tsdoc.org/pages/tags/virtual/>
+- Rule index: [required-tags](../required-tags.md)

package/docs/rules/required-tags.md

@@ -0,0 +1,76 @@
+# required-tags
+
+Require specific TSDoc tags to exist in TSDoc blocks for exported declarations, with optional enforcement for non-exported top-level declarations.
+
+## Rules in this family
+
+- [`tsdoc-require-2/require-alpha`](./required-tags/require-alpha.md)
+- [`tsdoc-require-2/require-beta`](./required-tags/require-beta.md)
+- [`tsdoc-require-2/require-decorator`](./required-tags/require-decorator.md)
+- [`tsdoc-require-2/require-default-value`](./required-tags/require-default-value.md)
+- [`tsdoc-require-2/require-deprecated`](./required-tags/require-deprecated.md)
+- [`tsdoc-require-2/require-event-property`](./required-tags/require-event-property.md)
+- [`tsdoc-require-2/require-example`](./required-tags/require-example.md)
+- [`tsdoc-require-2/require-experimental`](./required-tags/require-experimental.md)
+- [`tsdoc-require-2/require-inherit-doc`](./required-tags/require-inherit-doc.md)
+- [`tsdoc-require-2/require-internal`](./required-tags/require-internal.md)
+- [`tsdoc-require-2/require-label`](./required-tags/require-label.md)
+- [`tsdoc-require-2/require-link`](./required-tags/require-link.md)
+- [`tsdoc-require-2/require-override`](./required-tags/require-override.md)
+- [`tsdoc-require-2/require-package-documentation`](./required-tags/require-package-documentation.md)
+- [`tsdoc-require-2/require-param`](./required-tags/require-param.md)
+- [`tsdoc-require-2/require-private-remarks`](./required-tags/require-private-remarks.md)
+- [`tsdoc-require-2/require-public`](./required-tags/require-public.md)
+- [`tsdoc-require-2/require-readonly`](./required-tags/require-readonly.md)
+- [`tsdoc-require-2/require-remarks`](./required-tags/require-remarks.md)
+- [`tsdoc-require-2/require-returns`](./required-tags/require-returns.md)
+- [`tsdoc-require-2/require-sealed`](./required-tags/require-sealed.md)
+- [`tsdoc-require-2/require-see`](./required-tags/require-see.md)
+- [`tsdoc-require-2/require-throws`](./required-tags/require-throws.md)
+- [`tsdoc-require-2/require-type-param`](./required-tags/require-type-param.md)
+- [`tsdoc-require-2/require-virtual`](./required-tags/require-virtual.md)
+
+## Shared options
+
+Each rule accepts the same option shape:
+
+```ts
+[
+    {
+        enforceFor?: Array<
+            | "class"
+            | "enum"
+            | "function"
+            | "interface"
+            | "object"
+            | "type"
+            | "variable"
+        >;
+        includeNonExported?: boolean;
+    },
+]
+```
+
+Default:
+
+```ts
+[
+    {
+        enforceFor: [
+            "class",
+            "enum",
+            "function",
+            "interface",
+            "object",
+            "type",
+            "variable",
+        ],
+        includeNonExported: false,
+    },
+]
+```
+
+- `enforceFor`: limits which declaration kinds are checked.
+- `includeNonExported`: when `true`, also checks non-exported top-level declarations.
+
+For behavior and examples, open each individual rule document linked above.

package/package.json

@@ -1,7 +1,8 @@
 {
     "$schema": "https://www.schemastore.org/package.json",
     "name": "eslint-plugin-tsdoc-require-2",
-    "version": "1.0.1",
+    "version": "1.0.3",
+    "private": false,
     "description": "Require TSDoc comments for exported TypeScript declarations.",
     "keywords": [
         "eslint",
@@ -21,78 +22,101 @@
         "url": "git+https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2.git"
     },
     "license": "MIT",
-    "author": "Nick2bad4u <20943337+Nick2bad4u@users.noreply.github.com> (https://nick2bad4u.github.io/eslint-plugin-typefest)",
+    "author": "Nick2bad4u <20943337+Nick2bad4u@users.noreply.github.com> (https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2)",
     "contributors": [
         {
             "name": "Nick2bad4u",
             "email": "20943337+Nick2bad4u@users.noreply.github.com",
-            "url": "https://nick2bad4u.github.io/eslint-plugin-typefest"
+            "url": "https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2"
         }
     ],
     "sideEffects": false,
     "type": "module",
     "exports": {
         ".": {
-            "types": "./dist/plugin.d.ts",
-            "import": "./dist/plugin.js",
+            "import": {
+                "types": "./dist/plugin.d.ts",
+                "default": "./dist/plugin.js"
+            },
+            "require": {
+                "types": "./dist/plugin.d.cts",
+                "default": "./dist/plugin.cjs"
+            },
             "default": "./dist/plugin.js"
         }
     },
-    "main": "./dist/plugin.js",
-    "types": "./dist/plugin.d.ts",
+    "main": "./dist/plugin.cjs",
+    "module": "./dist/plugin.js",
+    "types": "./dist/plugin.d.cts",
     "files": [
         "dist",
         "docs/rules",
         "CHANGELOG.md"
     ],
     "scripts": {
-        "build": "tsc -p tsconfig.build.json",
+        "build": "tsc -p tsconfig.build.json && node ./scripts/write-cjs-entry.mjs",
         "changelog:release-notes": "node ./scripts/changelog-release-notes.mjs",
         "clean": "rimraf coverage dist temp .cache",
+        "contrib": "all-contributors",
+        "contrib:add": "all-contributors add",
+        "contrib:check": "all-contributors check",
+        "contrib:compare": "npm run contrib:check",
+        "contrib:generate": "all-contributors generate",
         "lint": "eslint --cache --cache-strategy content --cache-location .cache/.eslintcache",
         "lint:compat:eslint": "node ./scripts/eslint-compat-smoke.mjs",
         "lint:compat:eslint10": "npm run lint:compat:eslint -- --expect-eslint-major=10",
         "lint:compat:eslint9": "npm run lint:compat:eslint -- --expect-eslint-major=9",
         "lint:fix": "eslint --cache --cache-strategy content --cache-location .cache/.eslintcache --fix",
+        "lint:package:strict": "npm run lint:package-check:strict",
+        "lint:package-check": "publint && attw --pack .",
+        "lint:package-check:strict": "publint && attw --pack . --profile strict --config-path ./.attw.json",
         "lint:packagelintrc": "npmPkgJsonLint . --config .npmpackagejsonlintrc.json",
         "lint:prettier": "prettier . --log-level warn --cache --cache-location=.cache/.prettier-cache --cache-strategy=content --check",
         "lint:prettier:fix": "prettier . --log-level warn --cache --cache-location=.cache/.prettier-cache --cache-strategy=content --write",
         "lint:release": "npm run release:check",
         "release:check": "npm run clean && npm run build && npm run typecheck && npm run lint:fix && npm run lint:prettier:fix && npm run test",
+        "sync:readme": "npm run sync:readme:rules-table && npm run sync:readme:presets-matrix",
+        "sync:readme:check": "npm run sync:readme:rules-table:check && npm run sync:readme:presets-matrix:check",
+        "sync:readme:presets-matrix": "node ./scripts/sync-presets-rules-matrix.mjs",
+        "sync:readme:presets-matrix:check": "node ./scripts/sync-presets-rules-matrix.mjs --check",
+        "sync:readme:rules-table": "node ./scripts/sync-readme-rules-table.mjs",
+        "sync:readme:rules-table:check": "node ./scripts/sync-readme-rules-table.mjs --check",
         "test": "vitest run",
         "test:coverage": "vitest run --coverage",
         "test:watch": "vitest",
         "typecheck": "tsc -p tsconfig.json --noEmit && tsc -p tsconfig.build.json --noEmit && tsc -p tsconfig.eslint.json --noEmit && tsc -p tsconfig.js.json --noEmit"
     },
     "dependencies": {
-        "@typescript-eslint/utils": "^8.56.1"
+        "@typescript-eslint/utils": "^8.57.0"
     },
     "devDependencies": {
+        "@arethetypeswrong/cli": "^0.18.2",
         "@docusaurus/eslint-plugin": "^3.9.2",
         "@eslint-community/eslint-plugin-eslint-comments": "^4.7.1",
         "@eslint-react/eslint-plugin": "^2.13.0",
         "@eslint/compat": "^2.0.3",
         "@eslint/config-helpers": "^0.5.3",
-        "@eslint/css": "^0.14.1",
+        "@eslint/css": "^1.0.0",
         "@eslint/js": "^10.0.1",
-        "@eslint/json": "^1.0.1",
+        "@eslint/json": "^1.1.0",
         "@eslint/markdown": "^7.5.1",
         "@html-eslint/eslint-plugin": "^0.58.1",
         "@html-eslint/parser": "^0.58.1",
         "@microsoft/eslint-plugin-sdl": "^1.1.0",
         "@softonus/prettier-plugin-duplicate-remover": "^1.1.2",
         "@stylistic/eslint-plugin": "^5.10.0",
-        "@types/node": "^25.3.5",
-        "@typescript-eslint/eslint-plugin": "^8.56.1",
-        "@typescript-eslint/parser": "^8.56.1",
-        "@typescript-eslint/rule-tester": "^8.56.1",
-        "@vitest/coverage-v8": "^4.0.18",
-        "@vitest/eslint-plugin": "^1.6.9",
+        "@types/node": "^25.5.0",
+        "@typescript-eslint/eslint-plugin": "^8.57.0",
+        "@typescript-eslint/parser": "^8.57.0",
+        "@typescript-eslint/rule-tester": "^8.57.0",
+        "@vitest/coverage-v8": "^4.1.0",
+        "@vitest/eslint-plugin": "^1.6.12",
+        "all-contributors-cli": "^6.26.1",
         "eslint": "^10.0.3",
         "eslint-config-flat-gitignore": "^2.2.1",
         "eslint-config-prettier": "^10.1.8",
         "eslint-import-resolver-typescript": "^4.4.4",
-        "eslint-plugin-array-func": "^5.1.0",
+        "eslint-plugin-array-func": "^5.1.1",
         "eslint-plugin-canonical": "^5.1.3",
         "eslint-plugin-case-police": "^2.2.0",
         "eslint-plugin-comment-length": "^2.3.0",
@@ -101,10 +125,10 @@
         "eslint-plugin-depend": "^1.5.0",
         "eslint-plugin-eslint-plugin": "^7.3.2",
         "eslint-plugin-etc": "^2.0.3",
-        "eslint-plugin-file-progress-2": "^3.4.2",
-        "eslint-plugin-import-x": "^4.16.1",
-        "eslint-plugin-jsdoc": "^62.7.1",
-        "eslint-plugin-jsonc": "^3.1.1",
+        "eslint-plugin-file-progress-2": "^3.4.3",
+        "eslint-plugin-import-x": "^4.16.2",
+        "eslint-plugin-jsdoc": "^62.8.0",
+        "eslint-plugin-jsonc": "^3.1.2",
         "eslint-plugin-jsx-a11y": "^6.10.2",
         "eslint-plugin-listeners": "^1.5.1",
         "eslint-plugin-loadable-imports": "^1.0.1",
@@ -121,16 +145,16 @@
         "eslint-plugin-no-unsanitized": "^4.1.5",
         "eslint-plugin-no-use-extend-native": "^0.7.2",
         "eslint-plugin-node-dependencies": "^2.2.0",
-        "eslint-plugin-package-json": "^0.89.4",
+        "eslint-plugin-package-json": "^0.91.0",
         "eslint-plugin-perfectionist": "^5.6.0",
         "eslint-plugin-prefer-arrow": "^1.2.3",
         "eslint-plugin-prettier": "^5.5.5",
         "eslint-plugin-promise": "^7.2.1",
         "eslint-plugin-redos": "^4.5.0",
-        "eslint-plugin-regexp": "^3.0.0",
+        "eslint-plugin-regexp": "^3.1.0",
         "eslint-plugin-require-jsdoc": "^1.0.4",
         "eslint-plugin-security": "^4.0.0",
-        "eslint-plugin-sonarjs": "^4.0.1",
+        "eslint-plugin-sonarjs": "^4.0.2",
         "eslint-plugin-sort-class-members": "^1.21.0",
         "eslint-plugin-testing-library": "^7.16.0",
         "eslint-plugin-toml": "^1.3.1",
@@ -149,20 +173,21 @@
         "prettier-plugin-interpolated-html-tags": "^2.0.1",
         "prettier-plugin-jsdoc": "^1.8.0",
         "prettier-plugin-merge": "^0.10.0",
-        "prettier-plugin-multiline-arrays": "^4.1.4",
+        "prettier-plugin-multiline-arrays": "^4.1.5",
         "prettier-plugin-packagejson": "^3.0.2",
         "prettier-plugin-properties": "^0.3.1",
         "prettier-plugin-sh": "^0.18.0",
         "prettier-plugin-sort-json": "^4.2.0",
         "prettier-plugin-sql": "^0.19.2",
         "prettier-plugin-toml": "^2.0.6",
+        "publint": "^0.3.18",
         "recheck-jar": "^4.5.0",
         "rimraf": "^6.1.3",
         "toml-eslint-parser": "^1.0.3",
         "typescript": "^5.9.3",
-        "vite": "^7.3.1",
+        "vite": "^8.0.0",
         "vite-tsconfig-paths": "^6.1.1",
-        "vitest": "^4.0.18",
+        "vitest": "^4.1.0",
         "yaml-eslint-parser": "^2.0.0"
     },
     "peerDependencies": {
@@ -170,7 +195,7 @@
         "eslint": "^9.0.0 || ^10.0.0",
         "typescript": ">=5.4.0"
     },
-    "packageManager": "npm@11.11.0",
+    "packageManager": "npm@11.11.1",
     "engines": {
         "node": ">=20.19.0"
     },