feat(valid-types): check link and tutorial for content; #233

gajus · Jun 28, 2023 · 42c713e · 42c713e
1 parent 4afc8e6
commit 42c713e
Show file tree

Hide file tree

Showing 4 changed files with 105 additions and 1 deletion.
diff --git a/docs/rules/valid-types.md b/docs/rules/valid-types.md
@@ -487,6 +487,21 @@ function quux (items) {
 }
 // Settings: {"jsdoc":{"mode":"typescript"}}
 // Message: Syntax error in type: JsdocTypeNullable
+
+/**
+ * An inline {@link} tag without content.
+ */
+// Message: Inline tag "link" missing content
+
+/**
+ * An inline {@tutorial} tag without content.
+ */
+// Message: Inline tag "tutorial" missing content
+
+/**
+ * @param {SomeType} aName An inline {@link} tag without content.
+ */
+// Message: Inline tag "link" missing content
 ````
 
 
@@ -850,5 +865,17 @@ function quux() {
 /**
  * @returns {Promise<{publicKey, privateKey}>} - The public and private key
  */
+
+/**
+ * Some other {@inline} tag.
+ */
+
+/**
+ * @param {SomeType} aName An inline {@link text} tag with content.
+ */
+
+/**
+ * An inline {@link text} tag with content.
+ */
 ````
 
diff --git a/src/jsdocUtils.js b/src/jsdocUtils.js
@@ -483,7 +483,7 @@ const hasParams = (functionNode) => {
 
 /**
  * Gets all names of the target type, including those that refer to a path, e.g.
- * "@param foo; @param foo.bar".
+ * `foo` or `foo.bar`.
  * @param {import('comment-parser').Block} jsdoc
  * @param {string} targetTagName
  * @returns {{

diff --git a/src/rules/validTypes.js b/src/rules/validTypes.js
@@ -5,6 +5,11 @@ import {
   tryParse,
 } from '@es-joy/jsdoccomment';
 
+const inlineTags = new Set([
+  'link', 'linkcode', 'linkplain',
+  'tutorial',
+]);
+
 const asExpression = /as\s+/u;
 
 const suppressTypes = new Set([
@@ -327,6 +332,18 @@ export default iterateJsdoc(({
         validNamepathParsing(tag.name, tag.tag);
       }
     }
+
+    for (const inlineTag of tag.inlineTags) {
+      if (inlineTags.has(inlineTag.tag) && !inlineTag.text && !inlineTag.namepathOrURL) {
+        report(`Inline tag "${inlineTag.tag}" missing content`, null, tag);
+      }
+    }
+  }
+
+  for (const inlineTag of jsdoc.inlineTags) {
+    if (inlineTags.has(inlineTag.tag) && !inlineTag.text && !inlineTag.namepathOrURL) {
+      report(`Inline tag "${inlineTag.tag}" missing content`);
+    }
   }
 }, {
   iterateAllJsdocs: true,

diff --git a/test/rules/assertions/validTypes.js b/test/rules/assertions/validTypes.js
@@ -1102,6 +1102,45 @@ export default {
         },
       },
     },
+    {
+      code: `
+      /**
+       * An inline {@link} tag without content.
+       */
+      `,
+      errors: [
+        {
+          line: 2,
+          message: 'Inline tag "link" missing content',
+        },
+      ],
+    },
+    {
+      code: `
+      /**
+       * An inline {@tutorial} tag without content.
+       */
+      `,
+      errors: [
+        {
+          line: 2,
+          message: 'Inline tag "tutorial" missing content',
+        },
+      ],
+    },
+    {
+      code: `
+      /**
+       * @param {SomeType} aName An inline {@link} tag without content.
+       */
+      `,
+      errors: [
+        {
+          line: 3,
+          message: 'Inline tag "link" missing content',
+        },
+      ],
+    },
   ],
   valid: [
     {
@@ -1790,5 +1829,26 @@ export default {
        */
       `,
     },
+    {
+      code: `
+      /**
+       * Some other {@inline} tag.
+       */
+      `,
+    },
+    {
+      code: `
+      /**
+       * @param {SomeType} aName An inline {@link text} tag with content.
+       */
+      `,
+    },
+    {
+      code: `
+      /**
+       * An inline {@link text} tag with content.
+       */
+      `,
+    },
   ],
 };