starlight-cannoli-plugins 2.11.0 → 2.12.0

package/README.md

@@ -144,7 +144,7 @@ dvisvgm --version
 - `svgOutputDir` (required): Directory where compiled SVG files are written. Must be inside `public/` so Astro serves them as static assets.
 - `removeOrphanedSvgs` (optional, default: `false`): When `true`, SVG files that are no longer referenced by any `tex compile` block are deleted automatically. In dev mode, stale SVGs are removed immediately when a block is edited. On build, any remaining orphans are swept at the end.
 - `texInputDirs` (optional): Directories added to the TeX input search path (`TEXINPUTS`), allowing `\input{}` and `\include{}` to resolve files from your project. Use a trailing `/` to search only that directory, or `//` to search it recursively. Multiple directories are supported.
-- `tempOutputDir` (optional): When set, a JPEG copy of each compiled diagram is written to this directory, mirroring the folder structure of `src/content/docs/`. The filename format is `<originating-file>--<line-number>.jpg` (e.g. `tex-test.md--11.jpg`). Useful for previewing or post-processing diagrams outside the browser. JPEGs are deleted automatically when their corresponding block fails compilation or is removed. SVG output is unaffected — the JPEG is complementary.
+- `tempOutputDir` (optional): When set, a JPEG copy of each compiled diagram is written to this directory, mirroring the folder structure of `src/content/docs/`. Only blocks that carry a `blockid=<n>` meta tag produce a JPEG — blocks without it are ignored. The filename format is `<originating-file>--<blockid>--<hash>.jpg` (e.g. `tex-test.md--5--abc123.jpg`). JPEGs are deleted automatically when their block is removed, its `blockid` changes, or its content changes. SVG output is unaffected — the JPEG is complementary and intended for local inspection.
 
 ```ts
 astroLatexCompile({

package/dist/{chunk-JIURY757.js → chunk-G2PJENXJ.js}

@@ -190,13 +190,13 @@ function execProcess(command, args, options) {
 
 // src/plugins/astro-latex-compile/utils.ts
 var CONTENT_ROOT = "src/content/docs/";
-function computeJpgPath(tempOutputDir, filePath, lineNumber) {
+function computeJpgPath(tempOutputDir, filePath, blockId, hash) {
   const normalized = filePath.replace(/\\/g, "/");
   const idx = normalized.indexOf(CONTENT_ROOT);
   const relativePath = idx !== -1 ? normalized.slice(idx + CONTENT_ROOT.length) : basename(normalized);
   const dir = dirname(relativePath);
   const filename = basename(relativePath);
-  const jpgFilename = `${filename}--${lineNumber}.jpg`;
+  const jpgFilename = `${filename}--${blockId}--${hash}.jpg`;
   const base = resolve(tempOutputDir);
   return dir === "." ? join(base, jpgFilename) : join(base, dir, jpgFilename);
 }
@@ -204,6 +204,57 @@ async function writeJpgFromSvg(svgPath, jpgPath) {
   mkdirSync(dirname(jpgPath), { recursive: true });
   await sharp(svgPath).flatten({ background: { r: 255, g: 255, b: 255 } }).jpeg({ quality: 90 }).toFile(jpgPath);
 }
+function stripAnsi(text) {
+  return text.replace(/\x1b\[[0-9;]*m/g, "");
+}
+function escapeXml(text) {
+  return text.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;");
+}
+function wrapText(text, maxChars) {
+  const lines = [];
+  for (const raw of text.split("\n")) {
+    if (raw.length <= maxChars) {
+      lines.push(raw);
+    } else {
+      let remaining = raw;
+      while (remaining.length > maxChars) {
+        lines.push(remaining.slice(0, maxChars));
+        remaining = remaining.slice(maxChars);
+      }
+      if (remaining) lines.push(remaining);
+    }
+  }
+  return lines;
+}
+async function writeJpgError(jpgPath, header, errorText) {
+  const MAX_LINES = 40;
+  const clean = stripAnsi(errorText);
+  const sourceIdx = clean.indexOf("LaTeX source:");
+  const summary = (sourceIdx !== -1 ? clean.slice(0, sourceIdx) : clean).trimEnd();
+  let lines = wrapText(summary, 90);
+  if (lines.length > MAX_LINES) {
+    lines = lines.slice(0, MAX_LINES);
+    lines.push("...");
+  }
+  const fontSize = 13;
+  const lineHeight = 18;
+  const padding = 20;
+  const headerHeight = 55;
+  const width = 800;
+  const height = padding * 2 + headerHeight + lines.length * lineHeight;
+  const textLines = lines.map(
+    (line, i) => `<text x="${padding}" y="${padding + headerHeight + i * lineHeight}" font-family="monospace" font-size="${fontSize}" fill="#333333">${escapeXml(line)}</text>`
+  ).join("\n  ");
+  const svg = `<svg xmlns="http://www.w3.org/2000/svg" width="${width}" height="${height}">
+  <rect width="${width}" height="${height}" fill="white"/>
+  <rect x="0" y="0" width="${width}" height="4" fill="#cc0000"/>
+  <text x="${padding}" y="${padding + 20}" font-family="monospace" font-size="16" font-weight="bold" fill="#cc0000">LaTeX Compilation Error</text>
+  <text x="${padding}" y="${padding + 40}" font-family="monospace" font-size="12" fill="#666666">${escapeXml(header)}</text>
+  ${textLines}
+</svg>`;
+  mkdirSync(dirname(jpgPath), { recursive: true });
+  await sharp(Buffer.from(svg)).flatten({ background: { r: 255, g: 255, b: 255 } }).jpeg({ quality: 90 }).toFile(jpgPath);
+}
 function hashLatexCode(code) {
   const normalized = code.split("\n").map((line) => line.trim()).filter((line) => !line.startsWith("%")).filter(Boolean).join("\n").trim();
   return createHash("md5").update(normalized).digest("hex").slice(0, 16);
@@ -315,9 +366,10 @@ function remarkLatexCompile(options) {
     const filePath = file.path || "unknown";
     const results = await Promise.all(
       nodes.map(async ({ node, index, parent }) => {
-        const lineNumber = node.position?.start.line;
-        const lineNumberStr = lineNumber ?? "?";
-        const jpgPath = options.tempOutputDir && lineNumber !== void 0 ? computeJpgPath(options.tempOutputDir, filePath, lineNumber) : null;
+        const lineNumberStr = node.position?.start.line ?? "?";
+        const blockId = new MetaOptions(node.meta ?? "").getInteger("blockid");
+        const contentHash = hashLatexCode(node.value);
+        const canWriteJpg = !!options.tempOutputDir && blockId !== void 0;
         try {
           const result = await compileLatexToSvg(
             node.value,
@@ -330,6 +382,7 @@ function remarkLatexCompile(options) {
             );
           }
           options._referencedHashes?.add(result.hash);
+          const jpgPath = canWriteJpg ? computeJpgPath(options.tempOutputDir, filePath, blockId, contentHash) : null;
           if (jpgPath && !existsSync2(jpgPath)) {
             await writeJpgFromSvg(result.svgPath, jpgPath);
             console.log(
@@ -352,8 +405,13 @@ function remarkLatexCompile(options) {
             `[remark-latex-compile] ${filePath}:${lineNumberStr}
 ${details}`
           );
-          if (jpgPath) {
-            await rm(jpgPath, { force: true });
+          const jpgPath = canWriteJpg ? computeJpgPath(options.tempOutputDir, filePath, blockId, `${contentHash}--error`) : null;
+          if (jpgPath && !existsSync2(jpgPath)) {
+            await writeJpgError(
+              jpgPath,
+              `${filePath}:${lineNumberStr}`,
+              errorMsg
+            );
           }
           return {
             index,
@@ -361,7 +419,7 @@ ${details}`
             result: null,
             error: err,
             hash: null,
