fix(check-tag-names): ensure that the fenced block content of @example tags are not treated as jsdoc tags; fixes #395

Avoids decorators being treated as jsdoc tags

Author: brettz9

README.md

@@ -2125,6 +2125,21 @@ function quux () {
 
 }
 // Settings: {"jsdoc":{"tagNamePreference":{"augments":{"message":"@extends is to be used over @augments.","replacement":"extends"}}}}
+
+/**
+ * Registers the `target` class as a transient dependency; each time the dependency is resolved a new instance will be created.
+ *
+ * @param target - The class / constructor function to register as transient.
+ *
+ * @example ```ts
+@transient()
+class Foo { }
+```
+ * @param Time for a new tag
+ */
+export function transient<T>(target?: T): T {
+  // ...
+}
 ````
 
 

package.json

@@ -5,7 +5,7 @@
     "url": "http://gajus.com"
   },
   "dependencies": {
-    "comment-parser": "^0.6.2",
+    "comment-parser": "^0.7.0",
     "debug": "^4.1.1",
     "jsdoctypeparser": "^5.1.1",
     "lodash": "^4.17.15",

test/rules/assertions/checkTagNames.js

@@ -591,5 +591,27 @@ export default {
         },
       },
     },
+    {
+      code: `
+      /**
+       * Registers the \`target\` class as a transient dependency; each time the dependency is resolved a new instance will be created.
+       *
+       * @param target - The class / constructor function to register as transient.
+       *
+       * @example \`\`\`ts
+      @transient()
+      class Foo { }
+      \`\`\`
+       * @param Time for a new tag
+       */
+      export function transient<T>(target?: T): T {
+        // ...
+      }
+`,
+      parser: require.resolve('@typescript-eslint/parser'),
+      parserOptions: {
+        sourceType: 'module',
+      },
+    },
   ],
 };