Lint all type-containing tags. Fixes #380 (#477)

Author: tmcw

lib/lint.js

@@ -48,7 +48,7 @@ function lintComments(comment) {
       }
     }
 
-    if (tag.title === 'param' && tag.type) {
+    if (tag.type && typeof tag.type === 'object') {
       checkCanonical(tag.type);
     }
   });

test/fixture/_multi-file-input.json

@@ -303,7 +303,7 @@
         "lineNumber": 2,
         "type": {
           "type": "NameExpression",
-          "name": "Number"
+          "name": "number"
         }
       }
     ],
@@ -328,7 +328,7 @@
           "column": 2
         }
       },
-      "code": "/**\n * This function returns the number one.\n * @returns {Number} numberone\n */\nmodule.exports = function () {\n  // this returns 1\n  return 1;\n};\n"
+      "code": "/**\n * This function returns the number one.\n * @returns {number} numberone\n */\nmodule.exports = function () {\n  // this returns 1\n  return 1;\n};\n"
     },
     "errors": [],
     "returns": [
@@ -387,7 +387,7 @@
         },
         "type": {
           "type": "NameExpression",
-          "name": "Number"
+          "name": "number"
         }
       }
     ],

test/fixture/lint/lint.input.js

@@ -3,10 +3,13 @@
  * @param {Array<Number>} foo bar
  * @param {Array<Number>} foo bar
  * @param {Array|Number} foo bar
+ * @returns {object} bad object return type
+ * @type {Array<object>} bad object type
  * @memberof notfound
  */
 
 /**
  * @param {String} baz bar
+ * @property {String} bad property
  * @private
  */

test/fixture/lint/lint.output.js

@@ -2,8 +2,11 @@
         3:1  warning  type Number found, number is standard
         4:1  warning  type Number found, number is standard
         5:1  warning  type Number found, number is standard
-        6:1  warning  @memberof reference to notfound not found
-        9:1  warning  could not determine @name for hierarchy
-       10:1  warning  type String found, string is standard
+        6:1  warning  type object found, Object is standard
+        7:1  warning  type object found, Object is standard
+        8:1  warning  @memberof reference to notfound not found
+       11:1  warning  could not determine @name for hierarchy
+       12:1  warning  type String found, string is standard
+       13:1  warning  type String found, string is standard
 
-⚠ 8 warnings
+⚠ 11 warnings

test/fixture/simple.input.js

@@ -1,6 +1,6 @@
 /**
  * This function returns the number one.
- * @returns {Number} numberone
+ * @returns {number} numberone
  */
 module.exports = function () {
   // this returns 1

test/fixture/simple.output.github.json

@@ -59,7 +59,7 @@
         "lineNumber": 2,
         "type": {
           "type": "NameExpression",
-          "name": "Number"
+          "name": "number"
         }
       }
     ],
@@ -84,7 +84,7 @@
           "column": 2
         }
       },
-      "code": "/**\n * This function returns the number one.\n * @returns {Number} numberone\n */\nmodule.exports = function () {\n  // this returns 1\n  return 1;\n};\n",
+      "code": "/**\n * This function returns the number one.\n * @returns {number} numberone\n */\nmodule.exports = function () {\n  // this returns 1\n  return 1;\n};\n",
       "github": "[github]",
       "path": "test/fixture/simple.input.js"
     },
@@ -145,7 +145,7 @@
         },
         "type": {
           "type": "NameExpression",
-          "name": "Number"
+          "name": "number"
         }
       }
     ],

test/fixture/simple.output.github.md

@@ -4,4 +4,4 @@
 
 This function returns the number one.
 
-Returns **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** numberone
+Returns **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** numberone

test/fixture/simple.output.json

@@ -59,7 +59,7 @@
         "lineNumber": 2,
         "type": {
           "type": "NameExpression",
-          "name": "Number"
+          "name": "number"
         }
       }
     ],
@@ -84,7 +84,7 @@
           "column": 2
         }
       },
-      "code": "/**\n * This function returns the number one.\n * @returns {Number} numberone\n */\nmodule.exports = function () {\n  // this returns 1\n  return 1;\n};\n"
+      "code": "/**\n * This function returns the number one.\n * @returns {number} numberone\n */\nmodule.exports = function () {\n  // this returns 1\n  return 1;\n};\n"
     },
     "errors": [],
     "returns": [
@@ -143,7 +143,7 @@
         },
         "type": {
           "type": "NameExpression",
-          "name": "Number"
+          "name": "number"
         }
       }
     ],

test/fixture/simple.output.md

@@ -2,4 +2,4 @@
 
 This function returns the number one.
 
-Returns **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** numberone
+Returns **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** numberone

test/fixture/simple.output.md.json

@@ -63,7 +63,7 @@
               "children": [
                 {
                   "type": "text",
-                  "value": "Number"
+                  "value": "number"
                 }
               ]
             }