Fix: valid-jsdoc correctly checks type union (fixes #5260)

Correctly checks type union when it is a property of type application
eslint · Mar 14, 2016 · cfc14a9 · cfc14a9
1 parent 2c320da
commit cfc14a9
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 1 deletion.
diff --git a/lib/rules/valid-jsdoc.js b/lib/rules/valid-jsdoc.js
@@ -137,7 +137,7 @@ module.exports = function(context) {
         var elements = [];
 
         if (tag.type.type === "TypeApplication") { // {Array.<String>}
-            elements = tag.type.applications;
+            elements = tag.type.applications[0].type === "UnionType" ? tag.type.applications[0].elements : tag.type.applications;
             typesToCheck.push(getCurrentExpectedTypes(tag.type));
         } else if (tag.type.type === "RecordType") { // {{20:String}}
             elements = tag.type.fields;

diff --git a/tests/lib/rules/valid-jsdoc.js b/tests/lib/rules/valid-jsdoc.js
@@ -362,6 +362,34 @@ ruleTester.run("valid-jsdoc", rule, {
             options: [{
                 "requireReturn": false
             }]
+        },
+        {
+            code:
+            "/**\n" +
+            "* Foo\n" +
+            "* @param {Array.<string>} hi - desc\n" +
+            "* @returns {Array.<string|number>} desc\n" +
+            "*/\n" +
+            "function foo(hi){}",
+            options: [{
+                preferType: {
+                    "String": "string"
+                }
+            }]
+        },
+        {
+            code:
+            "/**\n" +
+            "* Foo\n" +
+            "* @param {Array.<string|number>} hi - desc\n" +
+            "* @returns {Array.<string>} desc\n" +
+            "*/\n" +
+            "function foo(hi){}",
+            options: [{
+                preferType: {
+                    "String": "string"
+                }
+            }]
         }
     ],