-            jpgPath: null
+            jpgPath
           };
         }
       })

package/dist/index.js

@@ -9,7 +9,7 @@ import {
 } from "./chunk-3UMY7T6G.js";
 import {
   remarkLatexCompile
-} from "./chunk-JIURY757.js";
+} from "./chunk-G2PJENXJ.js";
 import {
   astroNormalizePaths
 } from "./chunk-TLOFSB33.js";

package/dist/plugins/astro-latex-compile.d.ts

@@ -31,11 +31,11 @@ interface RemarkLatexCompileOptions {
     texInputDirs?: string[];
     /**
      * When set, a JPEG copy of each compiled diagram is written here, mirroring
-     * the folder structure of `src/content/docs/`. Filename format:
-     * `<originating-file>--<line-number>.jpg`.
-     * JPEGs are deleted automatically when their corresponding block fails
-     * compilation or is removed. The purpose of this directory is not for publishing these to the public,
-     * but to provide an easier way to locally inspect the generated diagrams.
+     * the folder structure of `src/content/docs/`. Only blocks that carry a
+     * `blockid=<n>` meta tag produce a JPEG. Filename format:
+     * `<originating-file>--<blockid>--<hash>.jpg`.
+     * JPEGs are deleted automatically when their block is removed or its content
+     * changes. Intended for local inspection, not for publishing.
      */
     tempOutputDir?: string;
     /**

package/dist/plugins/astro-latex-compile.js

@@ -1,7 +1,7 @@
 import {
   compileLatexToSvg,
   remarkLatexCompile
-} from "../chunk-JIURY757.js";
+} from "../chunk-G2PJENXJ.js";
 import "../chunk-4VNS5WPM.js";
 export {
   compileLatexToSvg,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "starlight-cannoli-plugins",
   "type": "module",
-  "version": "2.11.0",
+  "version": "2.12.0",
   "description": "Starlight plugins for automatic sidebar generation and link validation",
   "license": "ISC",
   "main": "./dist/index.js",