@astrojs/markdoc 0.0.0-data-collections-20230418125011

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

@@ -0,0 +1,98 @@
+import matter from 'gray-matter';
+import type { ErrorPayload as ViteErrorPayload } from 'vite';
+
+/**
+ * Match YAML exception handling from Astro core errors
+ * @see 'astro/src/core/errors.ts'
+ */
+export function parseFrontmatter(fileContents: string, filePath: string) {
+	try {
+		// `matter` is empty string on cache results
+		// clear cache to prevent this
+		(matter as any).clearCache();
+		return matter(fileContents);
+	} catch (e: any) {
+		if (e.name === 'YAMLException') {
+			const err: Error & ViteErrorPayload['err'] = e;
+			err.id = filePath;
+			err.loc = { file: e.id, line: e.mark.line + 1, column: e.mark.column };
+			err.message = e.reason;
+			throw err;
+		} else {
+			throw e;
+		}
+	}
+}
+
+/**
+ * Matches AstroError object with types like error codes stubbed out
+ * @see 'astro/src/core/errors/errors.ts'
+ */
+export class MarkdocError extends Error {
+	public errorCode: number;
+	public loc: ErrorLocation | undefined;
+	public title: string | undefined;
+	public hint: string | undefined;
+	public frame: string | undefined;
+
+	type = 'MarkdocError';
+
+	constructor(props: ErrorProperties, ...params: any) {
+		super(...params);
+
+		const {
+			// Use default code for unknown errors in Astro core
+			// We don't have a best practice for integration error codes yet
+			code = 99999,
+			name,
+			title = 'MarkdocError',
+			message,
+			stack,
+			location,
+			hint,
+			frame,
+		} = props;
+
+		this.errorCode = code;
+		this.title = title;
+		if (message) this.message = message;
+		// Only set this if we actually have a stack passed, otherwise uses Error's
+		this.stack = stack ? stack : this.stack;
+		this.loc = location;
+		this.hint = hint;
+		this.frame = frame;
+	}
+}
+
+interface ErrorLocation {
+	file?: string;
+	line?: number;
+	column?: number;
+}
+
+interface ErrorProperties {
+	code?: number;
+	title?: string;
+	name?: string;
+	message?: string;
+	location?: ErrorLocation;
+	hint?: string;
+	stack?: string;
+	frame?: string;
+}
+
+/**
+ * @see 'astro/src/core/path.ts'
+ */
+export function prependForwardSlash(str: string) {
+	return str[0] === '/' ? str : '/' + str;
+}
+
+export function isValidUrl(str: string): boolean {
+	try {
+		new URL(str);
+		return true;
+	} catch {
+		return false;
+	}
+}

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

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

package/test/content-collections.test.js

@@ -0,0 +1,110 @@
+import { parse as parseDevalue } from 'devalue';
+import { expect } from 'chai';
+import { loadFixture, fixLineEndings } from '../../../astro/test/test-utils.js';
+import markdoc from '../dist/index.js';
+
+function formatPost(post) {
+	return {
+		...post,
+		body: fixLineEndings(post.body),
+	};
+}
+
+const root = new URL('./fixtures/content-collections/', import.meta.url);
+
+describe('Markdoc - Content Collections', () => {
+	let baseFixture;
+
+	before(async () => {
+		baseFixture = await loadFixture({
+			root,
+			integrations: [markdoc()],
+		});
+	});
+
+	describe('dev', () => {
+		let devServer;
+
+		before(async () => {
+			devServer = await baseFixture.startDevServer();
+		});
+
+		after(async () => {
+			await devServer.stop();
+		});
+
+		it('loads entry', async () => {
+			const res = await baseFixture.fetch('/entry.json');
+			const post = parseDevalue(await res.text());
+			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([
+				post1Entry,
+				post2Entry,
+				post3Entry,
+			]);
+		});
+	});
+
+	describe('build', () => {
+		before(async () => {
+			await baseFixture.build();
+		});
+
+		it('loads entry', async () => {
+			const res = await baseFixture.readFile('/entry.json');
+			const post = parseDevalue(res);
+			expect(formatPost(post)).to.deep.equal(post1Entry);
+		});
+
+		it('loads collection', async () => {
+			const res = await baseFixture.readFile('/collection.json');
+			const posts = parseDevalue(res);
+			expect(posts).to.not.be.null;
+			expect(posts.sort().map((post) => formatPost(post))).to.deep.equal([
+				post1Entry,
+				post2Entry,
+				post3Entry,
+			]);
+		});
+	});
+});
+
+const post1Entry = {
+	id: 'post-1.mdoc',
+	slug: 'post-1',
+	collection: 'blog',
+	data: {
+		schemaWorks: true,
+		title: 'Post 1',
+	},
+	body: '\n## Post 1\n\nThis is the contents of post 1.\n',
+};
+
+const post2Entry = {
+	id: 'post-2.mdoc',
+	slug: 'post-2',
+	collection: 'blog',
+	data: {
+		schemaWorks: true,
+		title: 'Post 2',
+	},
+	body: '\n## Post 2\n\nThis is the contents of post 2.\n',
+};
+
+const post3Entry = {
+	id: 'post-3.mdoc',
+	slug: 'post-3',
+	collection: 'blog',
+	data: {
+		schemaWorks: true,
+		title: 'Post 3',
+	},
+	body: '\n## Post 3\n\nThis is the contents of post 3.\n',
+};

