🏷️ Add types for test configs

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"];

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

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

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

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

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

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

test/markdoc/individual-files/functions.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"];

test/markdoc/individual-files/nodes.ts

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

test/markdoc/individual-files/tags.ts

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

test/markdoc/individual-files/variables.ts

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

test/markdoc/mixed-patterns/functions.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"];

test/markdoc/mixed-patterns/nodes/index.ts

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

test/markdoc/mixed-patterns/tags/index.ts

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

test/markdoc/mixed-patterns/variables.ts

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

test/markdoc/no-default-export/tags.ts

@@ -1,4 +1,7 @@
+import { Config } from "@markdoc/markdoc";
+
 export const tags = {
   someTag: { render: "SomeTag" },
-};
+} satisfies Config["tags"];
+
 // No default export

test/markdoc/shared-schema/functions.ts

@@ -1,7 +1,9 @@
+import type { Config } from "@markdoc/markdoc";
+
 export default {
   testFunction: {
     transform(parameters: any[]) {
       return "TRANSFORMED: " + parameters[0];
     },
   },
-};
+} satisfies Config["functions"];

test/markdoc/shared-schema/nodes.ts

@@ -1,4 +1,6 @@
 import Markdoc from "@markdoc/markdoc";
+import type { Config } from "@markdoc/markdoc";
+
 export default {
   heading: {
     render: "h1",
@@ -8,4 +10,4 @@ export default {
     },
     children: Markdoc.nodes.heading.children,
   },
-};
+} satisfies Config["nodes"];

test/markdoc/shared-schema/tags/another-component.ts

@@ -1,5 +1,5 @@
 import { Tag } from "@markdoc/markdoc";
-import type { Config, Node } from "@markdoc/markdoc";
+import type { Config, Node, Schema } from "@markdoc/markdoc";
 
 export const anotherComponent = {
   render: "AnotherComponent",
@@ -12,4 +12,4 @@ export const anotherComponent = {
     const children = node.transformChildren(config);
     return new Tag(this.render, attributes, children);
   },
-};
+} satisfies Schema;

test/markdoc/shared-schema/tags/custom-component.ts

@@ -1,5 +1,5 @@
 import { Tag } from "@markdoc/markdoc";
-import type { Config, Node } from "@markdoc/markdoc";
+import type { Config, Node, Schema } from "@markdoc/markdoc";
 
 export const customComponent = {
   render: "CustomComponent",
@@ -12,4 +12,4 @@ export const customComponent = {
     const children = node.transformChildren(config);
     return new Tag(this.render, attributes, children);
   },
-};
+} satisfies Schema;

test/markdoc/shared-schema/tags/index.ts

@@ -1,5 +1,6 @@
 import { customComponent } from "./custom-component.ts";
 import { anotherComponent } from "./another-component.ts";
+import type { Config } from "@markdoc/markdoc";
 
 const tags = {
   "custom-component": customComponent,
@@ -9,6 +10,6 @@ const tags = {
     attributes: {},
     children: ["text"],
   },
-};
+} satisfies Config["tags"];
 
 export default tags;

test/markdoc/shared-schema/variables.ts

@@ -1,3 +1,5 @@
+import type { Config } from "@markdoc/markdoc";
+
 export default {
   testVariable: "a tested variable",
-};
+} satisfies Config["variables"];