start testing

Author: tmcw

package.json

@@ -4,7 +4,7 @@
   "description": "helpers for building themes with documentation.js",
   "main": "index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "tap --coverage test"
   },
   "keywords": [
     "documentation",
@@ -17,5 +17,9 @@
   "dependencies": {
     "doctrine": "^0.7.2",
     "globals-docs": "^2.1.0"
+  },
+  "devDependencies": {
+    "mdast": "^2.3.0",
+    "tap": "^2.3.1"
   }
 }

test/format_type.js

@@ -0,0 +1,48 @@
+/*eslint max-len: 0 */
+'use strict';
+
+var formatType = require('../index').formatType,
+  mdast = require('mdast'),
+  parseParamType = require('doctrine/lib/typed').parseParamType,
+  test = require('tap').test;
+
+test('formatType', function (t) {
+  [
+    ['Foo', 'Foo'],
+    ['null', 'null'],
+    ['null', 'null'],
+    ['*', 'Any'],
+    ['Array|undefined', '([Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)|[undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))'],
+    ['Array<number>', '[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array).&lt;[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)&gt;'],
+    ['number!', '[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)!'],
+    ['function(string, boolean)', 'function ([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean))'],
+    ['function(string, boolean): number', 'function ([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)): [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)'],
+    ['function()', 'function ()'],
+    ['function(this:something, string)', 'function (this: something, [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String))'],
+    ['function(new:something)', 'function (new: something)'],
+    ['{myNum: number, myObject}', '{myNum: [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number), myObject}'],
+    ['[string,]', '&#91;[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)&#93;'],
+    ['number?', '[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?'],
+    ['?number', '?[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)'],
+    ['?', '?'],
+    ['void', 'void'],
+    ['function(a:b)', 'function (a: b)'],
+    ['function(a):void', 'function (a): void'],
+    ['number=', '[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)='],
+    ['...number', '...[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)'],
+    ['undefined', '[undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined)']
+  ].forEach(function (example) {
+    t.deepEqual(mdast().stringify({
+      type: 'paragraph',
+      children: formatType(parseParamType(example[0]))
+    }), example[1], example[0]);
+  });
+
+  t.deepEqual(formatType(), [], 'empty case');
+
+  t.throws(function () {
+    formatType({});
+  });
+
+  t.end();
+});