🏷️ Add types for test configs (#26)

* Add types for test configs to enable auto-completion and detect API changes in future Markdoc versions

This might be especially useful to find and fix potential future breaking changes since @markdoc/markdoc still has not yet reached semver `1.0.0`.

* 🏷️ Add additional typing

---------

Co-authored-by: Samuel Plumppu <[email protected]>

Author: CollierCZ

test/heading.test.ts

@@ -14,7 +14,7 @@ describe("Headings", () => {
   it("adds IDs and exports headings even when a custom heading is included", async () => {
     const result = (await markdocPreprocess({
       headingIds: true,
-      nodes: { heading: basicHeadingNode.heading },
+      nodes: { heading: basicHeadingNode },
     } as Options).markup!({
       content: markdocWithHeadings,
       filename: "test.md",
@@ -26,7 +26,7 @@ describe("Headings", () => {
   it("adds IDs and exports headings even when the custom heading is a custom component", async () => {
     const result = (await markdocPreprocess({
       headingIds: true,
-      nodes: { heading: customComponentNode.heading },
+      nodes: { heading: customComponentNode },
     } as Options).markup!({
       content: markdocWithHeadings,
       filename: "test.md",
@@ -49,7 +49,7 @@ describe("Headings", () => {
   it("adds IDs when passed a custom slugifying function even for custom headings", async () => {
     const result = (await markdocPreprocess({
       headingIds: customSlugger,
-      nodes: { heading: basicHeadingNode.heading },
+      nodes: { heading: basicHeadingNode },
     } as Options).markup!({
       content: markdocWithHeadings,
       filename: "test.md",

test/markdoc/empty-schemas/nodes.ts

@@ -1 +1,3 @@
-export default {};
+import type { Config } from "@markdoc/markdoc";
+
+export default {} satisfies Config["nodes"];

test/markdoc/empty-schemas/tags.ts

@@ -1 +1,3 @@
-export default {};
+import type { Config } from "@markdoc/markdoc";
+
+export default {} satisfies Config["tags"];

test/markdoc/file-preference/tags.js

@@ -1,3 +1,4 @@
+/** @type {import('@markdoc/markdoc').Config['tags']} */
 export default {
   preferenceTag: {
     render: "JavaScriptTag",

test/markdoc/file-preference/tags.ts

@@ -1,7 +1,9 @@
+import { Config } from "@markdoc/markdoc";
+
 export default {
   preferenceTag: {
     render: "TypeScriptTag",
     attributes: {},
     children: ["text"],
   },
-};
+} satisfies Config["tags"];

test/markdoc/file-vs-directory/tags.ts

@@ -1,7 +1,9 @@
+import { Config } from "@markdoc/markdoc";
+
 export default {
   priorityTag: {
     render: "FileTag",
     attributes: {},
     children: ["text"],
   },
-};
+} satisfies Config["tags"];

test/markdoc/file-vs-directory/tags/index.ts

@@ -1,7 +1,9 @@
+import { Config } from "@markdoc/markdoc";
+
 export default {
   priorityTag: {
     render: "DirectoryTag",
     attributes: {},
     children: ["text"],
   },
-};
+} satisfies Config["tags"];

test/markdoc/heading-tests/basicHeading.ts

@@ -1,13 +1,12 @@
+import type { Schema } from "@markdoc/markdoc";
 import { headingNode } from "../../../src/index.ts";
 
 export default {
-  heading: {
-    render: "h1",
-    attributes: {
-      class: { type: String, default: "custom-heading" },
-      ...headingNode.attributes,
-    },
-    children: headingNode.children,
-    transform: headingNode.transform,
+  render: "h1",
+  attributes: {
+    class: { type: String, default: "custom-heading" },
+    ...headingNode.attributes,
   },
-};
+  children: headingNode.children,
+  transform: headingNode.transform,
+} satisfies Schema;

test/markdoc/heading-tests/customComponentHeading.ts

@@ -1,12 +1,11 @@
+import type { Schema } from "@markdoc/markdoc";
 import { headingNode } from "../../../src/index.ts";
 
 export default {
-  heading: {
-    render: "HeadingComponent",
-    attributes: {
-      ...headingNode.attributes,
-    },
-    children: headingNode.children,
-    transform: headingNode.transform,
+  render: "HeadingComponent",
+  attributes: {
+    ...headingNode.attributes,
   },
-};
+  children: headingNode.children,
+  transform: headingNode.transform,
+} satisfies Schema;

test/markdoc/index-directories/functions/index.ts

@@ -1,5 +1,6 @@
+import { Config } from "@markdoc/markdoc";
 import functions from "../../shared-schema/functions.ts";
 
 export default {
   testFunction: functions.testFunction,
-};
+} satisfies Config["functions"];