fixes #7 add support of null and undefined return types

Alexej Yaroshevich · Alexej Yaroshevich · commit f709d6ce0b9f · 2014-05-27T08:30:20.000+04:00
diff --git a/lib/jsdoc-helpers.js b/lib/jsdoc-helpers.js
@@ -67,6 +67,14 @@ function jsDocSimplifyNode (node) {
         result.nullable = (node.type === 'NullableType');
         return result;
 
+    case 'NullLiteral':
+        result = {type: 'null'};
+        break;
+
+    case 'UndefinedLiteral':
+        result = {type: 'undefined'};
+        break;
+
     case 'UnionType':
         result = [];
         for (var i = 0, l = node.elements.length; i < l; i += 1) {
@@ -116,10 +124,20 @@ function jsDocMatchType (variants, argument) {
     var i, l, variant, type;
 
     for (i = 0, l = variants.length; i < l; i += 1) {
-        variant = variants[i];
+        variant = variants[i][0] || variants[i];
+        if (variant.unknown || !variant.type) {
+            continue;
+        }
+
         type = variant.type.toLowerCase();
 
         if (argument.type === 'Literal') {
+            if (argument.value === null) {
+                return type === 'null';
+            }
+            if (argument.value === undefined) {
+                return type === 'undefined';
+            }
             if (typeof argument.value !== 'object') {
                 return type === typeof argument.value;
             }
diff --git a/package.json b/package.json
@@ -2,7 +2,7 @@
   "name": "jscs-jsdoc",
   "author": "Alexej Yaroshevich <alex@qfox.ru>",
   "description": "JSCS jsdoc plugin",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "main": "lib/index",
   "homepage": "https://github.com/zxqfox/jscs-jsdoc",
   "license": "MIT",
diff --git a/test/test.validate-jsdoc-returns.js b/test/test.validate-jsdoc-returns.js
@@ -229,4 +229,75 @@ describe('rules/validate-jsdoc', function () {
 
     });
 
+    describe('bugfixes', function () {
+
+        it('should not throw exception on `@returns {null|undefined}` directive. issue #7', function () {
+
+            checker.configure({ jsDoc: { requireReturnTypes: true, checkReturnTypes: true } });
+            assert(
+                checker.checkString(
+                    '/**\n' +
+                    ' * @return {null}\n' +
+                    ' */\n' +
+                    'function funcName() {\n' +
+                        'return null;\n' +
+                    '}\n' +
+                    '/**\n' +
+                    ' * @return {undefined}\n' +
+                    ' */\n' +
+                    'function funcName() {\n' +
+                        'return undefined;\n' +
+                    '}\n' +
+                    '/**\n' +
+                    ' * @return {null|undefined}\n' +
+                    ' */\n' +
+                    'function funcName(flag) {\n' +
+                    '  if (flag) {\n' +
+                    '    return null;\n' +
+                    '  }\n' +
+                    '  return undefined;\n' +
+                    '}\n'
+                ).isEmpty()
+            );
+
+        });
+
+        it('should report on `@returns {null|undefined}` vs (string|number|regexp). issue #7', function () {
+            checker.configure({ jsDoc: { requireReturnTypes: true, checkReturnTypes: true } });
+            assert(
+                checker.checkString(
+                    '/**\n' +
+                    ' * @return {null|undefined}\n' +
+                    ' */\n' +
+                    'function funcName(flag) {\n' +
+                    '  if (flag) {\n' +
+                    '    return /qwe/i;\n' +
+                    '  } else {\n' +
+                    '    return 2;\n' +
+                    '  }\n' +
+                    '  return "";\n' +
+                    '}\n'
+                ).getErrorCount() === 3
+            );
+        });
+
+        it('should report on `@returns {null|undefined}` vs (array|object). issue #7', function () {
+            checker.configure({ jsDoc: { requireReturnTypes: true, checkReturnTypes: true } });
+            assert(
+                checker.checkString(
+                    '/**\n' +
+                    ' * @return {null|undefined}\n' +
+                    ' */\n' +
+                    'function funcName(flag) {\n' +
+                    '  if (flag) {\n' +
+                    '    return [];\n' +
+                    '  }\n' +
+                    '  return {q: 1};\n' +
+                    '}\n'
+                ).getErrorCount() === 2
+            );
+        });
+
+    });
+
 });
