fix(getJsdocProcessPlugin): auto-escape *\/ and entities (#1537)

* fix(`getJsdocProcessPlugin`): auto-escape `*\/`; fixes #710
* fix(`getJsdocProcessorPlugin`): escape entities
* docs: share links to AST demos
* chore: update jsdoccomment and devDeps.
* chore: change `run-if-changed` target
* chore: linting
* chore: avoid missing option

Author: brettz9

.README/advanced.md

@@ -67,6 +67,10 @@ providing some of your JavaScript to the wonderful
 [AST Explorer](https://astexplorer.net/) tool and see what AST is built out
 of your code. You can set the tool to the specific parser which you are using.
 
+For comment AST, see the [@es-joy/jsdoccomment demo](https://es-joy.github.io/jsdoccomment/demo/)
+or if you are only interested in type AST, see the
+[jsdoc-type-pratt-parser demo](https://jsdoc-type-pratt-parser.github.io/jsdoc-type-pratt-parser/).
+
 #### Uses/Tips for AST
 
 And if you wish to introspect on the AST of code within your projects, you can

docs/advanced.md

@@ -82,6 +82,10 @@ providing some of your JavaScript to the wonderful
 [AST Explorer](https://astexplorer.net/) tool and see what AST is built out
 of your code. You can set the tool to the specific parser which you are using.
 
+For comment AST, see the [@es-joy/jsdoccomment demo](https://es-joy.github.io/jsdoccomment/demo/)
+or if you are only interested in type AST, see the
+[jsdoc-type-pratt-parser demo](https://jsdoc-type-pratt-parser.github.io/jsdoc-type-pratt-parser/).
+
 <a name="user-content-advanced-ast-and-selectors-uses-tips-for-ast"></a>
 <a name="advanced-ast-and-selectors-uses-tips-for-ast"></a>
 #### Uses/Tips for AST

eslint.config.js

@@ -4,9 +4,9 @@ import {
 import {
   recommended as canonical,
 } from 'eslint-config-canonical/canonical';
-import {
-  recommended as canonicalJsdoc,
-} from 'eslint-config-canonical/jsdoc';
+// import {
+//   recommended as canonicalJsdoc,
+// } from 'eslint-config-canonical/jsdoc';
 import globals from 'globals';
 
 const common = {
@@ -18,7 +18,10 @@ const common = {
 
 export default [
   ...canonical,
-  ...canonicalJsdoc,
+  // ...canonicalJsdoc,
+  jsdoc({
+    config: 'flat/recommended',
+  }),
   ...jsdoc({
     config: 'examples-and-default-expressions',
   }),
@@ -43,6 +46,9 @@ export default [
       'filenames/match-regex': 0,
       'import/extensions': 0,
       'import/no-useless-path-segments': 0,
+      'jsdoc/require-param-description': 0,
+      'jsdoc/require-returns': 0,
+      'jsdoc/require-returns-description': 0,
       'linebreak-style': 0,
       'no-inline-comments': 0,
       'prefer-named-capture-group': 0,

package.json

@@ -5,13 +5,14 @@
     "url": "http://gajus.com"
   },
   "dependencies": {
-    "@es-joy/jsdoccomment": "~0.58.0",
+    "@es-joy/jsdoccomment": "~0.60.0",
     "are-docs-informative": "^0.0.2",
     "comment-parser": "1.4.1",
     "debug": "^4.4.3",
     "escape-string-regexp": "^4.0.0",
     "espree": "^10.4.0",
     "esquery": "^1.6.0",
+    "html-entities": "^2.6.0",
     "object-deep-merge": "^1.0.5",
     "parse-imports-exports": "^0.2.4",
     "semver": "^7.7.2",
@@ -28,7 +29,7 @@
     "@babel/preset-env": "^7.28.3",
     "@es-joy/escodegen": "^3.5.1",
     "@es-joy/jsdoc-eslint-parser": "^0.23.0",
-    "@eslint/core": "^0.15.2",
+    "@eslint/core": "^0.16.0",
     "@hkdobrev/run-if-changed": "^0.6.3",
     "@semantic-release/commit-analyzer": "^13.0.1",
     "@semantic-release/github": "^11.0.6",
@@ -40,34 +41,34 @@
     "@types/estree": "^1.0.8",
     "@types/json-schema": "^7.0.15",
     "@types/mocha": "^10.0.10",
-    "@types/node": "^24.4.0",
+    "@types/node": "^24.5.2",
     "@types/semver": "^7.7.1",
     "@types/spdx-expression-parse": "^3.0.5",
-    "@typescript-eslint/types": "^8.43.0",
+    "@typescript-eslint/types": "^8.44.1",
     "babel-plugin-add-module-exports": "^1.0.4",
     "babel-plugin-istanbul": "^7.0.1",
     "babel-plugin-transform-import-meta": "^2.3.3",
     "c8": "^10.1.3",
     "camelcase": "^8.0.0",
     "chai": "^6.0.1",
     "decamelize": "^6.0.1",
-    "eslint": "9.35.0",
-    "eslint-config-canonical": "~45.0.0",
+    "eslint": "9.36.0",
+    "eslint-config-canonical": "^45.0.0",
     "gitdown": "^4.1.1",
     "glob": "^11.0.3",
     "globals": "^16.4.0",
     "husky": "^9.1.7",
     "jsdoc-type-pratt-parser": "^5.4.0",
     "json-schema": "^0.4.0",
     "json-schema-to-typescript": "^15.0.4",
-    "lint-staged": "^16.1.6",
+    "lint-staged": "^16.2.0",
     "mocha": "^11.7.2",
     "open-editor": "^5.1.0",
     "replace": "^1.2.2",
     "rimraf": "^6.0.1",
-    "semantic-release": "^24.2.8",
+    "semantic-release": "^24.2.9",
     "typescript": "5.9.2",
-    "typescript-eslint": "^8.43.0"
+    "typescript-eslint": "^8.44.1"
   },
   "engines": {
     "node": ">=20.11.0"
@@ -150,7 +151,12 @@
     "url": "https://github.com/gajus/eslint-plugin-jsdoc/issues"
   },
   "run-if-changed": {
-    "package-lock.json": "pnpm run install-offline"
+    "pnpm-lock.yaml": "pnpm run install-offline"
+  },
+  "pnpm": {
+    "overrides": {
+      "@types/eslint": "0.0.0-interferes-with-eslint-now"
+    }
   },
   "scripts": {
     "ruleTypes": "node ./src/bin/generateRuleTypes.js",
@@ -163,7 +169,7 @@
     "create-docs": "pnpm run create-options && node ./src/bin/generateDocs.js && pnpm ruleTypes",
     "create-rule": "node ./src/bin/generateRule.js",
     "create-options": "node ./src/bin/generateOptions.js",
-    "install-offline": "pnpm install --prefer-offline --no-audit",
+    "install-offline": "pnpm install --prefer-offline",
     "lint": "eslint",
     "lint-fix": "eslint --fix",
     "prepare": "husky",