feat(require-hyphen-before-param-description): ensure template will…

… be properly stringified; fixes gajus#1326

Note that `match-name` will now have to take into account any optional brackets and default in `allowName`

docs/rules/match-name.md

@@ -251,6 +251,6 @@ class A {
  * @typedef {object} Test
  * @property {T} test
  */
-// "jsdoc/match-name": ["error"|"warn", {"match":[{"allowName":"/^[A-Z]{1}$/","message":"The name should be a single capital letter.","tags":["template"]}]}]
+// "jsdoc/match-name": ["error"|"warn", {"match":[{"allowName":"/^\\[?[A-Z]{1}(=.*\\])$/","message":"The name should be a single capital letter.","tags":["template"]}]}]
 ````
 

package.json

@@ -5,7 +5,7 @@
     "url": "http://gajus.com"
   },
   "dependencies": {
-    "@es-joy/jsdoccomment": "~0.48.0",
+    "@es-joy/jsdoccomment": "~0.49.0",
     "are-docs-informative": "^0.0.2",
     "comment-parser": "1.4.1",
     "debug": "^4.3.6",

test/rules/assertions/matchName.js

@@ -553,7 +553,7 @@ export default {
       `,
       options: [{
         match: [{
-          allowName: "/^[A-Z]{1}$/",
+          allowName: "/^\\[?[A-Z]{1}(=.*\\])$/",
           message: "The name should be a single capital letter.",
           tags: ["template"],
         }],

test/rules/assertions/requireHyphenBeforeParamDescription.js

@@ -473,6 +473,29 @@ export default {
         function test(input) {}
       `,
     },
+    {
+      code: `
+        /**
+         * @template [O=unknown]
+         * @param {string} name The name of the thing.
+         */
+        function test(name) {}
+      `,
+      errors: [
+        {
+          line: 4,
+          message: 'There must be a hyphen before @param description.',
+        },
+      ],
+      ignoreReadme: true,
+      output: `
+        /**
+         * @template [O=unknown]
+         * @param {string} name - The name of the thing.
+         */
+        function test(name) {}
+      `,
+    },
   ],
   valid: [
     {