Skip to content

Commit 6fa5618

Browse files
committed
Rename mdast to remark
This additionally updates remark, which includes AST-escaping, resulting in no unnecessary escapes inside documentation. Related to documentationjs/documentation#322.
1 parent 1442ba3 commit 6fa5618

File tree

3 files changed

+9
-9
lines changed

3 files changed

+9
-9
lines changed

index.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,11 +77,11 @@ function formatType(node, getNamedLink) {
7777

7878
case Syntax.TypeApplication:
7979
return formatType(node.expression, getNamedLink)
80-
.concat(commaList(getNamedLink, node.applications, '.<', '>'));
80+
.concat(commaList(getNamedLink, node.applications, '.<', '>'));
8181
case Syntax.UnionType:
8282
return commaList(getNamedLink, node.elements, '(', ')', '|');
8383
case Syntax.ArrayType:
84-
return commaList(getNamedLink, node.elements, '&#91;', '&#93;');
84+
return commaList(getNamedLink, node.elements, '[', ']');
8585
case Syntax.RecordType:
8686
return commaList(getNamedLink, node.fields, '{', '}');
8787

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
"unist-builder": "^1.0.0"
2121
},
2222
"devDependencies": {
23-
"mdast": "^2.3.0",
23+
"remark": "^3.0.0",
2424
"tap": "^2.3.1"
2525
}
2626
}

test/format_type.js

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
'use strict';
33

44
var formatType = require('../index').formatType,
5-
mdast = require('mdast'),
5+
remark = require('remark'),
66
parse = require('doctrine').parse,
77
test = require('tap').test;
88

@@ -12,16 +12,16 @@ test('formatType', function (t) {
1212
['null', 'null'],
1313
['null', 'null'],
1414
['*', 'Any'],
15-
['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))'],
16-
['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;'],
15+
['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))'],
16+
['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)>'],
1717
['number!', '[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)!'],
1818
['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))'],
1919
['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)'],
2020
['function()', 'function ()'],
2121
['function(this:something, string)', 'function (this: something, [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String))'],
2222
['function(new:something)', 'function (new: something)'],
2323
['{myNum: number, myObject}', '{myNum: [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number), myObject}'],
24-
['[string,]', '&#91;[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)&#93;'],
24+
['[string,]', '\\[[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)]'],
2525
['number?', '[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?'],
2626
['?number', '?[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)'],
2727
['?', '?'],
@@ -32,14 +32,14 @@ test('formatType', function (t) {
3232
['...number', '...[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)'],
3333
['undefined', '[undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined)']
3434
].forEach(function (example) {
35-
t.deepEqual(mdast().stringify({
35+
t.deepEqual(remark().stringify({
3636
type: 'paragraph',
3737
children: formatType(
3838
parse('@param {' + example[0] + '} a', { sloppy: true }).tags[0].type)
3939
}), example[1], example[0]);
4040
});
4141

42-
t.deepEqual(mdast().stringify({
42+
t.deepEqual(remark().stringify({
4343
type: 'paragraph',
4444
children: formatType(
4545
parse('@param {number} [a=1]', { sloppy: true }).tags[0].type)

0 commit comments

Comments
 (0)