Merge pull request #14 from purecloudlabs/DEVENGAGE-2875-code-fence-l…

…iteral DEVENGAGE-2875 Fix code fence examples - markdown renderer
purecloudlabs · Feb 7, 2025 · c5bf695 · c5bf695
2 parents bb7d6d4 + bb2add5
commit c5bf695
Show file tree

Hide file tree

Showing 7 changed files with 20 additions and 10 deletions.
diff --git a/yeast-markdown-renderer/dist/YeastNodeTypes/BlockCodeNode.d.ts.map b/yeast-markdown-renderer/dist/YeastNodeTypes/BlockCodeNode.d.ts.map
diff --git a/yeast-markdown-renderer/dist/index.js b/yeast-markdown-renderer/dist/index.js
diff --git a/yeast-markdown-renderer/dist/index.js.map b/yeast-markdown-renderer/dist/index.js.map
diff --git a/yeast-markdown-renderer/package-lock.json b/yeast-markdown-renderer/package-lock.json
diff --git a/yeast-markdown-renderer/package.json b/yeast-markdown-renderer/package.json
@@ -1,6 +1,6 @@
 {
 	"name": "yeast-markdown-renderer",
-	"version": "1.1.0",
+	"version": "1.2.0",
 	"description": "The yeast markdown renderer project provides a class to render yeast documents in markdown ",
 	"exports": {
 		"require": "./src/index.ts",

diff --git a/yeast-markdown-renderer/src/YeastNodeTypes/BlockCodeNode.ts b/yeast-markdown-renderer/src/YeastNodeTypes/BlockCodeNode.ts
@@ -1,6 +1,10 @@
 import { MarkdownRenderer } from '../MarkdownRenderer';
 import { BlockCodeNode } from 'yeast-core';
 
+// Matches case when codeblock content is a literal codeblock example
+const LITERAL_BACKTICK_REGEX = /((?:^|\n+)(?:\t+|\s+)*)(`{3})/ig;
+const LITERAL_TILDE_REGEX = /((?:^|\n+)(?:\t+|\s+)*)(~{3})/ig;
+
 export default function renderBlockCodeNode(node: BlockCodeNode, renderer: MarkdownRenderer) {
 	const jsonOptions = {
 		title: node.title,
@@ -10,7 +14,9 @@ export default function renderBlockCodeNode(node: BlockCodeNode, renderer: Markd
 		tabsToSpaces: node.tabsToSpaces,
 		showLineNumbers: node.showLineNumbers,
 	};
-	const children = node.value.split('\n');
+	const backtickEscapedVal = node.value.replace(LITERAL_BACKTICK_REGEX, '$1\\$2');
+	const tildeEscapedVal = backtickEscapedVal.replace(LITERAL_TILDE_REGEX, '$1\\$2');
+	const children = tildeEscapedVal.split('\n');
 	let finalVal = '';
 	const indentation = '\t';
 	children.forEach((child, index) => {
@@ -23,7 +29,7 @@ export default function renderBlockCodeNode(node: BlockCodeNode, renderer: Markd
 	);
 	if (!hasOptions)
 		return `\n${indentation.repeat(node.indentation)}\`\`\`${node.language}\n${finalVal}\n${indentation.repeat(node.indentation)}\`\`\`\n`;
-	return `\n${indentation.repeat(node.indentation)}\`\`\`${JSON.stringify(jsonOptions)}\n${node.value}\n${indentation.repeat(
+	return `\n${indentation.repeat(node.indentation)}\`\`\`${JSON.stringify(jsonOptions)}\n${tildeEscapedVal}\n${indentation.repeat(
 		node.indentation
 	)}\`\`\`\n`;
 }
diff --git a/yeast-markdown-renderer/src/__tests__/resources/GENERAL_DATA.ts b/yeast-markdown-renderer/src/__tests__/resources/GENERAL_DATA.ts
@@ -96,7 +96,7 @@ export const GENERAL_DATA = {
 			type: 'code',
 			language: 'java',
 			indentation: 2,
-			value: "console.log('hello world, I'm codefence')",
+			value: "```\n// Code goes here\nString str = \"my string\";\n```",
 		},
 		{
 			type: 'callout',