chore: check components are capitalized names

This commit is contained in:
bholmesdev 2023-03-02 11:24:09 -05:00
parent cbfa05f218
commit 833a88e439

View file

@ -1,6 +1,7 @@
import type { AstroInstance } from 'astro'; import type { AstroInstance } from 'astro';
import type { RenderableTreeNode } from '@markdoc/markdoc'; import type { RenderableTreeNode } from '@markdoc/markdoc';
import Markdoc from '@markdoc/markdoc'; import Markdoc from '@markdoc/markdoc';
import z from 'zod';
export type AstroNode = export type AstroNode =
| string | string
@ -19,18 +20,18 @@ export function createAstroNode(
node: RenderableTreeNode, node: RenderableTreeNode,
components: Record<string, AstroInstance['default']> = {} components: Record<string, AstroInstance['default']> = {}
): AstroNode { ): AstroNode {
components = validateComponents(components);
if (typeof node === 'string' || typeof node === 'number') { if (typeof node === 'string' || typeof node === 'number') {
return String(node); return String(node);
} else if (node === null || typeof node !== 'object' || !Markdoc.Tag.isTag(node)) { } else if (node === null || typeof node !== 'object' || !Markdoc.Tag.isTag(node)) {
return ''; return '';
} }
if (node.name in components) { if (isCapitalized(node.name) && node.name in components) {
const component = components[node.name]; const component = components[node.name];
const props = node.attributes; const props = node.attributes;
console.log({ node, component, props, components });
const children = node.children.map((child) => createAstroNode(child, components)); const children = node.children.map((child) => createAstroNode(child, components));
return { return {
@ -46,3 +47,32 @@ export function createAstroNode(
}; };
} }
} }
function validateComponents(components: Record<string, AstroInstance['default']>) {
return z
.record(
z
.string()
.min(1, toComponentsKeyErrorMsg('Component name cannot be empty.'))
.refine(
(value) => isCapitalized(value),
(value) => ({
message: toComponentsKeyErrorMsg(
`Component name must be capitalized (received ${JSON.stringify(
value
)}). If you want to render HTML elements as components, try using a Markdoc node [TODO: DOCS LINK]`
),
})
),
z.any()
)
.parse(components);
}
function toComponentsKeyErrorMsg(msg: string) {
return '[Markdoc] Invalid "components" prop: ' + msg;
}
function isCapitalized(str: string) {
return str.length > 0 && str[0] === str[0].toUpperCase();
}