Skip to content

Commit 8962a9f

Browse files
tgreyuktgreyuk
committed
fix(core): remove superfluous spaces and symbol on external links (#614)
1 parent 569eb47 commit 8962a9f

File tree

5 files changed

+26
-25
lines changed

5 files changed

+26
-25
lines changed

‎.changeset/young-wombats-applaud.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
---
2-
"typedoc-plugin-markdown": patch
2+
'typedoc-plugin-markdown': patch
33
---
44

5+
- Remove superfluous spaces and symbol on external links (#614)
56
- Escape all angle brackets with "santizeComments" (#612)
67
- Correctly handle quoted symbol names (#611)
78
- Correctly handle excludeScopesInPaths in windows (#610)

‎packages/typedoc-plugin-markdown/src/theme/resources/partials/type.reference.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ export function referenceType(
2222
} else {
2323
reflection.push(
2424
model.externalUrl
25-
? `[${backTicks(model.name + ' ↗️')}]( ${model.externalUrl} )`
25+
? link(backTicks(model.name), model.externalUrl)
2626
: backTicks(model.name),
2727
);
2828
}
@@ -32,6 +32,6 @@ export function referenceType(
3232
return reflection.join('');
3333
}
3434
return model.externalUrl
35-
? `[${backTicks(model.name + ' ↗️')}]( ${model.externalUrl} )`
35+
? link(backTicks(model.name), model.externalUrl)
3636
: backTicks(model.name);
3737
}

‎packages/typedoc-plugin-markdown/test/specs/__snapshots__/objects-and-params.spec.ts.snap

+12-12
Original file line numberDiff line numberDiff line change
@@ -228,13 +228,13 @@ Comments for BasicInterface
228228
exports[`Objects And Params should compile function returning a promise: (Output File Strategy "members") (Option Group "1") 1`] = `
229229
"# Function: functionReturningAPromise()
230230
231-
> **functionReturningAPromise**(): [\`Promise ↗️\`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise )\\<\\{\`"prop"\`: \`string\`; \\}\\>
231+
> **functionReturningAPromise**(): [\`Promise\`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\\<\\{\`"prop"\`: \`string\`; \\}\\>
232232
233233
Comments for function
234234
235235
## Returns
236236
237-
[\`Promise ↗️\`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise )\\<\\{\`"prop"\`: \`string\`; \\}\\>
237+
[\`Promise\`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\\<\\{\`"prop"\`: \`string\`; \\}\\>
238238
239239
Return comments
240240
@@ -257,7 +257,7 @@ Comments for function
257257
258258
## Returns
259259
260-
[\`Promise ↗️\`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise )\\<\\{
260+
[\`Promise\`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\\<\\{
261261
\`"prop"\`: \`string\`;
262262
\\}\\>
263263
@@ -500,7 +500,7 @@ bar: number;
500500
exports[`Objects And Params should compile literal type: (Output File Strategy "members") (Option Group "1") 1`] = `
501501
"# Type alias: LiteralType
502502
503-
> **LiteralType**: \\{\`"x"\`: \`string\`;\`"y"\`: \\{\`"x"\`: \`string\`;\`"y"\`: \`boolean\` \\| \`string\`;\`"z"\`: (\`x\`: \`string\`) => \`string\`; \\};\`"z"\`: (\`x\`: \`string\`) => \`string\`;get set \`"accessorA"\`: [\`Promise ↗️\`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise )\\<\`string\`\\>;get set \`"accessorB"\`: \`string\`;\`"someFunction"\`: [\`Promise ↗️\`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise )\\<\`any\`\\>; \\}
503+
> **LiteralType**: \\{\`"x"\`: \`string\`;\`"y"\`: \\{\`"x"\`: \`string\`;\`"y"\`: \`boolean\` \\| \`string\`;\`"z"\`: (\`x\`: \`string\`) => \`string\`; \\};\`"z"\`: (\`x\`: \`string\`) => \`string\`;get set \`"accessorA"\`: [\`Promise\`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\\<\`string\`\\>;get set \`"accessorB"\`: \`string\`;\`"someFunction"\`: [\`Promise\`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\\<\`any\`\\>; \\}
504504
505505
Comments for LiteralType
506506
@@ -558,21 +558,21 @@ comment for y.z
558558
559559
### accessorA
560560
561-
> \`get\` **accessorA**(): [\`Promise ↗️\`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise )\\<\`string\`\\>
561+
> \`get\` **accessorA**(): [\`Promise\`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\\<\`string\`\\>
562562
563563
Comments for accessorA getter
564564
565-
> \`set\` **accessorA**(\`x\`: [\`Promise ↗️\`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise )\\<\`string\`\\>): \`void\`
565+
> \`set\` **accessorA**(\`x\`: [\`Promise\`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\\<\`string\`\\>): \`void\`
566566
567567
Comments for accessorA setter
568568
569569
#### Parameters
570570
571-
• **x**: [\`Promise ↗️\`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise )\\<\`string\`\\>
571+
• **x**: [\`Promise\`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\\<\`string\`\\>
572572
573573
#### Returns
574574
575-
[\`Promise ↗️\`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise )\\<\`string\`\\>
575+
[\`Promise\`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\\<\`string\`\\>
576576
577577
### accessorB
578578
@@ -598,7 +598,7 @@ Comments for someFunction
598598
599599
#### Returns
600600
601-
[\`Promise ↗️\`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise )\\<\`any\`\\>
601+
[\`Promise\`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\\<\`any\`\\>
602602
"
603603
`;
604604
@@ -712,11 +712,11 @@ Comments for accessorA setter
712712
713713
| Parameter | Type |
714714
| :------ | :------ |
715-
| \`x\` | [\`Promise ↗️\`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise )\\<\`string\`\\> |
715+
| \`x\` | [\`Promise\`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\\<\`string\`\\> |
716716
717717
#### Returns
718718
719-
[\`Promise ↗️\`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise )\\<\`string\`\\>
719+
[\`Promise\`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\\<\`string\`\\>
720720
721721
### accessorB
722722
@@ -750,7 +750,7 @@ Comments for someFunction
750750
751751
#### Returns
752752
753-
[\`Promise ↗️\`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise )\\<\`any\`\\>
753+
[\`Promise\`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\\<\`any\`\\>
754754
"
755755
`;
756756

‎packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.function.spec.ts.snap

+3-3
Original file line numberDiff line numberDiff line change
@@ -67,13 +67,13 @@ Comments for function
6767
exports[`Function Reflection should compile function returning a promise: (Output File Strategy "members") (Option Group "1") 1`] = `
6868
"# Function: functionReturningAPromise()
6969
70-
> **functionReturningAPromise**(): [\`Promise ↗️\`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise )\\<\`object\`\\>
70+
> **functionReturningAPromise**(): [\`Promise\`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\\<\`object\`\\>
7171
7272
Comments for function
7373
7474
## Returns
7575
76-
[\`Promise ↗️\`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise )\\<\`object\`\\>
76+
[\`Promise\`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\\<\`object\`\\>
7777
7878
Return comments
7979
@@ -98,7 +98,7 @@ Comments for function
9898
9999
## Returns
100100
101-
[\`Promise ↗️\`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise )\\<\`object\`\\>
101+
[\`Promise\`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\\<\`object\`\\>
102102
103103
Return comments
104104

‎packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.type-alias.spec.ts.snap

+7-7
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ Comments for ConditionalType
6969
exports[`Type Alias Reflection should compile external link symbol type: (Output File Strategy "members") (Option Group "1") 1`] = `
7070
"# Type alias: TypeWithExternalSymbolLinkMapping
7171
72-
> **TypeWithExternalSymbolLinkMapping**: [\`Application ↗️\`]( https://typedoc.org/api/classes/Application.html )
72+
> **TypeWithExternalSymbolLinkMapping**: [\`Application\`](https://typedoc.org/api/classes/Application.html)
7373
7474
Comments for TypeWithExternalSymbolLinkMapping
7575
@@ -155,7 +155,7 @@ comment for y.z
155155
156156
### accessorA
157157
158-
> \`get\` **accessorA**(): [\`Promise ↗️\`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise )\\<\`string\`\\>
158+
> \`get\` **accessorA**(): [\`Promise\`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\\<\`string\`\\>
159159
160160
Comments for accessorA getter
161161
@@ -165,11 +165,11 @@ Comments for accessorA setter
165165
166166
#### Parameters
167167
168-
• **x**: [\`Promise ↗️\`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise )\\<\`string\`\\>
168+
• **x**: [\`Promise\`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\\<\`string\`\\>
169169
170170
#### Returns
171171
172-
[\`Promise ↗️\`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise )\\<\`string\`\\>
172+
[\`Promise\`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\\<\`string\`\\>
173173
174174
### accessorB
175175
@@ -195,7 +195,7 @@ Comments for someFunction
195195
196196
#### Returns
197197
198-
[\`Promise ↗️\`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise )\\<\`any\`\\>
198+
[\`Promise\`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\\<\`any\`\\>
199199
200200
## Source
201201
@@ -222,11 +222,11 @@ Comments for LiteralType
222222
| \`y.y\` | \`boolean\` \\| \`string\` | comment for y.y |
223223
| \`y.z\` | (\`x\`: \`string\`) => \`string\` | comment for y.z |
224224
| \`z\` | (\`x\`: \`string\`) => \`string\` | - |
225-
| \`get accessorA\` | [\`Promise ↗️\`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise )\\<\`string\`\\> | Comments for accessorA getter |
225+
| \`get accessorA\` | [\`Promise\`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\\<\`string\`\\> | Comments for accessorA getter |
226226
| \`set accessorA\` | \`void\` | Comments for accessorA setter |
227227
| \`get accessorB\` | \`string\` | - |
228228
| \`set accessorB\` | \`void\` | - |
229-
| \`someFunction\` | [\`Promise ↗️\`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise )\\<\`any\`\\> | Comments for someFunction |
229+
| \`someFunction\` | [\`Promise\`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\\<\`any\`\\> | Comments for someFunction |
230230
231231
## Source
232232

0 commit comments

Comments
 (0)