feat: improve TOC generator

netspective-labs · Jan 23, 2024 · 211d289 · 211d289
1 parent 8878797
commit 211d289
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 19 deletions.
diff --git a/lib/universal/markdown.ts b/lib/universal/markdown.ts
@@ -2,7 +2,7 @@ import * as ws from "./whitespace.ts";
 
 export function typicalMarkdownTags(options: {
   readonly toc?: {
-    heading: (text: string, level: number) => void;
+    heading: (text: string, level: number) => string;
   };
 } = {}) {
   const wrap = (wrapper: string, str: string) => `${wrapper}${str}${wrapper}`;
@@ -66,9 +66,9 @@ export function typicalMarkdownTags(options: {
   const bold = (str: string) => wrap("**", str);
 
   const heading = (level: number, str: string) => {
-    const markdown = spaces(join(times(always("#"), level)), str);
-    options?.toc?.heading(str, level);
-    return markdown;
+    // in case table of contents rewriting is required, do it now
+    const rewrittenText = options?.toc?.heading(str, level);
+    return spaces(join(times(always("#"), level)), rewrittenText ?? str);
   };
 
   const h1 = (str: string) => heading(1, str);
@@ -149,16 +149,16 @@ export class MarkdownDocument<
     readonly tags: Tags = typicalMarkdownTags({
       toc: {
         heading: (text, level) => {
-          if (this.tableOfContents) {
-            const anchorName = this.tags.anchorName(text);
-            this.tableOfContents?.headings.push({
-              heading: text,
-              level,
-              anchorName,
-              anchorText: `<a name="${anchorName}">${text}</a>`,
-              tocItemText: `[${text}](#${anchorName})`,
-            });
-          }
+          const anchorName = this.tags.anchorName(text);
+          const state = {
+            heading: text,
+            level,
+            anchorName,
+            anchorText: text,
+            tocItemText: `[${text}](#${anchorName})`,
+          };
+          this.tableOfContents.headings.push(state);
+          return state.anchorText;
         },
       },
     }) as Tags,

diff --git a/lib/universal/markdown_test.ts b/lib/universal/markdown_test.ts
@@ -1,7 +1,11 @@
 import { testingAsserts as ta } from "../../deps-test.ts";
 import * as mod from "./markdown.ts";
 
-const golden1 = `# Markdown test
+const golden1 = `- [Markdown test](#markdown-test)
+  - [Second level heading](#second-level-heading)
+    - [Third level heading](#third-level-heading)
+
+# Markdown test
 
 This is a test document which should prepare **some bold text** and ***some italic text***.
 
@@ -43,28 +47,28 @@ Deno.test("Generated Markdown", () => {
 
     ${t.table(["h-column1", "h-column2"], ["r1-column1", "r1-column2"])}`;
 
-  ta.assertEquals(md.markdownText(), golden1);
+  ta.assertEquals(md.markdownText(() => md.tocMarkdownLists() + "\n"), golden1);
   ta.assertEquals(md.tableOfContents, {
     headings: [
       {
         level: 1,
         heading: "Markdown test",
         anchorName: "markdown-test",
-        anchorText: `<a name="markdown-test">Markdown test</a>`,
+        anchorText: `Markdown test`,
         tocItemText: `[Markdown test](#markdown-test)`,
       },
       {
         level: 2,
         heading: "Second level heading",
         anchorName: "second-level-heading",
-        anchorText: `<a name="second-level-heading">Second level heading</a>`,
+        anchorText: `Second level heading`,
         tocItemText: `[Second level heading](#second-level-heading)`,
       },
       {
         level: 3,
         heading: "Third level heading",
         anchorName: "third-level-heading",
-        anchorText: `<a name="third-level-heading">Third level heading</a>`,
+        anchorText: `Third level heading`,
         tocItemText: `[Third level heading](#third-level-heading)`,
       },
     ],