Merge pull request #3 from documentationjs/output-default

Include default values in output

Author: tmcw

index.js

@@ -120,7 +120,8 @@ function formatType(node, getNamedLink) {
     // lets the expression be omitted.
     return decorate(formatType(node.expression, getNamedLink), '...', true);
   case Syntax.OptionalType:
-    return decorate(formatType(node.expression, getNamedLink), '=');
+    return decorate(formatType(node.expression, getNamedLink), '=').concat(
+        node.default ? t('(default ' + node.default + ')') : []);
   case Syntax.NonNullableType:
     return decorate(formatType(node.expression, getNamedLink), '!', node.prefix);
   case Syntax.NullableType:

test/format_type.js

@@ -3,7 +3,7 @@
 
 var formatType = require('../index').formatType,
   mdast = require('mdast'),
-  parseParamType = require('doctrine/lib/typed').parseParamType,
+  parse = require('doctrine').parse,
   test = require('tap').test;
 
 test('formatType', function (t) {
@@ -34,10 +34,17 @@ test('formatType', function (t) {
   ].forEach(function (example) {
     t.deepEqual(mdast().stringify({
       type: 'paragraph',
-      children: formatType(parseParamType(example[0]))
+      children: formatType(
+          parse('@param {' + example[0] + '} a', { sloppy: true }).tags[0].type)
     }), example[1], example[0]);
   });
 
+  t.deepEqual(mdast().stringify({
+    type: 'paragraph',
+    children: formatType(
+        parse('@param {number} [a=1]', { sloppy: true }).tags[0].type)
+  }), '[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)=', 'default');
+
   t.deepEqual(formatType(), [], 'empty case');
 
   t.throws(function () {