Skip to content

Commit 5e491c0

Browse files
committed
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`.
1 parent cf2039f commit 5e491c0

File tree

23 files changed

+51
-24
lines changed

23 files changed

+51
-24
lines changed

test/markdoc/file-preference/tags.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
/** @type {import('@markdoc/markdoc').Config['tags']} */
12
export default {
23
preferenceTag: {
34
render: "JavaScriptTag",
Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1+
import { Config } from "@markdoc/markdoc";
2+
13
export default {
24
preferenceTag: {
35
render: "TypeScriptTag",
46
attributes: {},
57
children: ["text"],
68
},
7-
};
9+
} satisfies Config["tags"];
Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1+
import { Config } from "@markdoc/markdoc";
2+
13
export default {
24
priorityTag: {
35
render: "FileTag",
46
attributes: {},
57
children: ["text"],
68
},
7-
};
9+
} satisfies Config["tags"];
Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1+
import { Config } from "@markdoc/markdoc";
2+
13
export default {
24
priorityTag: {
35
render: "DirectoryTag",
46
attributes: {},
57
children: ["text"],
68
},
7-
};
9+
} satisfies Config["tags"];
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1+
import { Config } from "@markdoc/markdoc";
12
import functions from "../../shared-schema/functions.ts";
23

34
export default {
45
testFunction: functions.testFunction,
5-
};
6+
} satisfies Config["functions"];
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1+
import { Config } from "@markdoc/markdoc";
12
import nodes from "../../shared-schema/nodes.ts";
23

34
export default {
45
heading: nodes.heading,
5-
};
6+
} satisfies Config["nodes"];
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1+
import { Config } from "@markdoc/markdoc";
12
import tags from "../../shared-schema/tags/index.ts";
23

34
export default {
45
testTag: tags.testTag,
5-
};
6+
} satisfies Config["tags"];
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1+
import { Config } from "@markdoc/markdoc";
12
import variables from "../../shared-schema/variables.ts";
23

34
export default {
45
testVariable: variables.testVariable,
5-
};
6+
} satisfies Config["variables"];
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1+
import { Config } from "@markdoc/markdoc";
12
import functions from "../shared-schema/functions.ts";
23

34
export default {
45
testFunction: functions.testFunction,
5-
};
6+
} satisfies Config["functions"];
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1+
import { Config } from "@markdoc/markdoc";
12
import nodes from "../shared-schema/nodes.ts";
23

34
export default {
45
heading: nodes.heading,
5-
};
6+
} satisfies Config["nodes"];

0 commit comments

Comments
 (0)