@astrojs/markdoc 0.0.4 → 0.1.0

package/src/load-config.ts

@@ -0,0 +1,102 @@
+import type { Config as MarkdocConfig } from '@markdoc/markdoc';
+import type { AstroConfig } from 'astro';
+import { build as esbuild } from 'esbuild';
+import * as fs from 'node:fs';
+import { fileURLToPath } from 'node:url';
+
+const SUPPORTED_MARKDOC_CONFIG_FILES = [
+	'markdoc.config.js',
+	'markdoc.config.mjs',
+	'markdoc.config.mts',
+	'markdoc.config.ts',
+];
+
+export async function loadMarkdocConfig(astroConfig: Pick<AstroConfig, 'root'>) {
+	let markdocConfigUrl: URL | undefined;
+	for (const filename of SUPPORTED_MARKDOC_CONFIG_FILES) {
+		const filePath = new URL(filename, astroConfig.root);
+		if (!fs.existsSync(filePath)) continue;
+
+		markdocConfigUrl = filePath;
+		break;
+	}
+	if (!markdocConfigUrl) return;
+
+	const { code, dependencies } = await bundleConfigFile({
+		markdocConfigUrl,
+		astroConfig,
+	});
+	const config: MarkdocConfig = await loadConfigFromBundledFile(astroConfig.root, code);
+
+	return {
+		config,
+		fileUrl: markdocConfigUrl,
+	};
+}
+
+/**
+ * Forked from Vite's `bundleConfigFile` function
+ * with added handling for `.astro` imports,
+ * and removed unused Deno patches.
+ * @see https://github.com/vitejs/vite/blob/main/packages/vite/src/node/config.ts#L961
+ */
+async function bundleConfigFile({
+	markdocConfigUrl,
+	astroConfig,
+}: {
+	markdocConfigUrl: URL;
+	astroConfig: Pick<AstroConfig, 'root'>;
+}): Promise<{ code: string; dependencies: string[] }> {
+	const result = await esbuild({
+		absWorkingDir: fileURLToPath(astroConfig.root),
+		entryPoints: [fileURLToPath(markdocConfigUrl)],
+		outfile: 'out.js',
+		write: false,
+		target: ['node16'],
+		platform: 'node',
+		packages: 'external',
+		bundle: true,
+		format: 'esm',
+		sourcemap: 'inline',
+		metafile: true,
+		plugins: [
+			{
+				name: 'stub-astro-imports',
+				setup(build) {
+					build.onResolve({ filter: /.*\.astro$/ }, () => {
+						return {
+							// Stub with an unused default export
+							path: 'data:text/javascript,export default true',
+							external: true,
+						};
+					});
+				},
+			},
+		],
+	});
+	const { text } = result.outputFiles[0];
+	return {
+		code: text,
+		dependencies: result.metafile ? Object.keys(result.metafile.inputs) : [],
+	};
+}
+
+/**
+ * Forked from Vite config loader, replacing CJS-based path concat
+ * with ESM only
+ * @see https://github.com/vitejs/vite/blob/main/packages/vite/src/node/config.ts#L1074
+ */
+async function loadConfigFromBundledFile(root: URL, code: string): Promise<MarkdocConfig> {
+	// Write it to disk, load it with native Node ESM, then delete the file.
+	const tmpFileUrl = new URL(`markdoc.config.timestamp-${Date.now()}.mjs`, root);
+	fs.writeFileSync(tmpFileUrl, code);
+	try {
+		return (await import(tmpFileUrl.pathname)).default;
+	} finally {
+		try {
+			fs.unlinkSync(tmpFileUrl);
+		} catch {
+			// already removed if this function is called twice simultaneously
+		}
+	}
+}

package/src/utils.ts

@@ -1,8 +1,4 @@
-import type { AstroInstance } from 'astro';
-import z from 'astro/zod';
 import matter from 'gray-matter';
