Checking and marking types from inline links

Author: kraenhansen

docs/rules/no-undefined-types.md

@@ -745,5 +745,29 @@ function quux(foo, bar) {
 
 }
 // "jsdoc/no-undefined-types": ["error"|"warn", {"disableReporting":true}]
+
+class MyClass {}
+class AnotherClass {}
+
+/**
+ * A description mentioning {@link MyClass} and {@link AnotherClass | another class} and a URL via [this link]{@link https://www.example.com}.
+ */
+function quux(foo) {
+  console.log(foo);
+}
+
+quux(0);
+
+class MyClass {}
+class AnotherClass {}
+
+/**
+ * @see A tag mentioning {@link MyClass} and {@link AnotherClass | another class} and a URL via [this link]{@link https://www.example.com}.
+ */
+function quux(foo) {
+  console.log(foo);
+}
+
+quux(0);
 ````
 

src/getDefaultTagStructureForMode.js

@@ -35,8 +35,6 @@ const getDefaultTagStructureForMode = (mode) => {
   //   "namepath" (e.g., param can't define a namepath)
 
   // Once checking inline tags:
-  // Todo: Re: `typeOrNameRequired`, `@link` (or @linkcode/@linkplain) seems
-  //  to require a namepath OR URL and might be checked as such.
   // Todo: Should support a `tutorialID` type (for `@tutorial` block and
   //  inline)
 
@@ -461,6 +459,65 @@ const getDefaultTagStructureForMode = (mode) => {
       ]),
     ],
 
+    [
+      'link', new Map([
+        // Signature seems to require a namepath OR URL and might be checked as such.
+        [
+          'nameContents', 'namepath-referencing',
+        ],
+
+        // "namepath"
+        [
+          'typeOrNameRequired', true,
+        ],
+
+        // "type"
+        [
+          'typeAllowed', true,
+        ],
+      ]),
+    ],
+
+    [
+      'linkcode', new Map([
+        // Synonym for "link"
+        // Signature seems to require a namepath OR URL and might be checked as such.
+        [
+          'nameContents', 'namepath-referencing',
+        ],
+
+        // "namepath"
+        [
+          'typeOrNameRequired', true,
+        ],
+
+        // "type"
+        [
+          'typeAllowed', true,
+        ],
+      ]),
+    ],
+
+    [
+      'linkplain', new Map([
+        // Synonym for "link"
+        // Signature seems to require a namepath OR URL and might be checked as such.
+        [
+          'nameContents', 'namepath-referencing',
+        ],
+
+        // "namepath"
+        [
+          'typeOrNameRequired', true,
+        ],
+
+        // "type"
+        [
+          'typeAllowed', true,
+        ],
+      ]),
+    ],
+
     [
       'listens', new Map([
         // Signature seems to require a "name" (of an event) and no

src/iterateJsdoc.js

@@ -869,7 +869,7 @@ const getUtils = (
   };
 
   utils.filterTags = (filter) => {
-    return jsdocUtils.filterTags(jsdoc.tags, filter);
+    return jsdocUtils.filterTags(jsdocUtils.getAllTags(jsdoc), filter);
   };
 
   utils.getTagsByType = (tags) => {

src/jsdocUtils.js

@@ -452,6 +452,22 @@ const hasTag = (jsdoc, targetTagName) => {
   });
 };
 
+/**
+ * Get all tags, inline tags and inline tags in tags
+ *
+ * @param {object} jsdoc
+ * @returns {Array}
+ */
+const getAllTags = (jsdoc) => {
+  return [
+    ...jsdoc.tags,
+    ...jsdoc.inlineTags,
+    ...jsdoc.tags.flatMap((tag) => {
+      return tag.inlineTags;
+    }),
+  ];
+};
+
 /**
  * @param {object} jsdoc
  * @param {Array} targetTagNames
@@ -1232,6 +1248,7 @@ export default {
   exemptSpeciaMethods,
   filterTags,
   flattenRoots,
+  getAllTags,
   getContextObject,
   getFunctionParameterNames,
   getIndent,

src/rules/noUndefinedTypes.js

@@ -193,10 +193,12 @@ export default iterateJsdoc(({
   });
 
   for (const tag of jsdocTagsWithPossibleType) {
+    const possibleType = tag.type || tag.namepathOrURL;
+
     let parsedType;
 
     try {
-      parsedType = mode === 'permissive' ? tryParseType(tag.type) : parseType(tag.type, mode);
+      parsedType = mode === 'permissive' ? tryParseType(possibleType) : parseType(possibleType, mode);
     } catch {
       // On syntax error, will be handled by valid-types.
       continue;

test/rules/assertions/noUndefinedTypes.js

@@ -1324,5 +1324,41 @@ export default {
         sourceType: 'module',
       },
     },
+    {
+      code: `
+          class MyClass {}
+          class AnotherClass {}
+
+          /**
+           * A description mentioning {@link MyClass} and {@link AnotherClass | another class} and a URL via [this link]{@link https://www.example.com}.
+           */
+          function quux(foo) {
+            console.log(foo);
+          }
+
+          quux(0);
+      `,
+      rules: {
+        'no-unused-vars': 'error',
+      },
+    },
+    {
+      code: `
+          class MyClass {}
+          class AnotherClass {}
+
+          /**
+           * @see A tag mentioning {@link MyClass} and {@link AnotherClass | another class} and a URL via [this link]{@link https://www.example.com}.
+           */
+          function quux(foo) {
+            console.log(foo);
+          }
+
+          quux(0);
+      `,
+      rules: {
+        'no-unused-vars': 'error',
+      },
+    },
   ],
 };