comprehende 0.6.0 → 0.6.1

package/README.md

@@ -42,7 +42,7 @@ This tool is for preventing this cognitive surrender while trying to maintain mo
 
 `comprehende serve` and `comprehende export` share one UI and one git payload. Serve resolves refs to commit SHAs when it starts, then computes those payloads from the objects on each request. Export writes the same JSON (and image bytes) next to the UI so any static file server can host the review.
 
-`pnpm dev` and `pnpm exec` run with this package as cwd, so they only make sense when _this_ repo is the one under review. To review a different project from a checkout, `cd` into it and run `npx comprehende@0.6.0` (or `node /path/to/comprehende/dist/cli/main.js` after `pnpm build`).
+`pnpm dev` and `pnpm exec` run with this package as cwd, so they only make sense when _this_ repo is the one under review. To review a different project from a checkout, `cd` into it and run `npx comprehende@0.6.1` (or `node /path/to/comprehende/dist/cli/main.js` after `pnpm build`).
 
 ## Release
 

package/dist/api/shiki-langs.js

@@ -0,0 +1,138 @@
+import { readFile, rm } from "node:fs/promises";
+import { join } from "node:path";
+export const SHIKI_LANGS_FILE = "shiki-langs.json";
+const LANG_MODULE = /[/\\]@shikijs[/\\]langs[/\\]dist[/\\]([^/\\]+)\.m?js(?:\?|$)/;
+const SKIP_LANGS = new Set(["text", "ansi"]);
+export function shikiLangId(id) {
+    return id.match(LANG_MODULE)?.[1];
+}
+export function parseShikiLangsManifest(input) {
+    if (!isRecord(input) || input.version !== 1) {
+        return undefined;
+    }
+    const chunks = stringList(input.chunks);
+    const files = stringListMap(input.files);
+    const lookup = stringMap(input.lookup);
+    if (chunks === undefined || files === undefined || lookup === undefined) {
+        return undefined;
+    }
+    return { version: 1, chunks, files, lookup };
+}
+export function highlightLangFromPath(path, lookup) {
+    const fileName = path.split(/[/\\]/).pop() ?? path;
+    if (lookup[fileName] !== undefined) {
+        return lookup[fileName];
+    }
+    const compound = fileName.match(/\.([^/\\]+\.[^/\\]+)$/)?.[1];
+    if (compound !== undefined && lookup[compound] !== undefined) {
+        return lookup[compound];
+    }
+    const simple = fileName.match(/\.([^.]+)$/)?.[1] ?? "";
+    return lookup[simple];
+}
+export function highlightLangsForPaths(paths, lookup) {
+    const langs = new Set();
+    for (const path of paths) {
+        const lang = highlightLangFromPath(path, lookup);
+        if (lang !== undefined && !SKIP_LANGS.has(lang)) {
+            langs.add(lang);
+        }
+    }
+    return [...langs];
+}
+export function highlightPathsFromFiles(files) {
+    const paths = [];
+    for (const file of files) {
+        paths.push(file.path);
+        if (file.oldPath !== undefined) {
+            paths.push(file.oldPath);
+        }
+    }
+    return paths;
+}
+export function chunksToKeep(manifest, langs) {
+    const keep = new Set();
+    for (const lang of langs) {
+        const files = manifest.files[lang];
+        if (files === undefined) {
+            return undefined;
+        }
+        for (const file of files) {
+            keep.add(file);
+        }
+    }
+    return [...keep];
+}
+export async function pruneUnusedHighlighterChunks(outDir, paths) {
+    const manifest = await loadManifest(join(outDir, SHIKI_LANGS_FILE));
+    if (manifest === undefined) {
+        return [];
+    }
+    const langs = highlightLangsForPaths(paths, manifest.lookup);
+    const keep = chunksToKeep(manifest, langs);
+    if (keep === undefined) {
+        return [];
+    }
+    const keepSet = new Set(keep);
+    const removed = [];
+    for (const file of manifest.chunks) {
+        if (keepSet.has(file)) {
+            continue;
+        }
+        await rm(join(outDir, file), { force: true });
+        await rm(join(outDir, `${file}.map`), { force: true });
+        removed.push(file);
+    }
+    return removed;
+}
+async function loadManifest(path) {
+    let text;
+    try {
+        text = await readFile(path, "utf8");
+    }
+    catch {
+        return undefined;
+    }
+    try {
+        return parseShikiLangsManifest(JSON.parse(text));
+    }
+    catch {
+        return undefined;
+    }
+}
+function isRecord(value) {
+    return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+function stringList(value) {
+    if (!Array.isArray(value) || value.some((item) => typeof item !== "string")) {
+        return undefined;
+    }
+    return value;
+}
+function stringMap(value) {
+    if (!isRecord(value)) {
+        return undefined;
+    }
+    const out = {};
+    for (const [key, item] of Object.entries(value)) {
+        if (typeof item !== "string") {
+            return undefined;
+        }
+        out[key] = item;
+    }
+    return out;
+}
+function stringListMap(value) {
+    if (!isRecord(value)) {
+        return undefined;
+    }
+    const out = {};
+    for (const [key, item] of Object.entries(value)) {
+        const list = stringList(item);
+        if (list === undefined) {
+            return undefined;
+        }
+        out[key] = list;
+    }
+    return out;
+}

package/dist/api/snapshot.js

@@ -4,6 +4,7 @@ import { dirname, join, resolve } from "node:path";
 import { findPackageRoot } from "../package-root.js";
 import { isUnavailableSnapshot, listResources, openReview, renderResource, snapshotJson, } from "./live.js";
 import { apiFsRel } from "./paths.js";
+import { highlightPathsFromFiles, pruneUnusedHighlighterChunks } from "./shiki-langs.js";
 export async function exportStaticSite(opts) {
     const outDir = resolve(opts.outDir);
     const uiRoot = opts.uiRoot ?? join(findPackageRoot(), "dist/ui");
@@ -41,5 +42,6 @@ export async function exportStaticSite(opts) {
         }
         apiFiles.push(rel);
     }
+    await pruneUnusedHighlighterChunks(outDir, highlightPathsFromFiles(ctx.files));
     return { outDir, apiFiles };
 }

package/dist/cli/args.js

@@ -14,7 +14,8 @@ Commands:
             Serve the local UI on 127.0.0.1 (pins commit SHAs at start)
 
   export    --data <review.json> --out <dir>
-            Write a static site (same UI + frozen git payloads). No server after that.
+            Write a static site (same UI + frozen git payloads). Highlighters only
+            for languages in the review. No server after that.
 
 Options:
   --base <ref>     Base ref (default: origin/HEAD or main/master)