Fix custom markdown formatter tests

tmcw · tmcw · commit 2e8ea165d97c · 2015-09-28T21:09:20.000-04:00
diff --git a/lib/markdown_helpers.js b/lib/markdown_helpers.js
@@ -45,13 +45,15 @@ function formatParameter(param) {
  * Format the parameters of a function into a quickly-readable
  * summary that resembles how you would call the function
  * initially.
+ * @param {Object} args arguments from Handlebars
  * @returns {string} formatted type parameters
  */
-function formatParameters() {
-  if (!this.params) {
+function formatParameters(args) {
+  var data = args.data.root;
+  if (!data.params) {
     return '';
   }
-  return '(' + this.params.map(function (param) {
+  return '(' + data.params.map(function (param) {
     return formatParameter(param);
   }).join(', ') + ')';
 }
diff --git a/test/fixture/es6.output.custom.md b/test/fixture/es6.output.custom.md
@@ -4,6 +4,5 @@ This function returns the number one.
 
 
 
-
 Returns `Number` numberone
 
diff --git a/test/fixture/event.output.custom.md b/test/fixture/event.output.custom.md
@@ -9,4 +9,3 @@ Mouse event
 | `originalEvent` | `Event` | the original DOM event |
 
 
-
diff --git a/test/fixture/external.output.custom.md b/test/fixture/external.output.custom.md
@@ -1,7 +1,6 @@
 ## `foo`
 
-I am in `external.input.js`.
-
+I am in &#x60;external.input.js&#x60;.
 
 
 
diff --git a/test/fixture/factory.output.custom.md b/test/fixture/factory.output.custom.md
@@ -4,7 +4,6 @@ an area chart generator
 
 
 
-
 Returns `area` chart
 
 ## `area`
@@ -14,12 +13,10 @@ Returns `area` chart
 
 
 
-
 ## `data`
 
 Sets the chart data.
 
 
 
 
-
diff --git a/test/fixture/inline-link.output.custom.md b/test/fixture/inline-link.output.custom.md
@@ -1,4 +1,4 @@
-## `addOne`
+## `addOne(a)`
 
 Adds one to a number
 
@@ -7,19 +7,17 @@ Adds one to a number
 * `a` **`number`** the input
 
 
-
 Returns `number` the output
 
-## `exports`
+## `exports(a)`
 
 This function returns the number one. Internally, this uses
-`addOne` to do the math.
+{@link addOne} to do the math.
 
 ### Parameters
 
 * `a` **`number`** the input
 
 
-
 Returns `number` numberone
 
diff --git a/test/fixture/internal.output.custom.md b/test/fixture/internal.output.custom.md
@@ -1,7 +1,6 @@
 ## `foo`
 
-I am in `external.input.js`.
-
+I am in &#x60;external.input.js&#x60;.
 
 
 
diff --git a/test/fixture/memberof-missing.output.custom.md b/test/fixture/memberof-missing.output.custom.md
@@ -1,4 +1,4 @@
-## `setTime`
+## `setTime(time)`
 
 Set the time
 
@@ -7,6 +7,5 @@ Set the time
 * `time` **`Date`** the current time
 
 
-
 Returns  nothing
 
diff --git a/test/fixture/multiexample.output.custom.md b/test/fixture/multiexample.output.custom.md
@@ -4,18 +4,5 @@ This function returns the number one.
 
 
 
-### Examples
-
-```js
-foo(1);
-```
-```js
-foo(2);
-```
-
 Returns `Number` numberone
 
-| type | description |
-| ---- | ----------- |
-| `Error` | if you give it something |
-| `TypeError` | if you give it something else |
diff --git a/test/fixture/multisignature.output.custom.md b/test/fixture/multisignature.output.custom.md
@@ -4,10 +4,9 @@ Get the time
 
 
 
-
 Returns `Date` the current date
 
-## `getTheTime`
+## `getTheTime(time)`
 
 Set the time
 
@@ -16,6 +15,5 @@ Set the time
 * `time` **`Date`** the current time
 
 
-
 Returns  nothing
 
diff --git a/test/fixture/nested_properties.output.custom.md b/test/fixture/nested_properties.output.custom.md
@@ -1,4 +1,4 @@
-## `foo`
+## `foo(options, bar)`
 
 
 
@@ -9,6 +9,5 @@
 * `bar` **`number`** something else
 
 
-
 Returns `Object` foo something else
 
diff --git a/test/fixture/newline-in-description.output.custom.md b/test/fixture/newline-in-description.output.custom.md
@@ -1,4 +1,4 @@
-## ``
+## `(a)`
 
 A function.
 
@@ -8,4 +8,3 @@ A function.
 
 
 
-
diff --git a/test/fixture/no-name.output.custom.md b/test/fixture/no-name.output.custom.md
@@ -1,4 +1,4 @@
-## ``
+## `(bar)`
 
 Set the time
 
@@ -8,4 +8,3 @@ Set the time
 
 
 
-
diff --git a/test/fixture/optional.output.custom.md b/test/fixture/optional.output.custom.md
@@ -1,4 +1,4 @@
-## `Address6`
+## `Address6(address, [groups])`
 
 Represents an IPv6 address
 
@@ -8,10 +8,4 @@ Represents an IPv6 address
 * `groups` **`[number]`** How many octets to parse (optional, default `8`)
 
 
-### Examples
-
-```js
-var address = new Address6('2001::/32');
-```
-
 
diff --git a/test/fixture/simple-hashbang.output.custom.md b/test/fixture/simple-hashbang.output.custom.md
@@ -4,6 +4,5 @@ This function returns the number one.
 
 
 
-
 Returns `Number` numberone
 
diff --git a/test/fixture/simple-two.output.custom.md b/test/fixture/simple-two.output.custom.md
@@ -1,4 +1,4 @@
-## `returnTwo`
+## `returnTwo(a)`
 
 This function returns the number plus two.
 
@@ -7,12 +7,5 @@ This function returns the number plus two.
 * `a` **`Number`** the number
 
 
-### Examples
-
-```js
-var result = returnTwo(4);
-// result is 6
-```
-
 Returns `Number` numbertwo
 
diff --git a/test/fixture/simple.output.custom.md b/test/fixture/simple.output.custom.md
@@ -4,6 +4,5 @@ This function returns the number one.
 
 
 
-
 Returns `Number` numberone
 
diff --git a/test/fixture/throws.output.custom.md b/test/fixture/throws.output.custom.md
@@ -1,4 +1,4 @@
-## `returnTwo`
+## `returnTwo(a)`
 
 This function returns the number plus two.
 
@@ -7,15 +7,5 @@ This function returns the number plus two.
 * `a` **`Number`** the number
 
 
-### Examples
-
-```js
-var result = returnTwo(4);
-// result is 6
-```
-
 Returns `Number` numbertwo
 
-| type | description |
-| ---- | ----------- |
-| `Error` | if number is 3 |
diff --git a/test/fixture/type_application.output.custom.md b/test/fixture/type_application.output.custom.md
@@ -1,4 +1,4 @@
-## `Address6`
+## `Address6(address)`
 
 Represents an IPv6 address
 
@@ -8,4 +8,3 @@ Represents an IPv6 address
 
 
 
-
diff --git a/test/fixture/typedef.output.custom.md b/test/fixture/typedef.output.custom.md
@@ -9,4 +9,3 @@ A type definition.
 | `prop2` | `string` | another property |
 
 
-
diff --git a/test/misc/custom.hbs b/test/misc/custom.hbs
diff --git a/test/misc/index.js b/test/misc/index.js
@@ -0,0 +1 @@
+// foo
diff --git a/test/misc/markdown.hbs b/test/misc/markdown.hbs
@@ -0,0 +1,29 @@
+## `{{name}}{{#if params}}{{format_params}}{{/if}}`
+
+{{#description}}
+{{.}}
+{{/description}}
+
+{{#if params}}
+### Parameters
+
+{{#params}}
+* `{{name}}` **{{format_type type}}** {{format_description description}}{{#default}} (optional, default `{{.}}`){{/default}}
+{{#properties}}
+  * `{{name}}` **{{format_type type}}** {{format_description description}}{{#default}} (optional, default `{{.}}`){{/default}}
+{{/properties}}
+{{/params}}
+{{/if}}
+
+{{#if properties}}
+| name | type | description |
+| ---- | ---- | ----------- |
+{{#properties}}
+| `{{name}}` | {{format_type type}} | {{format_description description}} |
+{{/properties}}
+{{/if}}
+
+{{#returns}}
+Returns {{#type.name}}`{{.}}`{{/type.name}} {{description}}
+{{/returns}}
+
diff --git a/test/misc/package.json b/test/misc/package.json
@@ -0,0 +1,6 @@
+{
+  "name": "test-theme",
+  "description": "",
+  "main": "index.js",
+  "version": "0.0.0"
+}
diff --git a/test/test.js b/test/test.js
@@ -130,7 +130,7 @@ test('markdown', function (tt) {
             fs.writeFileSync(outputfile, result, 'utf8');
           }
           var expect = fs.readFileSync(outputfile, 'utf8');
-          t.equal(result.toString(), expect);
+          t.equal(result.toString(), expect, 'markdown output correct');
           t.end();
         });
       });
@@ -139,15 +139,15 @@ test('markdown', function (tt) {
       documentation([file], null, function (err, result) {
         t.ifError(err);
         outputMarkdown(result, {
-          template: path.join(__dirname, '/misc/custom.hbs')
+          theme: path.join(__dirname, '/misc/')
         }, function (err, result) {
           t.ifError(err);
           var outputfile = file.replace('.input.js', '.output.custom.md');
           if (UPDATE) {
             fs.writeFileSync(outputfile, result, 'utf8');
           }
           var expect = fs.readFileSync(outputfile, 'utf8');
-          t.equal(result.toString(), expect);
+          t.equal(result.toString(), expect, 'custom output correct');
           t.end();
         });
       });

Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,5 @@ This function returns the number one.`
`4`	`4`
`5`	`5`
`6`	`6`
`7`		`-`
`8`	`7`	Returns `Number` numberone
`9`	`8`
Original file line number	Diff line number	Diff line change
`@@ -9,4 +9,3 @@ Mouse event`
`9`	`9`	\| `originalEvent` \| `Event` \| the original DOM event \|
`10`	`10`
`11`	`11`
`12`		`-`