fix(legacy-html): keep $ sequences in template values as-is (#1186)

Author: btea

.changeset/dollar-sign-replacement.md

@@ -0,0 +1,7 @@
+---
+'@node-core/doc-kit-legacy': patch
+'@node-core/doc-kit': patch
+'@doc-kit/generator-react': patch
+---
+
+Fix template value replacement treating `$` sequences (such as `$$` in Makefile snippets) as special replacement patterns, which corrupted the rendered output.

packages/node-legacy/src/legacy-html/utils/__tests__/replaceTemplateValues.test.mjs

@@ -0,0 +1,66 @@
+'use strict';
+
+import assert from 'node:assert/strict';
+import { before, describe, it } from 'node:test';
+
+import { setConfig } from '@doc-kit/core/utils/configuration/index.mjs';
+
+import { replaceTemplateValues } from '../replaceTemplateValues.mjs';
+
+const template = '<main>__CONTENT__</main><nav>__GTOC__</nav>';
+
+const config = { version: { version: '1.0.0' }, changelog: [] };
+
+const createValues = overrides => ({
+  path: '/deprecations',
+  api: 'deprecations',
+  added: 'v1.0.0',
+  section: 'Deprecations',
+  toc: '',
+  nav: '',
+  content: '',
+  ...overrides,
+});
+
+describe('replaceTemplateValues', () => {
+  before(() => setConfig({}));
+
+  it('inserts content containing `$$` as-is', () => {
+    const content = 'dirname "$$(command -v node)"';
+
+    const output = replaceTemplateValues(
+      template,
+      createValues({ content }),
+      config,
+      { skipGitHub: true }
+    );
+
+    assert.strictEqual(output, `<main>${content}</main><nav></nav>`);
+  });
+
+  it("inserts content containing `$&`, `$'` and `` $` `` as-is", () => {
+    const content = "x $& y $' z $` w";
+
+    const output = replaceTemplateValues(
+      template,
+      createValues({ content }),
+      config,
+      { skipGitHub: true }
+    );
+
+    assert.strictEqual(output, `<main>${content}</main><nav></nav>`);
+  });
+
+  it('inserts nav containing `$` sequences as-is', () => {
+    const nav = "<a href='$&'>$'</a>";
+
+    const output = replaceTemplateValues(
+      template,
+      createValues({ nav }),
+      config,
+      { skipGitHub: true }
+    );
+
+    assert.strictEqual(output, `<main></main><nav>${nav}</nav>`);
+  });
+});

packages/node-legacy/src/legacy-html/utils/replaceTemplateValues.mjs

@@ -25,18 +25,19 @@ export const replaceTemplateValues = (
   { skipGitHub = false, skipGtocPicker = false } = {}
 ) => {
   return apiTemplate
-    .replace('__ID__', api)
-    .replace(/__FILENAME__/g, api)
-    .replace('__SECTION__', section)
-    .replace(/__VERSION__/g, `v${config.version.version}`)
-    .replace(/__TOC__/g, tableOfContents.wrapToC(toc))
-    .replace(/__GTOC__/g, nav)
-    .replace('__CONTENT__', content)
-    .replace(/__TOC_PICKER__/g, buildToC(toc))
-    .replace(/__GTOC_PICKER__/g, skipGtocPicker ? '' : buildNavigation(nav))
-    .replace('__ALTDOCS__', buildVersions(path, added, config.changelog))
-    .replace(
-      '__EDIT_ON_GITHUB__',
+    .replace('__ID__', () => api)
+    .replace(/__FILENAME__/g, () => api)
+    .replace('__SECTION__', () => section)
+    .replace(/__VERSION__/g, () => `v${config.version.version}`)
+    .replace(/__TOC__/g, () => tableOfContents.wrapToC(toc))
+    .replace(/__GTOC__/g, () => nav)
+    .replace('__CONTENT__', () => content)
+    .replace(/__TOC_PICKER__/g, () => buildToC(toc))
+    .replace(/__GTOC_PICKER__/g, () =>
+      skipGtocPicker ? '' : buildNavigation(nav)
+    )
+    .replace('__ALTDOCS__', () => buildVersions(path, added, config.changelog))
+    .replace('__EDIT_ON_GITHUB__', () =>
       skipGitHub
         ? ''
         : buildGitHub(populate(config.editURL, { ...config, path }))

packages/node/src/man-page/generate.mjs

@@ -68,8 +68,8 @@ export async function generate(input) {
   const template = await readFile(config.templatePath, 'utf-8');
 
   const filledTemplate = template
-    .replace('__OPTIONS__', output.options)
-    .replace('__ENVIRONMENT__', output.env);
+    .replace('__OPTIONS__', () => output.options)
+    .replace('__ENVIRONMENT__', () => output.env);
 
   if (config.output) {
     await writeFile(join(config.output, config.fileName), filledTemplate);

packages/react/src/sitemap/generate.mjs

@@ -50,14 +50,14 @@ export async function generate(entries) {
   const urlset = apiPages
     .map(page =>
       entryTemplate
-        .replace('__LOC__', page.loc)
-        .replace('__LASTMOD__', page.lastmod)
-        .replace('__CHANGEFREQ__', page.changefreq)
-        .replace('__PRIORITY__', page.priority)
+        .replace('__LOC__', () => page.loc)
+        .replace('__LASTMOD__', () => page.lastmod)
+        .replace('__CHANGEFREQ__', () => page.changefreq)
+        .replace('__PRIORITY__', () => page.priority)
     )
     .join('');
 
-  const sitemap = template.replace('__URLSET__', urlset);
+  const sitemap = template.replace('__URLSET__', () => urlset);
 
   if (config.output) {
     await writeFile(join(config.output, 'sitemap.xml'), sitemap, 'utf-8');