Add the type property to typedef comments (#517)

* Add the type property to typedef comments

When using Flow type aliases we didn't add the `type` property
to the JSDoc comment for the inferred `typedef`.

Fixes #516

* Rename files and update test expectations

Author: arv

index.js

@@ -20,6 +20,7 @@ var fs = require('fs'),
   inferMembership = require('./lib/infer/membership'),
   inferReturn = require('./lib/infer/return'),
   inferAccess = require('./lib/infer/access'),
+  inferTypedefType = require('./lib/infer/typedef_type'),
   formatLint = require('./lib/lint').formatLint,
   garbageCollect = require('./lib/garbage_collect'),
   lintComments = require('./lib/lint').lintComments,
@@ -169,6 +170,7 @@ function buildSync(indexes, options) {
     inferProperties(),
     inferReturn(),
     inferMembership(),
+    inferTypedefType(),
     nest,
     options.github && github,
     garbageCollect);
@@ -238,6 +240,7 @@ function lint(indexes, options, callback) {
     inferProperties(),
     inferReturn(),
     inferMembership(),
+    inferTypedefType(),
     nest);
 
   return expandInputs(indexes, options, function (error, inputs) {

lib/infer/typedef_type.js

@@ -0,0 +1,27 @@
+'use strict';
+
+var shouldSkipInference = require('./should_skip_inference'),
+  flowDoctrine = require('../flow_doctrine'),
+  finders = require('./finders');
+
+/**
+ * Infers the type of typedefs defined by Flow type aliases
+ *
+ * @name inferTypedefType
+ * @param {Object} comment parsed comment
+ * @returns {Object} comment with type tag inferred
+ */
+module.exports = function () {
+  return shouldSkipInference(function inferTypedefType(comment) {
+    if (comment.kind !== 'typedef') {
+      return comment;
+    }
+
+    var flowAlias = finders.findTarget(comment.context.ast);
+    if (flowAlias && flowAlias.type === 'TypeAlias') {
+      comment.type = flowDoctrine(flowAlias.right);
+    }
+
+    return comment;
+  });
+};

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

@@ -378,6 +378,10 @@
     ],
     "name": "Point",
     "kind": "typedef",
+    "type": {
+      "type": "NameExpression",
+      "name": "Object"
+    },
     "members": {
       "instance": [],
       "static": []
@@ -501,6 +505,10 @@
         }
       }
     ],
+    "type": {
+      "type": "NameExpression",
+      "name": "Object"
+    },
     "members": {
       "instance": [],
       "static": []
@@ -592,6 +600,19 @@
     "errors": [],
     "name": "T",
     "kind": "typedef",
+    "type": {
+      "type": "TypeApplication",
+      "expression": {
+        "type": "NameExpression",
+        "name": "Array"
+      },
+      "applications": [
+        {
+          "type": "NameExpression",
+          "name": "string"
+        }
+      ]
+    },
     "members": {
       "instance": [],
       "static": []

test/lib/infer/typedef_type.js

@@ -0,0 +1,69 @@
+'use strict';
+
+var test = require('tap').test,
+  parse = require('../../../lib/parsers/javascript'),
+  inferKind = require('../../../lib/infer/kind')(),
+  inferTypedefType = require('../../../lib/infer/typedef_type')();
+
+function toComment(code) {
+  return parse({
+    source: code
+  })[0];
+}
+
+function evaluate(code) {
+  return inferTypedefType(inferKind(toComment(code)));
+}
+
+test('inferTypedefType', function (t) {
+  t.deepEqual(evaluate(
+    '/** @typedef {T} V */'
+  ).type, {
+    name: 'T',
+    type: 'NameExpression'
+  });
+
+  t.deepEqual(evaluate(
+    '/** */' +
+    'type V = T'
+  ).type, {
+    name: 'T',
+    type: 'NameExpression'
+  });
+
+  t.deepEqual(evaluate(
+    '/** @typedef {Array<T>} V */'
+  ).type, {
+    applications: [
+      {
+        name: 'T',
+        type: 'NameExpression'
+      }
+    ],
+    expression: {
+      name: 'Array',
+      type: 'NameExpression'
+    },
+    type: 'TypeApplication'
+  });
+
+  t.deepEqual(evaluate(
+    '/** */' +
+    'type V = Array<T>'
+  ).type, {
+    applications: [
+      {
+        name: 'T',
+        type: 'NameExpression'
+      }
+    ],
+    expression: {
+      name: 'Array',
+      type: 'NameExpression'
+    },
+    type: 'TypeApplication'
+  });
+
+
+  t.end();
+});