Add return type inference as well

Author: tmcw

index.js

@@ -14,6 +14,7 @@ var sort = require('./lib/sort'),
   inferKind = require('./lib/infer/kind'),
   inferParams = require('./lib/infer/params'),
   inferMembership = require('./lib/infer/membership'),
+  inferReturn = require('./lib/infer/return'),
   lint = require('./lib/lint');
 
 /**
@@ -62,10 +63,11 @@ module.exports = function (indexes, options, callback) {
           // compose nesting & membership to avoid intermediate arrays
           comment = nestParams(
             inferMembership(
-              inferParams(
-                inferKind(
-                  inferName(
-                    lint(comment))))));
+              inferReturn(
+                inferParams(
+                  inferKind(
+                    inferName(
+                      lint(comment)))))));
           if (options.github) {
             comment = github(comment);
           }

lib/infer/return.js

@@ -0,0 +1,31 @@
+'use strict';
+
+var types = require('ast-types'),
+  flowDoctrine = require('../flow_doctrine');
+
+/**
+ * Infers returns tags by using Flow return type annotations
+ *
+ * @name inferReturn
+ * @param {Object} comment parsed comment
+ * @returns {Object} comment with return tag inferred
+ */
+module.exports = function inferReturn(comment) {
+
+  types.visit(comment.context.ast, {
+    visitFunction: function (path) {
+
+      if (!comment.returns &&
+        path.value.returnType &&
+        path.value.returnType.typeAnnotation) {
+        comment.returns = [{
+          type: flowDoctrine(path.value.returnType.typeAnnotation)
+        }];
+      }
+
+      this.abort();
+    }
+  });
+
+  return comment;
+};

test/fixture/flow-types.input.js

@@ -3,7 +3,7 @@
 /**
  * This function returns the number one.
  */
-function addThem(a: number, b: string, c: ?boolean, d: Array<number>, e: Object, f: Named) {
+function addThem(a: number, b: string, c: ?boolean, d: Array<number>, e: Object, f: Named): number {
   return a + b + c + d + e;
 };
 

test/fixture/flow-types.output.custom.md

@@ -19,3 +19,7 @@ This function returns the number one.
 
 
 
+Returns **number** 
+
+
+

test/fixture/flow-types.output.json

@@ -23,7 +23,7 @@
           "column": 1
         }
       },
-      "code": "/* eslint-disable */\n\n/**\n * This function returns the number one.\n */\nfunction addThem(a: number, b: string, c: ?boolean, d: Array<number>, e: Object, f: Named) {\n  return a + b + c + d + e;\n};\n\n/* eslint-enable */\n"
+      "code": "/* eslint-disable */\n\n/**\n * This function returns the number one.\n */\nfunction addThem(a: number, b: string, c: ?boolean, d: Array<number>, e: Object, f: Named): number {\n  return a + b + c + d + e;\n};\n\n/* eslint-enable */\n"
     },
     "errors": [],
     "name": "addThem",
@@ -96,6 +96,14 @@
         }
       }
     ],
+    "returns": [
+      {
+        "type": {
+          "type": "NameExpression",
+          "name": "number"
+        }
+      }
+    ],
     "members": {
       "instance": [],
       "static": []

test/fixture/flow-types.output.md

@@ -19,3 +19,7 @@ This function returns the number one.
 
 
 
+Returns **number** 
+
+
+

test/fixture/flow-types.output.md.json

@@ -349,6 +349,47 @@
               ]
             }
           ]
+        },
+        {
+          "type": "root",
+          "children": [
+            {
+              "type": "paragraph",
+              "children": [
+                {
+                  "type": "text",
+                  "value": "Returns "
+                },
+                {
+                  "type": "strong",
+                  "children": [
+                    {
+                      "type": "text",
+                      "value": "number"
+                    }
+                  ]
+                },
+                {
+                  "type": "text",
+                  "value": " "
+                },
+                {
+                  "type": "root",
+                  "children": [],
+                  "position": {
+                    "start": {
+                      "line": 1,
+                      "column": 1
+                    },
+                    "end": {
+                      "line": 1,
+                      "column": 1
+                    }
+                  }
+                }
+              ]
+            }
+          ]
         }
       ]
     }