✅ Add test for heading opt-in

Author: CollierCZ

test/__snapshots__/options.test.ts.snap

@@ -49,6 +49,28 @@ exports[`File extensions > works when passed the default extension 1`] = `
 <article><h1>This is some basic Markdoc</h1><p>With a paragraph.</p><p>Some text <strong>in bold</strong> and <em>in italic</em>.</p><p>And a <a href="https://example.com">link</a>.</p><h2>More fancy stuff</h2><p>Some <code>&lt;p&gt;</code> inline code.</p><p>And a code block:</p><pre data-language="javascript"><code>&lcub;&lcub;% test %&rcub;&rcub;</code></pre><p>And even a table with a nested list:</p><table><thead><tr><th>Table header 1</th><th>Table header 2</th></tr></thead><tbody><tr><td><ul><li>Row 1 Cell 1 Item 1</li><li>Row 1 Cell 1 Item 2</li></ul></td><td>Row 1 Cell 2</td></tr><tr><td>Row 2 Cell 1</td><td>Row 2 cell 2</td></tr></tbody></table></article>"
 `;
 
+exports[`Headings > adds IDs and exports headings when passed as an option 1`] = `
+"<script module>
+	export const slug = "test";
+	export const headings = [{"level":1,"title":"This is some basic Markdoc","id":"this-is-some-basic-markdoc"},{"level":2,"title":"More fancy stuff","id":"more-fancy-stuff"}];
+</script>
+<article><h1 id="this-is-some-basic-markdoc">This is some basic Markdoc</h1><p>With a paragraph.</p><p>Some text <strong>in bold</strong> and <em>in italic</em>.</p><p>And a <a href="https://example.com">link</a>.</p><h2 id="more-fancy-stuff">More fancy stuff</h2><p>Some <code>&lt;p&gt;</code> inline code.</p><p>And a code block:</p><pre data-language="javascript"><code>&lcub;&lcub;% test %&rcub;&rcub;</code></pre><p>And even a table with a nested list:</p><table><thead><tr><th>Table header 1</th><th>Table header 2</th></tr></thead><tbody><tr><td><ul><li>Row 1 Cell 1 Item 1</li><li>Row 1 Cell 1 Item 2</li></ul></td><td>Row 1 Cell 2</td></tr><tr><td>Row 2 Cell 1</td><td>Row 2 cell 2</td></tr></tbody></table></article>"
+`;
+
+exports[`Headings > doesn't add IDs or export headings by default 1`] = `
+"<script module>
+	export const slug = "test";
+</script>
+<article><h1>This is some basic Markdoc</h1><p>With a paragraph.</p><p>Some text <strong>in bold</strong> and <em>in italic</em>.</p><p>And a <a href="https://example.com">link</a>.</p><h2>More fancy stuff</h2><p>Some <code>&lt;p&gt;</code> inline code.</p><p>And a code block:</p><pre data-language="javascript"><code>&lcub;&lcub;% test %&rcub;&rcub;</code></pre><p>And even a table with a nested list:</p><table><thead><tr><th>Table header 1</th><th>Table header 2</th></tr></thead><tbody><tr><td><ul><li>Row 1 Cell 1 Item 1</li><li>Row 1 Cell 1 Item 2</li></ul></td><td>Row 1 Cell 2</td></tr><tr><td>Row 2 Cell 1</td><td>Row 2 cell 2</td></tr></tbody></table></article>"
+`;
+
+exports[`Headings > doesn't add IDs or export headings when passed false 1`] = `
+"<script module>
+	export const slug = "test";
+</script>
+<article><h1>This is some basic Markdoc</h1><p>With a paragraph.</p><p>Some text <strong>in bold</strong> and <em>in italic</em>.</p><p>And a <a href="https://example.com">link</a>.</p><h2>More fancy stuff</h2><p>Some <code>&lt;p&gt;</code> inline code.</p><p>And a code block:</p><pre data-language="javascript"><code>&lcub;&lcub;% test %&rcub;&rcub;</code></pre><p>And even a table with a nested list:</p><table><thead><tr><th>Table header 1</th><th>Table header 2</th></tr></thead><tbody><tr><td><ul><li>Row 1 Cell 1 Item 1</li><li>Row 1 Cell 1 Item 2</li></ul></td><td>Row 1 Cell 2</td></tr><tr><td>Row 2 Cell 1</td><td>Row 2 cell 2</td></tr></tbody></table></article>"
+`;
+
 exports[`Layout > properly puts the parsed file in a layout when passed as an option 1`] = `
 "<script module>
 	export const slug = "test";

test/options.test.ts

@@ -119,6 +119,39 @@ describe("File extensions", () => {
   });
 });
 
+describe("Headings", () => {
+  it("doesn't add IDs or export headings by default", async () => {
+    const result = (await markdocPreprocess().markup!({
+      content: basicMarkdoc,
+      filename: "test.md",
+    })) as Processed;
+
+    expect(result.code).toMatchSnapshot();
+  });
+
+  it("adds IDs and exports headings when passed as an option", async () => {
+    const result = (await markdocPreprocess({
+      headingIds: true,
+    } as Options).markup!({
+      content: basicMarkdoc,
+      filename: "test.md",
+    })) as Processed;
+
+    expect(result.code).toMatchSnapshot();
+  });
+
+  it("doesn't add IDs or export headings when passed false", async () => {
+    const result = (await markdocPreprocess({
+      headingIds: false,
+    } as Options).markup!({
+      content: basicMarkdoc,
+      filename: "test.md",
+    })) as Processed;
+
+    expect(result.code).toMatchSnapshot();
+  });
+});
+
 describe("Layout", () => {
   it("properly puts the parsed file in a layout when passed as an option", async () => {
     const layoutOptions = {