package/test/entry-prop.test.js

@@ -0,0 +1,58 @@
+import { parseHTML } from 'linkedom';
+import { expect } from 'chai';
+import { loadFixture } from '../../../astro/test/test-utils.js';
+import markdoc from '../dist/index.js';
+
+const root = new URL('./fixtures/entry-prop/', import.meta.url);
+
+describe('Markdoc - Entry prop', () => {
+	let baseFixture;
+
+	before(async () => {
+		baseFixture = await loadFixture({
+			root,
+			integrations: [markdoc()],
+		});
+	});
+
+	describe('dev', () => {
+		let devServer;
+
+		before(async () => {
+			devServer = await baseFixture.startDevServer();
+		});
+
+		after(async () => {
+			await devServer.stop();
+		});
+
+		it('has expected entry properties', async () => {
+			const res = await baseFixture.fetch('/');
+			const html = await res.text();
+			const { document } = parseHTML(html);
+			expect(document.querySelector('h1')?.textContent).to.equal('Processed by schema: Test entry');
+			expect(document.getElementById('id')?.textContent?.trim()).to.equal('id: entry.mdoc');
+			expect(document.getElementById('slug')?.textContent?.trim()).to.equal('slug: entry');
+			expect(document.getElementById('collection')?.textContent?.trim()).to.equal(
+				'collection: blog'
+			);
+		});
+	});
+
+	describe('build', () => {
+		before(async () => {
+			await baseFixture.build();
+		});
+
+		it('has expected entry properties', async () => {
+			const html = await baseFixture.readFile('/index.html');
+			const { document } = parseHTML(html);
+			expect(document.querySelector('h1')?.textContent).to.equal('Processed by schema: Test entry');
+			expect(document.getElementById('id')?.textContent?.trim()).to.equal('id: entry.mdoc');
+			expect(document.getElementById('slug')?.textContent?.trim()).to.equal('slug: entry');
+			expect(document.getElementById('collection')?.textContent?.trim()).to.equal(
+				'collection: blog'
+			);
+		});
+	});
+});

package/test/fixtures/content-collections/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/content-collections/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/packages/astro/node_modules:/home/runner/work/astro/astro/packages/node_modules:/home/runner/work/astro/astro/node_modules:/home/runner/work/astro/node_modules:/home/runner/work/node_modules:/home/runner/node_modules:/home/node_modules:/node_modules:/home/runner/work/astro/astro/node_modules/.pnpm/node_modules"
+else
+  export NODE_PATH="/home/runner/work/astro/astro/packages/astro/node_modules:/home/runner/work/astro/astro/packages/node_modules:/home/runner/work/astro/astro/node_modules:/home/runner/work/astro/node_modules:/home/runner/work/node_modules:/home/runner/node_modules:/home/node_modules:/node_modules:/home/runner/work/astro/astro/node_modules/.pnpm/node_modules:$NODE_PATH"
+fi
+if [ -x "$basedir/node" ]; then
+  exec "$basedir/node"  "$basedir/../../../../../../../astro/astro.js" "$@"
+else
+  exec node  "$basedir/../../../../../../../astro/astro.js" "$@"
+fi

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

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

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/content/config.ts