-import type fsMod from 'node:fs';
-import path from 'node:path';
 import type { ErrorPayload as ViteErrorPayload } from 'vite';
 
 /**
@@ -85,28 +81,6 @@ interface ErrorProperties {
 	frame?: string;
 }
 
-/**
- * Matches `search` function used for resolving `astro.config` files.
- * Used by Markdoc for error handling.
- * @see 'astro/src/core/config/config.ts'
- */
-export function getAstroConfigPath(fs: typeof fsMod, root: string): string | undefined {
-	const paths = [
-		'astro.config.mjs',
-		'astro.config.js',
-		'astro.config.ts',
-		'astro.config.mts',
-		'astro.config.cjs',
-		'astro.config.cts',
-	].map((p) => path.join(root, p));
-
-	for (const file of paths) {
-		if (fs.existsSync(file)) {
-			return file;
-		}
-	}
-}
-
 /**
  * @see 'astro/src/core/path.ts'
  */
@@ -114,34 +88,11 @@ export function prependForwardSlash(str: string) {
 	return str[0] === '/' ? str : '/' + str;
 }
 
-export function validateComponentsProp(components: Record<string, AstroInstance['default']>) {
+export function isValidUrl(str: string): boolean {
 	try {
-		componentsPropValidator.parse(components);
-	} catch (e) {
-		throw new MarkdocError({
-			message:
-				e instanceof z.ZodError
-					? e.issues[0].message
-					: 'Invalid `components` prop. Ensure you are passing an object of components to <Content />',
-		});
+		new URL(str);
+		return true;
+	} catch {
+		return false;
 	}
 }
-
-const componentsPropValidator = z.record(
-	z
-		.string()
-		.min(1, 'Invalid `components` prop. Component names cannot be empty!')
-		.refine(
-			(value) => isCapitalized(value),
-			(value) => ({
-				message: `Invalid \`components\` prop: ${JSON.stringify(
-					value
-				)}. Component name must be capitalized. If you want to render HTML elements as components, try using a Markdoc node (https://docs.astro.build/en/guides/integrations-guide/markdoc/#render-markdoc-nodes--html-elements-as-astro-components)`,
-			})
-		),
-	z.any()
-);
-
-export function isCapitalized(str: string) {
-	return str.length > 0 && str[0] === str[0].toUpperCase();
-}

package/template/content-module-types.d.ts

@@ -1,9 +1,7 @@
 declare module 'astro:content' {
 	interface Render {
 		'.mdoc': Promise<{
-			Content(props: {
-				components?: Record<string, import('astro').AstroInstance['default']>;
-			}): import('astro').MarkdownInstance<{}>['Content'];
+			Content(props: Record<string, any>): import('astro').MarkdownInstance<{}>['Content'];
 		}>;
 	}
 }

package/test/content-collections.test.js

@@ -1,4 +1,3 @@
-import { parseHTML } from 'linkedom';
 import { parse as parseDevalue } from 'devalue';
 import { expect } from 'chai';
 import { loadFixture, fixLineEndings } from '../../../astro/test/test-utils.js';
@@ -37,70 +36,20 @@ describe('Markdoc - Content Collections', () => {
 		it('loads entry', async () => {
 			const res = await baseFixture.fetch('/entry.json');
 			const post = parseDevalue(await res.text());
-			expect(formatPost(post)).to.deep.equal(simplePostEntry);
+			expect(formatPost(post)).to.deep.equal(post1Entry);
 		});
 
 		it('loads collection', async () => {
 			const res = await baseFixture.fetch('/collection.json');
 			const posts = parseDevalue(await res.text());
 			expect(posts).to.not.be.null;
+
 			expect(posts.sort().map((post) => formatPost(post))).to.deep.equal([
-				simplePostEntry,
-				withComponentsEntry,
-				withConfigEntry,
+				post1Entry,
+				post2Entry,
+				post3Entry,
 			]);
 		});
-
-		it('renders content - simple', async () => {
-			const res = await baseFixture.fetch('/content-simple');
-			const html = await res.text();
-			const { document } = parseHTML(html);
-			const h2 = document.querySelector('h2');
-			expect(h2.textContent).to.equal('Simple post');
-			const p = document.querySelector('p');
-			expect(p.textContent).to.equal('This is a simple Markdoc post.');
-		});
-
-		it('renders content - with config', async () => {
-			const fixture = await getFixtureWithConfig();
-			const server = await fixture.startDevServer();
-
-			const res = await fixture.fetch('/content-with-config');
-			const html = await res.text();
-			const { document } = parseHTML(html);
-			const h2 = document.querySelector('h2');
-			expect(h2.textContent).to.equal('Post with config');
-			const textContent = html;
-
-			expect(textContent).to.not.include('Hello');
-			expect(textContent).to.include('Hola');
-			expect(textContent).to.include(`Konnichiwa`);
-
-			await server.stop();
-		});
-
-		it('renders content - with components', async () => {
-			const fixture = await getFixtureWithComponents();
-			const server = await fixture.startDevServer();
-
-			const res = await fixture.fetch('/content-with-components');
-			const html = await res.text();
-			const { document } = parseHTML(html);
-			const h2 = document.querySelector('h2');
-			expect(h2.textContent).to.equal('Post with components');
-
-			// Renders custom shortcode component
-			const marquee = document.querySelector('marquee');
-			expect(marquee).to.not.be.null;
-			expect(marquee.hasAttribute('data-custom-marquee')).to.equal(true);
-
-			// Renders Astro Code component
-			const pre = document.querySelector('pre');
-			expect(pre).to.not.be.null;
-			expect(pre.className).to.equal('astro-code');
-
-			await server.stop();
-		});
 	});
 
 	describe('build', () => {
@@ -111,7 +60,7 @@ describe('Markdoc - Content Collections', () => {
 		it('loads entry', async () => {
 			const res = await baseFixture.readFile('/entry.json');
 			const post = parseDevalue(res);
-			expect(formatPost(post)).to.deep.equal(simplePostEntry);
+			expect(formatPost(post)).to.deep.equal(post1Entry);
 		});
 
 		it('loads collection', async () => {
@@ -119,140 +68,43 @@ describe('Markdoc - Content Collections', () => {
 			const posts = parseDevalue(res);
 			expect(posts).to.not.be.null;
 			expect(posts.sort().map((post) => formatPost(post))).to.deep.equal([
-				simplePostEntry,
-				withComponentsEntry,
-				withConfigEntry,
+				post1Entry,
+				post2Entry,
+				post3Entry,
 			]);
 		});
-
-		it('renders content - simple', async () => {
-			const html = await baseFixture.readFile('/content-simple/index.html');
-			const { document } = parseHTML(html);
-			const h2 = document.querySelector('h2');
-			expect(h2.textContent).to.equal('Simple post');
-			const p = document.querySelector('p');
-			expect(p.textContent).to.equal('This is a simple Markdoc post.');
-		});
-
-		it('renders content - with config', async () => {
-			const fixture = await getFixtureWithConfig();
-			await fixture.build();
-
-			const html = await fixture.readFile('/content-with-config/index.html');
-			const { document } = parseHTML(html);
-			const h2 = document.querySelector('h2');
-			expect(h2.textContent).to.equal('Post with config');
-			const textContent = html;
-
-			expect(textContent).to.not.include('Hello');
-			expect(textContent).to.include('Hola');
-			expect(textContent).to.include(`Konnichiwa`);
-		});
-
-		it('renders content - with components', async () => {
-			const fixture = await getFixtureWithComponents();
-			await fixture.build();
-
-			const html = await fixture.readFile('/content-with-components/index.html');
-			const { document } = parseHTML(html);
-			const h2 = document.querySelector('h2');
-			expect(h2.textContent).to.equal('Post with components');
-
-			// Renders custom shortcode component
-			const marquee = document.querySelector('marquee');
-			expect(marquee).to.not.be.null;
-			expect(marquee.hasAttribute('data-custom-marquee')).to.equal(true);
-
-			// Renders Astro Code component
-			const pre = document.querySelector('pre');
-			expect(pre).to.not.be.null;
-			expect(pre.className).to.equal('astro-code');
-		});
 	});
 });
 
-function getFixtureWithConfig() {
-	return loadFixture({
-		root,
-		integrations: [
-			markdoc({
-				variables: {
-					countries: ['ES', 'JP'],
-				},
-				functions: {
-					includes: {
-						transform(parameters) {
-							const [array, value] = Object.values(parameters);
-							return Array.isArray(array) ? array.includes(value) : false;
-						},
-					},
-				},
-			}),
-		],
-	});
-}
-
-function getFixtureWithComponents() {
-	return loadFixture({
-		root,
-		integrations: [
-			markdoc({
-				nodes: {
-					fence: {
-						render: 'Code',
-						attributes: {
-							language: { type: String },
-							content: { type: String },
-						},
-					},
-				},
-				tags: {
-					mq: {
-						render: 'CustomMarquee',
-						attributes: {
-							direction: {
-								type: String,
-								default: 'left',
-								matches: ['left', 'right', 'up', 'down'],
-								errorLevel: 'critical',
-							},
-						},
-					},
-				},
-			}),
-		],
-	});
-}
-
-const simplePostEntry = {
-	id: 'simple.mdoc',
-	slug: 'simple',
+const post1Entry = {
+	id: 'post-1.mdoc',
+	slug: 'post-1',
 	collection: 'blog',
 	data: {
 		schemaWorks: true,
-		title: 'Simple post',
+		title: 'Post 1',
 	},
-	body: '\n## Simple post\n\nThis is a simple Markdoc post.\n',
+	body: '\n## Post 1\n\nThis is the contents of post 1.\n',
 };
 
-const withComponentsEntry = {
-	id: 'with-components.mdoc',
-	slug: 'with-components',
+const post2Entry = {
+	id: 'post-2.mdoc',
+	slug: 'post-2',
 	collection: 'blog',
 	data: {
 		schemaWorks: true,
-		title: 'Post with components',
+		title: 'Post 2',
 	},
-	body: '\n## Post with components\n\nThis uses a custom marquee component with a shortcode:\n\n{% mq direction="right" %}\nI\'m a marquee too!\n{% /mq %}\n\nAnd a code component for code blocks:\n\n```js\nconst isRenderedWithShiki = true;\n```\n',
+	body: '\n## Post 2\n\nThis is the contents of post 2.\n',
 };
 
-const withConfigEntry = {
-	id: 'with-config.mdoc',
-	slug: 'with-config',
+const post3Entry = {
+	id: 'post-3.mdoc',
+	slug: 'post-3',
 	collection: 'blog',
 	data: {
 		schemaWorks: true,
-		title: 'Post with config',
+		title: 'Post 3',
 	},
-	body: '\n## Post with config\n\n{% if includes($countries, "EN") %} Hello {% /if %}\n{% if includes($countries, "ES") %} Hola {% /if %}\n{% if includes($countries, "JP") %} Konnichiwa {% /if %}\n',
+	body: '\n## Post 3\n\nThis is the contents of post 3.\n',
 };

package/test/fixtures/content-collections/package.json

@@ -4,10 +4,6 @@
   "private": true,
   "dependencies": {
     "@astrojs/markdoc": "workspace:*",
-    "@markdoc/markdoc": "^0.2.2",
     "astro": "workspace:*"
-  },
-  "devDependencies": {
-    "shiki": "^0.11.1"
   }
 }

package/test/fixtures/content-collections/src/content/blog/post-1.mdoc

@@ -0,0 +1,7 @@
+---
+title: Post 1
+---
+
+## Post 1
+
+This is the contents of post 1.

package/test/fixtures/content-collections/src/content/blog/post-2.mdoc

@@ -0,0 +1,7 @@
+---
+title: Post 2
+---
+
+## Post 2
+
+This is the contents of post 2.

package/test/fixtures/content-collections/src/content/blog/post-3.mdoc

@@ -0,0 +1,7 @@
+---
+title: Post 3
+---
+
+## Post 3
+
+This is the contents of post 3.

package/test/fixtures/content-collections/src/pages/entry.json.js

@@ -3,7 +3,7 @@ import { stringify } from 'devalue';
 import { stripRenderFn } from '../../utils.js';
 
 export async function get() {
-	const post = await getEntryBySlug('blog', 'simple');
+	const post = await getEntryBySlug('blog', 'post-1');
 	return {
 		body: stringify(stripRenderFn(post)),
 	};

package/test/fixtures/image-assets/astro.config.mjs

@@ -0,0 +1,10 @@
+import { defineConfig } from 'astro/config';
+import markdoc from '@astrojs/markdoc';
+
+// https://astro.build/config
+export default defineConfig({
+	experimental: {
+		assets: true,
+	},
+	integrations: [markdoc()],
+});

package/test/fixtures/image-assets/node_modules/.bin/astro

@@ -0,0 +1,17 @@
+#!/bin/sh
+basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
+
+case `uname` in
+    *CYGWIN*) basedir=`cygpath -w "$basedir"`;;
+esac
+
+if [ -z "$NODE_PATH" ]; then
+  export NODE_PATH="/home/runner/work/astro/astro/node_modules/.pnpm/node_modules"
+else
+  export NODE_PATH="$NODE_PATH:/home/runner/work/astro/astro/node_modules/.pnpm/node_modules"
+fi
+if [ -x "$basedir/node" ]; then
+  exec "$basedir/node"  "$basedir/../../../../../../../astro/astro.js" "$@"
+else
+  exec node  "$basedir/../../../../../../../astro/astro.js" "$@"
+fi

package/test/fixtures/image-assets/package.json

@@ -0,0 +1,9 @@
+{
+  "name": "@test/image-assets",
+  "version": "0.0.0",
+  "private": true,
+  "dependencies": {
+    "@astrojs/markdoc": "workspace:*",
+    "astro": "workspace:*"
+  }
+}

package/test/fixtures/image-assets/src/content/docs/intro.mdoc

@@ -0,0 +1,7 @@
+# Image assets
+
+![Favicon](/favicon.svg) {% #public %}
+
+![Oar](../../assets/relative/oar.jpg) {% #relative %}
+
+![Gray cityscape arial view](~/assets/alias/cityscape.jpg) {% #alias %}

package/test/fixtures/image-assets/src/pages/index.astro

@@ -0,0 +1,19 @@
+---
+import { getEntryBySlug } from 'astro:content';
+
+const intro = await getEntryBySlug('docs', 'intro');
+const { Content } = await intro.render();
+---
+
+<html lang="en">
+	<head>
+		<meta charset="utf-8" />
+		<link rel="icon" type="image/svg+xml" href="/favicon.svg" />
+		<meta name="viewport" content="width=device-width" />
+		<meta name="generator" content={Astro.generator} />
+		<title>Astro</title>
+	</head>
+	<body>
+		<Content />
+	</body>
+</html>

package/test/fixtures/image-assets/src/public/favicon.svg

@@ -0,0 +1,9 @@
+<svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 128 128">
+    <path d="M50.4 78.5a75.1 75.1 0 0 0-28.5 6.9l24.2-65.7c.7-2 1.9-3.2 3.4-3.2h29c1.5 0 2.7 1.2 3.4 3.2l24.2 65.7s-11.6-7-28.5-7L67 45.5c-.4-1.7-1.6-2.8-2.9-2.8-1.3 0-2.5 1.1-2.9 2.7L50.4 78.5Zm-1.1 28.2Zm-4.2-20.2c-2 6.6-.6 15.8 4.2 20.2a17.5 17.5 0 0 1 .2-.7 5.5 5.5 0 0 1 5.7-4.5c2.8.1 4.3 1.5 4.7 4.7.2 1.1.2 2.3.2 3.5v.4c0 2.7.7 5.2 2.2 7.4a13 13 0 0 0 5.7 4.9v-.3l-.2-.3c-1.8-5.6-.5-9.5 4.4-12.8l1.5-1a73 73 0 0 0 3.2-2.2 16 16 0 0 0 6.8-11.4c.3-2 .1-4-.6-6l-.8.6-1.6 1a37 37 0 0 1-22.4 2.7c-5-.7-9.7-2-13.2-6.2Z" />
+    <style>
+        path { fill: #000; }
+        @media (prefers-color-scheme: dark) {
+            path { fill: #FFF; }
+        }
+    </style>
+</svg>

package/test/fixtures/render-simple/astro.config.mjs

@@ -0,0 +1,7 @@
+import { defineConfig } from 'astro/config';
+import markdoc from '@astrojs/markdoc';
+
+// https://astro.build/config
+export default defineConfig({
+	integrations: [markdoc()],
+});

package/test/fixtures/render-simple/node_modules/.bin/astro

@@ -0,0 +1,17 @@
+#!/bin/sh
+basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
+
+case `uname` in
+    *CYGWIN*) basedir=`cygpath -w "$basedir"`;;
+esac
+
+if [ -z "$NODE_PATH" ]; then
+  export NODE_PATH="/home/runner/work/astro/astro/node_modules/.pnpm/node_modules"
+else
+  export NODE_PATH="$NODE_PATH:/home/runner/work/astro/astro/node_modules/.pnpm/node_modules"
+fi
+if [ -x "$basedir/node" ]; then
+  exec "$basedir/node"  "$basedir/../../../../../../../astro/astro.js" "$@"
+else
+  exec node  "$basedir/../../../../../../../astro/astro.js" "$@"
+fi

package/test/fixtures/render-simple/package.json

@@ -0,0 +1,9 @@
+{
+  "name": "@test/markdoc-render-simple",
+  "version": "0.0.0",
+  "private": true,
+  "dependencies": {
+    "@astrojs/markdoc": "workspace:*",
+    "astro": "workspace:*"
+  }
+}

package/test/fixtures/{content-collections/src/pages/content-simple.astro → render-simple/src/pages/index.astro}

@@ -1,5 +1,6 @@
 ---
 import { getEntryBySlug } from "astro:content";
+
 const post = await getEntryBySlug('blog', 'simple');
 const { Content } = await post.render();
 ---
@@ -10,7 +11,7 @@ const { Content } = await post.render();
 	<meta charset="UTF-8">
 	<meta http-equiv="X-UA-Compatible" content="IE=edge">
 	<meta name="viewport" content="width=device-width, initial-scale=1.0">
-	<title>Content - Simple</title>
+	<title>Content</title>
 </head>
 <body>
 	<Content />	

package/test/fixtures/render-with-components/astro.config.mjs

@@ -0,0 +1,7 @@
+import { defineConfig } from 'astro/config';
+import markdoc from '@astrojs/markdoc';
+
+// https://astro.build/config
+export default defineConfig({
+	integrations: [markdoc()],
+});

package/test/fixtures/render-with-components/markdoc.config.mjs

@@ -0,0 +1,28 @@
+import Code from './src/components/Code.astro';
+import CustomMarquee from './src/components/CustomMarquee.astro';
+import { defineMarkdocConfig } from '@astrojs/markdoc/config';
+
+export default defineMarkdocConfig({
+	nodes: {
+		fence: {
+			render: Code,
+			attributes: {
+				language: { type: String },
+				content: { type: String },
+			},
+		},
+	},
+	tags: {
+		mq: {
+			render: CustomMarquee,
+			attributes: {
+				direction: {
+					type: String,
+					default: 'left',
+					matches: ['left', 'right', 'up', 'down'],
+					errorLevel: 'critical',
+				},
+			},
+		},
+	},
+})