chore: update eslint-plugin-jsdoc to 46.2.5 (#17245)

aladdin-add · web-flow · commit da81e66e22b4 · 2023-06-21T11:49:19.000-04:00
1. Removes `jsdoc/newline-after-description` rule in favor of `jsdoc/tag-lines` with option `startLines: 0` for "never" and `startLines: 1` for "always". Refs: https://github.com/gajus/eslint-plugin-jsdoc/releases/tag/v42.0.0 2. disabled rule jsdoc/no-defaults: it's a new added rule in its recommended config that eslint does not follow. 3. disabled rule jsdoc/check-line-alignment: I've tried its option "never"|"always"|"any" - none of them fully meet our needs.
diff --git a/lib/rule-tester/flat-rule-tester.js b/lib/rule-tester/flat-rule-tester.js
@@ -33,7 +33,7 @@ const { ConfigArraySymbol } = require("@humanwhocodes/config-array");
 /** @typedef {import("../shared/types").Parser} Parser */
 /** @typedef {import("../shared/types").LanguageOptions} LanguageOptions */
 
-/* eslint-disable jsdoc/valid-types -- https://github.com/jsdoc-type-pratt-parser/jsdoc-type-pratt-parser/issues/4#issuecomment-778805577 */
+
 /**
  * A test case that is expected to pass lint.
  * @typedef {Object} ValidTestCase
@@ -72,7 +72,6 @@ const { ConfigArraySymbol } = require("@humanwhocodes/config-array");
  * @property {number} [endLine] The 1-based line number of the reported end location.
  * @property {number} [endColumn] The 1-based column number of the reported end location.
  */
-/* eslint-enable jsdoc/valid-types -- https://github.com/jsdoc-type-pratt-parser/jsdoc-type-pratt-parser/issues/4#issuecomment-778805577 */
 
 //------------------------------------------------------------------------------
 // Private Members
diff --git a/lib/rule-tester/rule-tester.js b/lib/rule-tester/rule-tester.js
@@ -63,7 +63,7 @@ const { SourceCode } = require("../source-code");
 
 /** @typedef {import("../shared/types").Parser} Parser */
 
-/* eslint-disable jsdoc/valid-types -- https://github.com/jsdoc-type-pratt-parser/jsdoc-type-pratt-parser/issues/4#issuecomment-778805577 */
+
 /**
  * A test case that is expected to pass lint.
  * @typedef {Object} ValidTestCase
@@ -108,7 +108,6 @@ const { SourceCode } = require("../source-code");
  * @property {number} [endLine] The 1-based line number of the reported end location.
  * @property {number} [endColumn] The 1-based column number of the reported end location.
  */
-/* eslint-enable jsdoc/valid-types -- https://github.com/jsdoc-type-pratt-parser/jsdoc-type-pratt-parser/issues/4#issuecomment-778805577 */
 
 //------------------------------------------------------------------------------
 // Private Members
diff --git a/package.json b/package.json
@@ -115,7 +115,7 @@
     "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-eslint-plugin": "^5.1.0",
     "eslint-plugin-internal-rules": "file:tools/internal-rules",
-    "eslint-plugin-jsdoc": "^38.1.6",
+    "eslint-plugin-jsdoc": "^46.2.5",
     "eslint-plugin-n": "^16.0.0",
     "eslint-plugin-unicorn": "^42.0.0",
     "eslint-release": "^3.2.0",
diff --git a/packages/eslint-config-eslint/eslintrc.js b/packages/eslint-config-eslint/eslintrc.js
@@ -101,16 +101,15 @@ module.exports = {
         "generator-star-spacing": "error",
         "grouped-accessor-pairs": "error",
         "guard-for-in": "error",
-        "jsdoc/check-line-alignment": ["error", "never"],
         "jsdoc/check-syntax": "error",
         "jsdoc/check-values": [
             "error",
             {
                 allowedLicenses: true
             }
         ],
-        "jsdoc/newline-after-description": ["error", "never"],
         "jsdoc/no-bad-blocks": "error",
+        "jsdoc/no-defaults": "off",
         "jsdoc/require-asterisk-prefix": "error",
         "jsdoc/require-description": [
             "error",
@@ -138,8 +137,10 @@ module.exports = {
                     fileoverview: {
                         lines: "any"
                     }
-                }
+                },
+                startLines: 0
             }
+
         ],
         "jsdoc/no-undefined-types": "off",
         "jsdoc/require-yields": "off",
diff --git a/packages/eslint-config-eslint/index.js b/packages/eslint-config-eslint/index.js
@@ -312,11 +312,10 @@ const jsdocConfigs = [jsdoc.configs.recommended, {
         }
     },
     rules: {
-        "jsdoc/check-line-alignment": ["error", "never"],
         "jsdoc/check-syntax": "error",
         "jsdoc/check-values": ["error", { allowedLicenses: true }],
-        "jsdoc/newline-after-description": ["error", "never"],
         "jsdoc/no-bad-blocks": "error",
+        "jsdoc/no-defaults": "off",
         "jsdoc/require-asterisk-prefix": "error",
         "jsdoc/require-description": ["error", { checkConstructors: false }],
         "jsdoc/require-hyphen-before-param-description": ["error", "never"],
@@ -330,13 +329,10 @@ const jsdocConfigs = [jsdoc.configs.recommended, {
         "jsdoc/tag-lines": ["error", "never",
             {
                 tags: {
-                    example: {
-                        lines: "always"
-                    },
-                    fileoverview: {
-                        lines: "any"
-                    }
-                }
+                    example: { lines: "always" },
+                    fileoverview: { lines: "any" }
+                },
+                startLines: 0
             }
         ],
         "jsdoc/no-undefined-types": "off",
diff --git a/packages/eslint-config-eslint/package.json b/packages/eslint-config-eslint/package.json
@@ -22,7 +22,7 @@
   "dependencies": {
     "@eslint/js": "^8.42.0",
     "eslint-plugin-eslint-comments": "^3.2.0",
-    "eslint-plugin-jsdoc": "^38.1.6",
+    "eslint-plugin-jsdoc": "^46.2.5",
     "eslint-plugin-n": "^16.0.0",
     "eslint-plugin-unicorn": "^42.0.0"
   },
