fix(no-undefined-types): ensure working in all contexts; fixes #324

gajus · Jul 13, 2019 · a1c9824 · a1c9824
1 parent e9145c4
commit a1c9824
Show file tree

Hide file tree

Showing 4 changed files with 39 additions and 2 deletions.
diff --git a/src/iterateJsdoc.js b/src/iterateJsdoc.js
@@ -206,7 +206,11 @@ const getUtils = (
   };
 
   utils.getClassNode = () => {
-    const greatGrandParent = ancestors.slice(-3)[0];
+    // Ancestors missing in `Program` comment iteration
+    const greatGrandParent = ancestors.length ?
+      ancestors.slice(-3)[0] :
+      jsdocUtils.getAncestor(sourceCode, jsdocNode, 3);
+
     const greatGrandParentValue = greatGrandParent && sourceCode.getFirstToken(greatGrandParent).value;
 
     if (greatGrandParentValue === 'class') {
@@ -350,7 +354,7 @@ const iterateAllJsdocs = (iterator, ruleConfig) => {
   return {
     create (context) {
       return {
-        'Program:exit' () {
+        'Program' () {
           const sourceCode = context.getSourceCode();
           const comments = sourceCode.getAllComments();
 

diff --git a/src/jsdocUtils.js b/src/jsdocUtils.js
@@ -545,9 +545,22 @@ const getTagsByType = (tags, tagPreference) => {
   };
 };
 
+const getAncestor = (sourceCode, nde, depth, idx = 0) => {
+  if (idx === depth) {
+    return nde;
+  }
+  const prevToken = sourceCode.getTokenBefore(nde);
+  if (prevToken) {
+    return getAncestor(sourceCode, prevToken, depth, idx + 1);
+  }
+
+  return null;
+};
+
 export default {
   enforcedContexts,
   filterTags,
+  getAncestor,
   getContextObject,
   getFunctionParameterNames,
   getJsdocParameterNames,

diff --git a/src/rules/noUndefinedTypes.js b/src/rules/noUndefinedTypes.js
@@ -132,6 +132,7 @@ export default iterateJsdoc(({
     });
   });
 }, {
+  iterateAllJsdocs: true,
   meta: {
     schema: [
       {

diff --git a/test/rules/assertions/noUndefinedTypes.js b/test/rules/assertions/noUndefinedTypes.js
@@ -208,6 +208,25 @@ export default {
           message: 'The type \'TEMPLATE_TYPE\' is undefined.'
         }
       ]
+    },
+    {
+      code: `
+          /**
+           * @type {strnig}
+           */
+          var quux = {
+
+          };
+      `,
+      errors: [
+        {
+          line: 3,
+          message: 'The type \'strnig\' is undefined.'
+        }
+      ],
+      rules: {
+        'no-undef': 'error'
+      }
     }
   ],
   valid: [