@@ -0,0 +1,12 @@
+import { defineCollection, z } from 'astro:content';
+
+const blog = defineCollection({
+	schema: z.object({
+		title: z.string(),
+	}).transform(data => ({
+		...data,
+		schemaWorks: true,
+	}))
+});
+
+export const collections = { blog };

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

@@ -0,0 +1,10 @@
+import { getCollection } from 'astro:content';
+import { stringify } from 'devalue';
+import { stripAllRenderFn } from '../../utils.js';
+
+export async function get() {
+	const posts = await getCollection('blog');
+	return {
+		body: stringify(stripAllRenderFn(posts))
+	};
+}

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

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

package/test/fixtures/content-collections/utils.js

@@ -0,0 +1,8 @@
+export function stripRenderFn(entryWithRender) {
+	const { render, ...entry } = entryWithRender;
+	return entry;
+}
+
+export function stripAllRenderFn(collection = []) {
+	return collection.map(stripRenderFn);
+}

package/test/fixtures/entry-prop/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/entry-prop/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/packages/astro/node_modules:/home/runner/work/astro/astro/packages/node_modules:/home/runner/work/astro/astro/node_modules:/home/runner/work/astro/node_modules:/home/runner/work/node_modules:/home/runner/node_modules:/home/node_modules:/node_modules:/home/runner/work/astro/astro/node_modules/.pnpm/node_modules"
+else
+  export NODE_PATH="/home/runner/work/astro/astro/packages/astro/node_modules:/home/runner/work/astro/astro/packages/node_modules:/home/runner/work/astro/astro/node_modules:/home/runner/work/astro/node_modules:/home/runner/work/node_modules:/home/runner/node_modules:/home/node_modules:/node_modules:/home/runner/work/astro/astro/node_modules/.pnpm/node_modules:$NODE_PATH"
+fi
+if [ -x "$basedir/node" ]; then
+  exec "$basedir/node"  "$basedir/../../../../../../../astro/astro.js" "$@"
+else
+  exec node  "$basedir/../../../../../../../astro/astro.js" "$@"
+fi

package/test/fixtures/entry-prop/package.json

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

package/test/fixtures/entry-prop/src/content/blog/entry.mdoc

@@ -0,0 +1,9 @@
+---
+title: Test entry
+---
+
+# {% $entry.data.title %}
+
+- id: {% $entry.id %} {% #id %}
+- slug: {% $entry.slug %} {% #slug %}
+- collection: {% $entry.collection %} {% #collection %}

package/test/fixtures/entry-prop/src/content/config.ts

@@ -0,0 +1,9 @@
+import { defineCollection, z } from 'astro:content';
+
+const blog = defineCollection({
+	schema: z.object({
+		title: z.string().transform(v => 'Processed by schema: ' + v),
+	}),
+});
+
+export const collections = { blog }

package/test/fixtures/entry-prop/src/pages/index.astro

@@ -0,0 +1,19 @@
+---
+import { getEntryBySlug } from 'astro:content';
+
+const entry = await getEntryBySlug('blog', 'entry');
+const { Content } = await entry.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/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/packages/astro/node_modules:/home/runner/work/astro/astro/packages/node_modules:/home/runner/work/astro/astro/node_modules:/home/runner/work/astro/node_modules:/home/runner/work/node_modules:/home/runner/node_modules:/home/node_modules:/node_modules:/home/runner/work/astro/astro/node_modules/.pnpm/node_modules"
+else
+  export NODE_PATH="/home/runner/work/astro/astro/packages/astro/node_modules:/home/runner/work/astro/astro/packages/node_modules:/home/runner/work/astro/astro/node_modules:/home/runner/work/astro/node_modules:/home/runner/work/node_modules:/home/runner/node_modules:/home/node_modules:/node_modules:/home/runner/work/astro/astro/node_modules/.pnpm/node_modules:$NODE_PATH"
+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-null/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()],
+});