fix(valid-types): ensure when in closure mode, that this and `def…

…ine` tags have types
gajus · Dec 1, 2019 · b6e2699 · b6e2699
1 parent 7022f65
commit b6e2699
Show file tree

Hide file tree

Showing 4 changed files with 45 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -9058,6 +9058,13 @@ function quux () {}
 function quux () {}
 // Settings: {"jsdoc":{"mode":"closure"}}
 // Message: Syntax error in type: BadTypeChecked<
+
+/**
+ * @define
+ */
+ function quux () {}
+// Settings: {"jsdoc":{"mode":"closure"}}
+// Message: Tag @define must have a type
 ````
 
 The following patterns are not considered problems:
@@ -9227,6 +9234,11 @@ function quux () {}
  */
 function quux () {}
 // Settings: {"jsdoc":{"mode":"closure"}}
+
+/**
+ * @define
+ */
+ function quux () {}
 ````
 
 
diff --git a/src/iterateJsdoc.js b/src/iterateJsdoc.js
@@ -215,7 +215,7 @@ const getUtils = (
   };
 
   utils.tagMustHaveTypePosition = (tagName) => {
-    return jsdocUtils.tagMustHaveTypePosition(tagName);
+    return jsdocUtils.tagMustHaveTypePosition(mode, tagName);
   };
 
   utils.tagMightHaveTypePosition = (tagName) => {

diff --git a/src/jsdocUtils.js b/src/jsdocUtils.js
@@ -345,7 +345,11 @@ const tagMightHaveTypePosition = (mode, tag) => {
     tagsWithOptionalTypePosition.includes(tag);
 };
 
-const tagMustHaveTypePosition = (tag) => {
+const tagMustHaveTypePosition = (mode, tag) => {
+  if (mode === 'closure') {
+    return tagsWithMandatoryTypePositionClosure.includes(tag);
+  }
+
   return tagsWithMandatoryTypePosition.includes(tag);
 };
 

diff --git a/test/rules/assertions/validTypes.js b/test/rules/assertions/validTypes.js
@@ -304,6 +304,25 @@ export default {
         },
       },
     },
+    {
+      code: `
+          /**
+           * @define
+           */
+           function quux () {}
+      `,
+      errors: [
+        {
+          line: 3,
+          message: 'Tag @define must have a type',
+        },
+      ],
+      settings: {
+        jsdoc: {
+          mode: 'closure',
+        },
+      },
+    },
   ],
   valid: [
     {
@@ -566,5 +585,13 @@ export default {
         },
       },
     },
+    {
+      code: `
+          /**
+           * @define
+           */
+           function quux () {}
+      `,
+    },
   ],
 };