Append build comment to preview.html

jhildenbiddle · jhildenbiddle · commit a3e92b33de07 · 2023-12-04T10:35:00.000-06:00
diff --git a/build/html.js b/build/html.js
@@ -1,23 +1,35 @@
 import * as fs from 'node:fs';
 import * as path from 'node:path';
 import * as url from 'node:url';
+import stripIndent from 'common-tags/lib/stripIndent/index.js';
 
 const __filename = url.fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
 
 // Preview
 // =============================================================================
 function generatePreview() {
+  const comment = stripIndent`
+    <!--
+      This file is generated by the build/html.js script.
+      Do not edit this file directly.
+    -->
+  `;
+  const srcFile = 'index.html';
   const srcPath = path.resolve(__dirname, '..', 'docs');
-  const srcHTML = fs.readFileSync(path.resolve(srcPath, 'index.html'), 'utf8');
+  const srcHTML = fs.readFileSync(path.resolve(srcPath, srcFile), 'utf8');
+  const outFile = 'preview.html';
   const outPath = path.resolve(__dirname, '..', 'docs');
   const outHTML = srcHTML
-    // Append title
-    .replace(/(<\/title>)/g, ' (Preview)$1')
+    // Append comment
+    .replace(/(<!DOCTYPE html>)/, `${comment}\n$1`)
+    // Modify title
+    .replace(/(<\/title>)/, ' (Preview)$1')
     // Replace CDN URLs with local paths
     .replace(/\/\/cdn.jsdelivr.net\/npm\/docsify@4\//g, '/');
 
-  fs.writeFileSync(path.resolve(outPath, 'preview.html'), outHTML);
+  console.log(`\nBuilding ${outFile} in ${outPath}`);
+  fs.writeFileSync(path.resolve(outPath, outFile), outHTML);
 }
 
 generatePreview();
