Speed up recompilation by using separate navigation and search databases

Author: deimonn

Makefile

@@ -69,16 +69,17 @@ void_guides_sources = \
 void_guides_outputs = \
 	$(patsubst src/submodules/void-guides/%.md,dist/void-guides/%.html,$(void_guides_sources))
 
-dist/void-guides/db.json: compile-db.js $(void_guides_sources)
-	mkdir -p dist/void-guides
+dist/void-guides/search-db.json obj/void-guides/nav-db.json: \
+    compile-db.js $(void_guides_sources)
+	mkdir -p dist/void-guides obj/void-guides
 	node compile-db.js \
 		void-guides void-guides/ \
 		$(sort $(void_guides_sources))
 
 dist/void-guides/%.html: \
     src/templates/docs.html src/main.html \
     src/submodules/void-guides/%.md src/submodules/void-guides/categories.json \
-    compile-markdown.js obj/oro-theme.json dist/void-guides/db.json
+    compile-markdown.js obj/oro-theme.json obj/void-guides/nav-db.json
 
 	# Create directories.
 	mkdir -p "$$(dirname $(subst dist/void-guides/,obj/void-guides/,$@))"
@@ -104,7 +105,7 @@ dist/void-guides/%.html: \
 	envsubst '$$PAGE_TITLE,$$DOCS_REPO,$$DOCS_MAINHTML,$$DOCS_NAVHTML,$$DOCS_TOCHTML' \
 		< $(patsubst dist/void-guides/%.html,obj/void-guides/%.in.html,$@) > $@
 
-targets += $(void_guides_outputs)
+targets += dist/void-guides/search-db.json $(void_guides_outputs)
 
 # *───────*
 # │ Phony

compile-db.js

@@ -19,22 +19,26 @@ function readFile(path) {
     return fs.readFileSync(path, { encoding: "utf-8" });
 }
 
-// Parse inputs.
-const db = [];
+// Variables and constants.
+let search = [];
+let nav = [];
 
 const repo = process.argv[2];
 const prefix = process.argv[3];
 
-const output = `dist/${repo}/db.json`;
+const searchOutput = `dist/${repo}/search-db.json`;
+const navOutput = `obj/${repo}/nav-db.json`;
+
+// Parse inputs.
 const inputs = process.argv.slice(4);
 
 for (const input of inputs) {
-    // Initialize entry and push it to database.
+    // Initialize entry and push it to search database.
     const entry = {
         path: input
     };
 
-    db.push(entry);
+    search.push(entry);
 
     // Generate link.
     const href = input.substring(15 + prefix.length, input.length - 3);
@@ -50,7 +54,27 @@ for (const input of inputs) {
     } else {
         entry.title = entry.href;
     }
+
+    // Push to navigation database without the `content` field.
+    const navEntry = structuredClone(entry);
+    delete navEntry.content;
+
+    nav.push(navEntry);
 }
 
+// Stringify.
+search = JSON.stringify(search);
+nav = JSON.stringify(nav);
+
 // Write database to disk.
-fs.writeFileSync(output, JSON.stringify(db));
+fs.writeFileSync(searchOutput, search);
+
+// Write navigation data to disk only if there were changes.
+if (fs.existsSync(navOutput)) {
+    const oldContent = readFile(navOutput);
+    if (oldContent !== nav) {
+        fs.writeFileSync(navOutput, nav);
+    }
+} else {
+    fs.writeFileSync(navOutput, nav);
+}

compile-markdown.js

@@ -34,7 +34,7 @@ const mainOutput = `obj/${repo}/${target}.html`;
 const navOutput = `obj/${repo}/${target}.nav.html`;
 const tocOutput = `obj/${repo}/${target}.toc.html`;
 const nameOutput = `obj/${repo}/${target}.name.txt`;
-const db = JSON.parse(readFile(`dist/${repo}/db.json`));
+const nav = JSON.parse(readFile(`obj/${repo}/nav-db.json`));
 
 // Fetch highlighter theme.
 const oroTheme = JSON.parse(readFile("obj/oro-theme.json"));
@@ -188,7 +188,7 @@ if (fs.existsSync(`src/submodules/${repo}/${prefix}categories.json`)) {
     );
 }
 
-for (const entry of db) {
+for (const entry of nav) {
     const path = entry.path;
 
     // Remove common prefix.

src/main.js

@@ -157,7 +157,7 @@ function setTheme(theme) {
             `;
 
             // Download and parse database.
-            const response = await fetch(`/${repo}/db.json`);
+            const response = await fetch(`/${repo}/search-db.json`);
             if (!response.ok) {
                 // Display error on failure.
                 navSearch.innerHTML = /* HTML */ `