Skip to content

Commit 97973d1

Browse files
committed
Encode HTML tags in renderers.
1 parent 15ce144 commit 97973d1

File tree

5 files changed

+20
-4
lines changed

5 files changed

+20
-4
lines changed

packages/doxdox-renderer-bootstrap/src/index.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,9 @@ ${md
4646
...method.params.map(({ name, types, description }) => [
4747
name,
4848
`<code>${types
49+
.map(type =>
50+
type.replace(/</, '&lt;').replace(/>/, '&gt;')
51+
)
4952
.map(type => mdTypes.renderInline(type))
5053
.join('</code>, <code>')}</code>`,
5154
description || ''
@@ -65,6 +68,7 @@ ${
6568
6669
${method.returns.map(
6770
param => `<p><code>${param.types
71+
.map(type => type.replace(/</, '&lt;').replace(/>/, '&gt;'))
6872
.map(type => mdTypes.renderInline(type))
6973
.join('</code>, <code>')}</code></p>
7074

packages/doxdox-renderer-dash/src/index.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ ${md
6868
...method.params.map(({ name, types, description }) => [
6969
name,
7070
`<code>${types
71+
.map(type => type.replace(/</, '&lt;').replace(/>/, '&gt;'))
7172
.map(type => mdTypes.renderInline(type))
7273
.join('</code>, <code>')}</code>`,
7374
description || ''
@@ -85,6 +86,7 @@ ${
8586
8687
${method.returns.map(
8788
param => `<p><code>${param.types
89+
.map(type => type.replace(/</, '&lt;').replace(/>/, '&gt;'))
8890
.map(type => mdTypes.renderInline(type))
8991
.join('</code>, <code>')}</code></p>
9092

packages/doxdox-renderer-github-wiki/src/index.ts

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,9 @@ ${markdownTable([
2222
['Name', 'Types', 'Description'],
2323
...method.params.map(({ name, types, description }) => [
2424
name,
25-
types.join(', '),
25+
types
26+
.map(type => type.replace(/</, '&lt;').replace(/>/, '&gt;'))
27+
.join(', '),
2628
description || ''
2729
])
2830
])}`
@@ -34,7 +36,9 @@ ${
3436
? `### Returns
3537
3638
${method.returns.map(
37-
param => `${param.types.join(', ')}
39+
param => `${param.types
40+
.map(type => type.replace(/</, '&lt;').replace(/>/, '&gt;'))
41+
.join(', ')}
3842
${param.description || ''}`
3943
)}`
4044
: ''

packages/doxdox-renderer-markdown/src/index.ts

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,9 @@ ${markdownTable([
1616
['Name', 'Types', 'Description'],
1717
...method.params.map(({ name, types, description }) => [
1818
name,
19-
types.join(', '),
19+
types
20+
.map(type => type.replace(/</, '&lt;').replace(/>/, '&gt;'))
21+
.join(', '),
2022
description || ''
2123
])
2224
])}`
@@ -28,7 +30,9 @@ ${
2830
? `### Returns
2931
3032
${method.returns.map(
31-
param => `${param.types.join(', ')}
33+
param => `${param.types
34+
.map(type => type.replace(/</, '&lt;').replace(/>/, '&gt;'))
35+
.join(', ')}
3236
${param.description || ''}`
3337
)}`
3438
: ''

packages/doxdox-renderer-pdf/src/index.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ ${md
4242
...method.params.map(({ name, types, description }) => [
4343
name,
4444
`<code>${types
45+
.map(type => type.replace(/</, '&lt;').replace(/>/, '&gt;'))
4546
.map(type => mdTypes.renderInline(type))
4647
.join('</code>, <code>')}</code>`,
4748
description || ''
@@ -59,6 +60,7 @@ ${
5960
6061
${method.returns.map(
6162
param => `<p><code>${param.types
63+
.map(type => type.replace(/</, '&lt;').replace(/>/, '&gt;'))
6264
.map(type => mdTypes.renderInline(type))
6365
.join('</code>, <code>')}</code></p>
6466

0 commit comments

Comments
 (0)