@tinymce/moxiedoc - npm Package Compare versions

Comparing version 0.2.0-feature.20220328004447693.sha90b7294 to 0.2.0-feature.20220331003502608.sha4e20037

dist/templates/antora/antora.converter.js

@@ -22,6 +22,6 @@ "use strict";
 const encodeBR = (str) => str.replace(/<br\s*\/?>/g, '\n');
-// convert <em> into _italics_ asciidoc
-const encodeEM = (str) => str.replace(/<\/?em>/g, '_');
-// convert <strong> into *bold* asciidoc
-const encodeStrong = (str) => str.replace(/<\/?strong>/g, '*');
+// convert <em> into __italics__ asciidoc
+const encodeEM = (str) => str.replace(/<\/?em>/g, '__');
+// convert <strong> into **bold** asciidoc
+const encodeStrong = (str) => str.replace(/<\/?strong>/g, '**');
 // convert <code> into backtick asciidoc
@@ -47,7 +47,16 @@ const encodeCode = (str) => {
 };
+// escape special asciidoc characters
+const specialChars = {
+    '|': '{vbar}',
+    '+': '{plus}',
+    '*': '{asterisk}'
+};
+const escapeSpecialChars = (str) => str.replace(/[|+*]/g, (match) => specialChars[match] || match);
 // convert content that looks like asciidoc attributes (e.g {0}) to literal strings
-const escapeAttributes = (str) => str.replace(/(\{\s*[\w\d-]+\s*\})/g, '+$1+');
+// Note: Special characters should not be escaped
+const specialAttrs = Object.values(specialChars);
+const escapeAttributes = (str) => str.replace(/(\{\s*[\w\d-]+\s*\})/g, (match) => specialAttrs.indexOf(match) !== -1 ? match : `+${match}+`);
 // runs a bunch of required cleanup filters, where embedded code/text can break asciidoc rendering
 const cleanup = (str) => {
-    const filters = [escapeComments, encodeBR, encodeEM, encodeStrong, encodeLinks, encodeCode, escapeAttributes];
+    const filters = [escapeSpecialChars, escapeAttributes, escapeComments, encodeBR, encodeEM, encodeStrong, encodeLinks, encodeCode];
     return filters.reduce((acc, filter) => filter(acc), str);
@@ -54,0 +63,0 @@ };

package.json

 {
   "name": "@tinymce/moxiedoc",
-  "version": "0.2.0-feature.20220328004447693.sha90b7294",
+  "version": "0.2.0-feature.20220331003502608.sha4e20037",
   "description": "A tool for generating API documentation",
@@ -5,0 +5,0 @@ "author": "Tiny Technologies, Inc",

src/templates/antora/antora.converter.ts

@@ -32,9 +32,9 @@ import { Return } from '../../lib/member';
 
-// convert <em> into _italics_ asciidoc
+// convert <em> into __italics__ asciidoc
 const encodeEM = (str: string): string =>
-  str.replace(/<\/?em>/g, '_');
+  str.replace(/<\/?em>/g, '__');
 
-// convert <strong> into *bold* asciidoc
+// convert <strong> into **bold** asciidoc
 const encodeStrong = (str: string): string =>
-  str.replace(/<\/?strong>/g, '*');
+  str.replace(/<\/?strong>/g, '**');
 
@@ -62,9 +62,20 @@ // convert <code> into backtick asciidoc
 
+// escape special asciidoc characters
+const specialChars = {
+  '|': '{vbar}',
+  '+': '{plus}',
+  '*': '{asterisk}'
+};
+const escapeSpecialChars = (str: string): string =>
+  str.replace(/[|+*]/g, (match) => specialChars[match] || match);
+
 // convert content that looks like asciidoc attributes (e.g {0}) to literal strings
+// Note: Special characters should not be escaped
+const specialAttrs = Object.values(specialChars);
 const escapeAttributes = (str: string): string =>
-  str.replace(/(\{\s*[\w\d-]+\s*\})/g, '+$1+');
+  str.replace(/(\{\s*[\w\d-]+\s*\})/g, (match) => specialAttrs.indexOf(match) !== -1 ? match : `+${match}+`);
 
 // runs a bunch of required cleanup filters, where embedded code/text can break asciidoc rendering
 const cleanup = (str: string): string => {
-  const filters = [ escapeComments, encodeBR, encodeEM, encodeStrong, encodeLinks, encodeCode, escapeAttributes ];
+  const filters = [ escapeSpecialChars, escapeAttributes, escapeComments, encodeBR, encodeEM, encodeStrong, encodeLinks, encodeCode ];
   return filters.reduce((acc, filter) => filter(acc), str);
@@ -71,0 +82,0 @@ };

No alert changes

Improved metrics

Total package byte prevSize

345551

increased by0.37%

Lines of code

6676

increased by0.29%

No dependency changes