docs: improve jsdoc statements

Author: voxpelli

.eslintrc.json

@@ -8,7 +8,8 @@
     "eslint:recommended",
     "plugin:eslint-plugin/recommended",
     "plugin:n/recommended",
-    "plugin:prettier/recommended"
+    "plugin:prettier/recommended",
+    "plugin:jsdoc/recommended"
   ],
   "rules": {
     "no-var": "error",
@@ -22,6 +23,15 @@
     ],
     "eslint-plugin/prefer-placeholders": "error",
     "eslint-plugin/test-case-shorthand-strings": "error",
-    "prettier/prettier": "error"
+    "prettier/prettier": "error",
+    "jsdoc/check-types": "off",
+    "jsdoc/no-undefined-types": "off",
+    "jsdoc/require-jsdoc": "off",
+    "jsdoc/require-param-description": "off",
+    "jsdoc/require-property-description": "off",
+    "jsdoc/require-returns-description": "off",
+    "jsdoc/require-yields": "off",
+    "jsdoc/tag-lines": ["warn", "never", { "startLines": 1 }],
+    "jsdoc/valid-types": "off"
   }
 }

__tests__/rule-tester.js

@@ -1,5 +1,5 @@
 /**
- * @fileoverview Helpers for tests.
+ * @file Helpers for tests.
  * @author 唯然<[email protected]>
  */
 'use strict'

package-lock.json

@@ -76,6 +76,7 @@
   },
   "devDependencies": {
     "@types/eslint": "^9.6.0",
+    "@types/estree": "^1.0.5",
     "@types/node": "^18.19.42",
     "@typescript-eslint/parser": "^7.17.0",
     "doctoc": "^2.2.1",
@@ -84,6 +85,7 @@
     "eslint-doc-generator": "^1.7.1",
     "eslint-plugin-eslint-plugin": "^6.2.0",
     "eslint-plugin-jest": "^28.6.0",
+    "eslint-plugin-jsdoc": "^48.8.3",
     "eslint-plugin-n": "^17.9.0",
     "eslint-plugin-prettier": "^5.2.1",
     "globals": "^15.8.0",