feat: Generate a JSON index

Author: YDX-2147483647

main.typ

@@ -2025,7 +2025,7 @@ $ integral f dif x $
 
 #set heading(numbering: none)
 
-= #bbl(en: [Addendum], zh: [附录])
+= #bbl(en: [Addendum], zh: [附录]) <addendum>
 
 == #bbl(en: [List of sites], zh: [站点列表])
 

package.json

@@ -11,10 +11,11 @@
         "glob-watcher": "^6.0.0"
     },
     "scripts": {
-        "build": "tsc && vite build && node --experimental-strip-types scripts/build.ts",
+        "build": "tsc && vite build && node --experimental-strip-types scripts/build.ts && pnpm generate-json-index",
         "dev": "node --experimental-strip-types scripts/dev.ts",
         "preview": "vite preview --base=/clreq/",
         "check-issues": "node --experimental-strip-types scripts/check_issues.ts",
+        "generate-json-index": "node --experimental-strip-types scripts/generate-json-index.ts > dist/index.json",
         "patch-htmldiff": "node --experimental-strip-types scripts/patch-htmldiff.ts"
     },
     "devDependencies": {

scripts/check_issues.ts

@@ -23,11 +23,11 @@ interface RepoNum {
   repo: string;
   num: string;
 }
-interface IssueMeta extends RepoNum {
+export interface IssueMeta extends RepoNum {
   note: string;
   closed: boolean;
 }
-interface PullMeta extends RepoNum {
+export interface PullMeta extends RepoNum {
   merged: boolean;
   rejected: boolean;
 }

scripts/generate-json-index.ts

@@ -0,0 +1,231 @@
+/**
+ * Generate a JSON index and print to stdout.
+ */
+
+import assert from "node:assert";
+
+import type { IssueMeta, PullMeta } from "./check_issues.ts";
+import { extraArgs } from "./config.ts";
+import { typst } from "./typst.ts";
+
+type Priority = "ok" | "advanced" | "basic" | "broken" | "tbd" | "na";
+type GeneralPriority = Priority | "(inherited)";
+
+// Parsed types
+
+type Babel = { en: string; "zh-Hans": string };
+
+type Heading = {
+  level: number;
+  body: Babel;
+  label?: string;
+};
+type Section = {
+  title: Babel;
+  level: number;
+  label?: string;
+  priority: GeneralPriority;
+  links: (
+    | ({ type: "issue" } & IssueMeta)
+    | ({ type: "pull" } & PullMeta)
+    | ({ type: "workaround" } & WorkaroundMeta)
+  )[];
+};
+
+// Typst elements
+
+type HeadingElem = {
+  func: "heading";
+  level: number;
+  body: ContentElem;
+  label?: string;
+};
+type SpaceElem = { func: "space" };
+type TextElem = { func: "text"; text: string };
+type RawElem = { func: "raw"; text: string };
+type Sequence<T> = {
+  func: "sequence";
+  children: T[];
+};
+/** Same as `Sequence<ContentElem>`, but without self-reference. */
+type SequenceElem = {
+  func: "sequence";
+  children: ContentElem[];
+};
+type StyledElem = {
+  func: "styled";
+  child: ContentElem;
+  styles: "..";
+};
+/**
+ * The body of a heading element.
+ *
+ * Only relevant fields and combinations are included.
+ */
+type ContentElem =
+  | StyledElem
+  | SequenceElem
+  | SpaceElem
+  | TextElem
+  | {
+    func: "elem";
+    tag: "span";
+    attrs: { lang: "en" | "zh-Hans" } | { style: string };
+    body: TextElem | Sequence<TextElem | RawElem | SpaceElem>;
+  };
+
+type WorkaroundMeta = {
+  dest: string;
+  note: string | null;
+};
+
+function* _parseContent(
+  it: ContentElem | RawElem | Sequence<TextElem | RawElem | SpaceElem>,
+): Generator<
+  | { action: "pop"; text: string }
+  | { action: "switch-lang"; next: "en" | "zh-Hans" }
+> {
+  const pop = (text: string) => ({ action: "pop" as const, text });
+  const switchLang = (lang: "en" | "zh-Hans") => ({
+    action: "switch-lang" as const,
+    next: lang,
+  });
+
+  switch (it.func) {
+    // Structural elements
+    case "sequence":
+      for (const child of it.children) {
+        yield* _parseContent(child);
+      }
+      break;
+    case "styled":
+      yield* _parseContent(it.child);
+      break;
+
+    // Basic elements
+    case "text":
+      yield pop(it.text);
+      break;
+    case "space":
+      yield pop(" ");
+      break;
+    case "raw":
+      yield pop(`“${it.text}”`);
+      break;
+
+    // HTML elements
+    case "elem":
+      if ("lang" in it.attrs) {
+        const lang = it.attrs.lang;
+        assert(
+          lang === "en" || lang === "zh-Hans",
+          `Invalid language: ${lang} in ${JSON.stringify(it)}`,
+        );
+        yield switchLang(lang);
+      }
+      yield* _parseContent(it.body);
+      break;
+
+    default:
+      throw new Error(`Reached unexpected element: ${JSON.stringify(it)}`);
+  }
+}
+
+function parseHeading(heading: HeadingElem): Heading {
+  const { level, body, label } = heading;
+  const parser = _parseContent(body);
+
+  const parsed = { en: "", "zh-Hans": "" };
+  let lang: keyof typeof parsed = "en";
+
+  for (const p of parser) {
+    switch (p.action) {
+      case "pop":
+        parsed[lang] += p.text;
+        break;
+      case "switch-lang":
+        // Remove the space added by `babel` between languages.
+        parsed[lang] = parsed[lang].trim();
+        lang = p.next;
+        break;
+      default:
+        throw new Error(`Invalid action: ${JSON.stringify(p)}`);
+    }
+  }
+
+  return { level, body: parsed, label };
+}
+
+const data = (JSON.parse(
+  await typst([
+    "query",
+    "index.typ", // This cannot be main.typ, or there will be an additional heading (`outline`'s title).
+    [
+      "selector.or(heading, <priority>, <issue>, <pull>, <workaround>)",
+      ".after(outline)",
+      ".before(<addendum>, inclusive: false)",
+    ].join(""),
+    "--target=html",
+    ...extraArgs.pre,
+  ]),
+) as (
+  | HeadingElem
+  | (
+    & { func: "metadata" }
+    & (
+      | { value: Priority; label: "<priority>" }
+      | { value: IssueMeta; label: "<issue>" }
+      | { value: PullMeta; label: "<pull>" }
+      | { value: WorkaroundMeta; label: "<workaround>" }
+    )
+  )
+)[]).map((el) => {
+  if (el.func === "heading") {
+    return parseHeading(el);
+  }
+  return el;
+});
+
+const sections: Section[] = [];
+
+for (const it of data) {
+  if ("level" in it) {
+    const { body: title, level, label } = it;
+    sections.push({ title, level, label, priority: "(inherited)", links: [] });
+  } else {
+    const last = sections.at(-1);
+    assert(
+      last !== undefined,
+      `Metadata describe the heading before them, but there is no heading before this one: ${
+        JSON.stringify(it)
+      }`,
+    );
+
+    switch (it.label) {
+      case "<priority>":
+        assert(
+          last.priority === "(inherited)",
+          `There are multiple priority levels marking the same section: heading = ${
+            JSON.stringify(last.title)
+          }, priority = [${last.priority}, ${it.value}, …]`,
+        );
+        last.priority = it.value;
+        break;
+
+      case "<issue>":
+        last.links.push({ type: "issue", ...it.value });
+        break;
+      case "<pull>":
+        last.links.push({ type: "pull", ...it.value });
+        break;
+      case "<workaround>":
+        last.links.push({ type: "workaround", ...it.value });
+        break;
+
+      default:
+        throw new Error(`Reached unexpected element: ${JSON.stringify(it)}`);
+    }
+  }
+}
+
+console.log(JSON.stringify({ version: "2025-11-21", sections }, null, 2));

typ/prioritization.typ

@@ -86,6 +86,7 @@
       data-priority-level: level,
     ),
   )
+  [#metadata(level)<priority>]
 }
 
 /// Priority levels

typ/util.typ

@@ -51,7 +51,7 @@
       if anchor != "" { [~(comment)] }
     } else { [~(#note)] }
   })
-  [#metadata((repo: repo, num: num, note: repr(note), closed: closed)) <issue>]
+  [#metadata((repo: repo, num: num, note: repr(note), closed: closed))<issue>]
 }
 
 /// Link to a GitHub pull request
@@ -73,7 +73,7 @@
     if merged { icon.git-merge } else if rejected { icon.git-pull-request-closed } else { icon.git-pull-request }
     repo-num
   })
-  [#metadata((repo: repo, num: num, merged: merged, rejected: rejected)) <pull>]
+  [#metadata((repo: repo, num: num, merged: merged, rejected: rejected))<pull>]
 }
 
 /// Link to a workaround
@@ -101,6 +101,7 @@
     icon.light-bulb
     body
   })
+  [#metadata((dest: dest, note: note))<workaround>]
 }
 
 /// A formatted description of the Unicode character for a given codepoint