fix: correct error message of check-types (fixes #103)

Fix: correct error message of `check-types` (fixes #103)
gajus · Mar 14, 2019 · 897f205 · 897f205
2 parents 2619665 + 6c172eb
commit 897f205
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -983,6 +983,15 @@ function quux (foo) {
 }
 // Message: Invalid JSDoc @arg "foo" type "Number".
 
+/**
+ * @returns {Number} foo
+ * @throws {Number} foo
+ */
+function quux () {
+
+}
+// Message: Invalid JSDoc @returns type "Number".
+
 /**
  * @param {(Number|string|Boolean)=} foo
  */

diff --git a/src/iterateJsdoc.js b/src/iterateJsdoc.js
@@ -10,7 +10,7 @@ const parseComment = (commentNode, indent) => {
       commentParser.PARSERS.parse_tag,
       commentParser.PARSERS.parse_type,
       (str, data) => {
-        if (_.includes(['return', 'returns'], data.tag)) {
+        if (_.includes(['return', 'returns', 'throws', 'exception'], data.tag)) {
           return null;
         }
 

diff --git a/src/rules/checkTypes.js b/src/rules/checkTypes.js
@@ -80,7 +80,9 @@ export default iterateJsdoc(({
           return fixer.replaceText(jsdocNode, sourceCode.getText(jsdocNode).replace('{' + jsdocTag.type + '}', '{' + fixedType + '}'));
         };
 
-        report('Invalid JSDoc @' + jsdocTag.tag + ' "' + jsdocTag.name + '" type "' + invalidType + '".', fix, jsdocTag);
+        const name = jsdocTag.name ? ' "' + jsdocTag.name + '"' : '';
+
+        report('Invalid JSDoc @' + jsdocTag.tag + name + ' type "' + invalidType + '".', fix, jsdocTag);
       });
     }
   });

diff --git a/test/rules/assertions/checkTypes.js b/test/rules/assertions/checkTypes.js
@@ -48,6 +48,27 @@ export default {
           }
       `
     },
+    {
+      code: `
+          /**
+           * @returns {Number} foo
+           * @throws {Number} foo
+           */
+          function quux () {
+
+          }
+      `,
+      errors: [
+        {
+          line: 3,
+          message: 'Invalid JSDoc @returns type "Number".'
+        },
+        {
+          line: 4,
+          message: 'Invalid JSDoc @throws type "Number".'
+        }
+      ]
+    },
     {
       code: `
           /**