feat: update @es-joy/jsdoccomment

Also: - test: demo use of `inlineTags`
brettz9 · May 5, 2023 · 40d5ee0 · 40d5ee0
1 parent aeaae4f
commit 40d5ee0
Show file tree

Hide file tree

Showing 5 changed files with 85 additions and 3 deletions.
diff --git a/docs/rules/no-restricted-syntax.md b/docs/rules/no-restricted-syntax.md
@@ -243,6 +243,24 @@ class Test {
 }
 // "jsdoc/no-restricted-syntax": ["error"|"warn", {"contexts":[{"comment":"JsdocBlock:not(*:has(JsdocTag[tag=/returns/]))","context":"TSEmptyBodyFunctionExpression[returnType.typeAnnotation.type!=/TSVoidKeyword|TSUndefinedKeyword/]","message":"methods with non-void return types must have a @returns tag"}]}]
 // Message: methods with non-void return types must have a @returns tag
+
+/**
+ * This has an inline {@link http://example.com}
+ */
+function quux () {
+
+}
+// "jsdoc/no-restricted-syntax": ["error"|"warn", {"contexts":[{"comment":"JsdocBlock:has(JsdocInlineTag)","context":"FunctionDeclaration"}]}]
+// Message: Syntax is restricted: FunctionDeclaration with JsdocBlock:has(JsdocInlineTag)
+
+/**
+ * @see This has an inline {@link http://example.com}
+ */
+function quux () {
+
+}
+// "jsdoc/no-restricted-syntax": ["error"|"warn", {"contexts":[{"comment":"JsdocBlock:has(JsdocTag:has(JsdocInlineTag[format=\"plain\"]))","context":"FunctionDeclaration"}]}]
+// Message: Syntax is restricted: FunctionDeclaration with JsdocBlock:has(JsdocTag:has(JsdocInlineTag[format="plain"]))
 ````
 
 

diff --git a/package.json b/package.json
@@ -5,7 +5,7 @@
     "url": "http://gajus.com"
   },
   "dependencies": {
-    "@es-joy/jsdoccomment": "~0.37.1",
+    "@es-joy/jsdoccomment": "~0.38.0",
     "are-docs-informative": "^0.0.2",
     "comment-parser": "1.3.1",
     "debug": "^4.3.4",

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/test/iterateJsdoc.js b/test/iterateJsdoc.js
@@ -122,6 +122,7 @@ describe('iterateJsdoc', () => {
         `,
         }, '')).to.deep.equal({
           description: 'SomeDescription',
+          inlineTags: [],
           problems: [],
           source: [
             {
@@ -147,6 +148,7 @@ describe('iterateJsdoc', () => {
           tags: [
             {
               description: '          desc',
+              inlineTags: [],
               name: 'name',
               optional: false,
               problems: [],

diff --git a/test/rules/assertions/noRestrictedSyntax.js b/test/rules/assertions/noRestrictedSyntax.js
@@ -652,6 +652,58 @@ export default {
       ],
       parser: require.resolve('@typescript-eslint/parser'),
     },
+    {
+      code: `
+      /**
+       * This has an inline {@link http://example.com}
+       */
+      function quux () {
+
+      }
+      `,
+      errors: [
+        {
+          line: 2,
+          message: 'Syntax is restricted: FunctionDeclaration with JsdocBlock:has(JsdocInlineTag)',
+        },
+      ],
+      options: [
+        {
+          contexts: [
+            {
+              comment: 'JsdocBlock:has(JsdocInlineTag)',
+              context: 'FunctionDeclaration',
+            },
+          ],
+        },
+      ],
+    },
+    {
+      code: `
+      /**
+       * @see This has an inline {@link http://example.com}
+       */
+      function quux () {
+
+      }
+      `,
+      errors: [
+        {
+          line: 2,
+          message: 'Syntax is restricted: FunctionDeclaration with JsdocBlock:has(JsdocTag:has(JsdocInlineTag[format="plain"]))',
+        },
+      ],
+      options: [
+        {
+          contexts: [
+            {
+              comment: 'JsdocBlock:has(JsdocTag:has(JsdocInlineTag[format="plain"]))',
+              context: 'FunctionDeclaration',
+            },
+          ],
+        },
+      ],
+    },
   ],
   valid: [
     {