Merge pull request #188 from docsbydoxdox/hotfix/encode-html-tags-in-…

…renderers [hotfix] Encode HTML tags in renderers.
docsbydoxdox · Sep 9, 2022 · 628b862 · 628b862
2 parents 15ce144 + 97973d1
commit 628b862
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 4 deletions.
diff --git a/packages/doxdox-renderer-bootstrap/src/index.ts b/packages/doxdox-renderer-bootstrap/src/index.ts
@@ -46,6 +46,9 @@ ${md
                 ...method.params.map(({ name, types, description }) => [
                     name,
                     `<code>${types
+                        .map(type =>
+                            type.replace(/</, '&lt;').replace(/>/, '&gt;')
+                        )
                         .map(type => mdTypes.renderInline(type))
                         .join('</code>, <code>')}</code>`,
                     description || ''
@@ -65,6 +68,7 @@ ${
 
 ${method.returns.map(
     param => `<p><code>${param.types
+        .map(type => type.replace(/</, '&lt;').replace(/>/, '&gt;'))
         .map(type => mdTypes.renderInline(type))
         .join('</code>, <code>')}</code></p>
 

diff --git a/packages/doxdox-renderer-dash/src/index.ts b/packages/doxdox-renderer-dash/src/index.ts
@@ -68,6 +68,7 @@ ${md
             ...method.params.map(({ name, types, description }) => [
                 name,
                 `<code>${types
+                    .map(type => type.replace(/</, '&lt;').replace(/>/, '&gt;'))
                     .map(type => mdTypes.renderInline(type))
                     .join('</code>, <code>')}</code>`,
                 description || ''
@@ -85,6 +86,7 @@ ${
 
 ${method.returns.map(
     param => `<p><code>${param.types
+        .map(type => type.replace(/</, '&lt;').replace(/>/, '&gt;'))
         .map(type => mdTypes.renderInline(type))
         .join('</code>, <code>')}</code></p>
 

diff --git a/packages/doxdox-renderer-github-wiki/src/index.ts b/packages/doxdox-renderer-github-wiki/src/index.ts
@@ -22,7 +22,9 @@ ${markdownTable([
     ['Name', 'Types', 'Description'],
     ...method.params.map(({ name, types, description }) => [
         name,
-        types.join(', '),
+        types
+            .map(type => type.replace(/</, '&lt;').replace(/>/, '&gt;'))
+            .join(', '),
         description || ''
     ])
 ])}`
@@ -34,7 +36,9 @@ ${
         ? `### Returns
 
 ${method.returns.map(
-    param => `${param.types.join(', ')}
+    param => `${param.types
+        .map(type => type.replace(/</, '&lt;').replace(/>/, '&gt;'))
+        .join(', ')}
 ${param.description || ''}`
 )}`
         : ''

diff --git a/packages/doxdox-renderer-markdown/src/index.ts b/packages/doxdox-renderer-markdown/src/index.ts
@@ -16,7 +16,9 @@ ${markdownTable([
     ['Name', 'Types', 'Description'],
     ...method.params.map(({ name, types, description }) => [
         name,
-        types.join(', '),
+        types
+            .map(type => type.replace(/</, '&lt;').replace(/>/, '&gt;'))
+            .join(', '),
         description || ''
     ])
 ])}`
@@ -28,7 +30,9 @@ ${
         ? `### Returns
 
 ${method.returns.map(
-    param => `${param.types.join(', ')}
+    param => `${param.types
+        .map(type => type.replace(/</, '&lt;').replace(/>/, '&gt;'))
+        .join(', ')}
 ${param.description || ''}`
 )}`
         : ''

diff --git a/packages/doxdox-renderer-pdf/src/index.ts b/packages/doxdox-renderer-pdf/src/index.ts
@@ -42,6 +42,7 @@ ${md
             ...method.params.map(({ name, types, description }) => [
                 name,
                 `<code>${types
+                    .map(type => type.replace(/</, '&lt;').replace(/>/, '&gt;'))
                     .map(type => mdTypes.renderInline(type))
                     .join('</code>, <code>')}</code>`,
                 description || ''
@@ -59,6 +60,7 @@ ${
 
 ${method.returns.map(
     param => `<p><code>${param.types
+        .map(type => type.replace(/</, '&lt;').replace(/>/, '&gt;'))
         .map(type => mdTypes.renderInline(type))
         .join('</code>, <code>')}</code></p>