@astrojs/markdoc 0.1.3 → 0.2.0

package/src/index.ts

@@ -1,188 +0,0 @@
-/* eslint-disable no-console */
-import type { Node } from '@markdoc/markdoc';
-import Markdoc from '@markdoc/markdoc';
-import type { AstroConfig, AstroIntegration, ContentEntryType, HookParameters } from 'astro';
-import fs from 'node:fs';
-import { fileURLToPath, pathToFileURL } from 'node:url';
-import { isValidUrl, MarkdocError, parseFrontmatter, prependForwardSlash } from './utils.js';
-// @ts-expect-error Cannot find module 'astro/assets' or its corresponding type declarations.
-import { emitESMImage } from 'astro/assets';
-import { bold, red, yellow } from 'kleur/colors';
-import type * as rollup from 'rollup';
-import { applyDefaultConfig } from './default-config.js';
-import { loadMarkdocConfig, type MarkdocConfigResult } from './load-config.js';
-
-type SetupHookParams = HookParameters<'astro:config:setup'> & {
-	// `contentEntryType` is not a public API
-	// Add type defs here
-	addContentEntryType: (contentEntryType: ContentEntryType) => void;
-};
-
-export default function markdocIntegration(legacyConfig?: any): AstroIntegration {
-	if (legacyConfig) {
-		console.log(
-			`${red(
-				bold('[Markdoc]')
-			)} Passing Markdoc config from your \`astro.config\` is no longer supported. Configuration should be exported from a \`markdoc.config.mjs\` file. See the configuration docs for more: https://docs.astro.build/en/guides/integrations-guide/markdoc/#configuration`
-		);
-		process.exit(0);
-	}
-	let markdocConfigResult: MarkdocConfigResult | undefined;
-	return {
-		name: '@astrojs/markdoc',
-		hooks: {
-			'astro:config:setup': async (params) => {
-				const { config: astroConfig, addContentEntryType } = params as SetupHookParams;
-
-				markdocConfigResult = await loadMarkdocConfig(astroConfig);
-				const userMarkdocConfig = markdocConfigResult?.config ?? {};
-
-				function getEntryInfo({ fileUrl, contents }: { fileUrl: URL; contents: string }) {
-					const parsed = parseFrontmatter(contents, fileURLToPath(fileUrl));
-					return {
-						data: parsed.data,
-						body: parsed.content,
-						slug: parsed.data.slug,
-						rawData: parsed.matter,
-					};
-				}
-				addContentEntryType({
-					extensions: ['.mdoc'],
-					getEntryInfo,
-					async getRenderModule({ entry, viteId }) {
-						const ast = Markdoc.parse(entry.body);
-						const pluginContext = this;
-						const markdocConfig = applyDefaultConfig(userMarkdocConfig, { entry });
-
-						const validationErrors = Markdoc.validate(ast, markdocConfig).filter((e) => {
-							return (
-								// Ignore `variable-undefined` errors.
-								// Variables can be configured at runtime,
-								// so we cannot validate them at build time.
-								e.error.id !== 'variable-undefined' &&
-								(e.error.level === 'error' || e.error.level === 'critical')
-							);
-						});
-						if (validationErrors.length) {
-							// Heuristic: take number of newlines for `rawData` and add 2 for the `---` fences
-							const frontmatterBlockOffset = entry._internal.rawData.split('\n').length + 2;
-							throw new MarkdocError({
-								message: [
-									`**${String(entry.collection)} → ${String(entry.id)}** contains invalid content:`,
-									...validationErrors.map((e) => `- ${e.error.message}`),
-								].join('\n'),
-								location: {
-									// Error overlay does not support multi-line or ranges.
-									// Just point to the first line.
-									line: frontmatterBlockOffset + validationErrors[0].lines[0],
-									file: viteId,
-								},
-							});
-						}
-
-						if (astroConfig.experimental.assets) {
-							await emitOptimizedImages(ast.children, {
-								astroConfig,
-								pluginContext,
-								filePath: entry._internal.filePath,
-							});
-						}
-
-						return {
-							code: `import { jsx as h } from 'astro/jsx-runtime';
-import { applyDefaultConfig } from '@astrojs/markdoc/default-config';
-import { Renderer } from '@astrojs/markdoc/components';
-import * as entry from ${JSON.stringify(viteId + '?astroContent')};${
-								markdocConfigResult
-									? `\nimport userConfig from ${JSON.stringify(
-											markdocConfigResult.fileUrl.pathname
-									  )};`
-									: ''
-							}${
-								astroConfig.experimental.assets
-									? `\nimport { experimentalAssetsConfig } from '@astrojs/markdoc/experimental-assets-config';`
-									: ''
-							}
-const stringifiedAst = ${JSON.stringify(
-								/* Double stringify to encode *as* stringified JSON */ JSON.stringify(ast)
-							)};
-export async function Content (props) {
-	const config = applyDefaultConfig(${
-		markdocConfigResult
-			? '{ ...userConfig, variables: { ...userConfig.variables, ...props } }'
-			: '{ variables: props }'
-	}, { entry });${
-								astroConfig.experimental.assets
-									? `\nconfig.nodes = { ...experimentalAssetsConfig.nodes, ...config.nodes };`
-									: ''
-							}
-	return h(Renderer, { stringifiedAst, config }); };`,
-						};
-					},
-					contentModuleTypes: await fs.promises.readFile(
-						new URL('../template/content-module-types.d.ts', import.meta.url),
-						'utf-8'
-					),
-				});
-			},
-			'astro:server:setup': async ({ server }) => {
-				server.watcher.on('all', (event, entry) => {
-					if (pathToFileURL(entry).pathname === markdocConfigResult?.fileUrl.pathname) {
-						console.log(
-							yellow(
-								`${bold('[Markdoc]')} Restart the dev server for config changes to take effect.`
-							)
-						);
-					}
-				});
-			},
-		},
-	};
-}
-
-/**
- * Emits optimized images, and appends the generated `src` to each AST node
- * via the `__optimizedSrc` attribute.
- */
-async function emitOptimizedImages(
-	nodeChildren: Node[],
-	ctx: {
-		pluginContext: rollup.PluginContext;
-		filePath: string;
-		astroConfig: AstroConfig;
-	}
-) {
-	for (const node of nodeChildren) {
-		if (
-			node.type === 'image' &&
-			typeof node.attributes.src === 'string' &&
-			shouldOptimizeImage(node.attributes.src)
-		) {
-			// Attempt to resolve source with Vite.
-			// This handles relative paths and configured aliases
-			const resolved = await ctx.pluginContext.resolve(node.attributes.src, ctx.filePath);
-
-			if (resolved?.id && fs.existsSync(new URL(prependForwardSlash(resolved.id), 'file://'))) {
-				const src = await emitESMImage(
-					resolved.id,
-					ctx.pluginContext.meta.watchMode,
-					ctx.pluginContext.emitFile,
-					{ config: ctx.astroConfig }
-				);
-				node.attributes.__optimizedSrc = src;
-			} else {
-				throw new MarkdocError({
-					message: `Could not resolve image ${JSON.stringify(
-						node.attributes.src
-					)} from ${JSON.stringify(ctx.filePath)}. Does the file exist?`,
-				});
-			}
-		}
-		await emitOptimizedImages(node.children, ctx);
-	}
-}
-
-function shouldOptimizeImage(src: string) {
-	// Optimize anything that is NOT external or an absolute path to `public/`
-	return !isValidUrl(src) && !src.startsWith('/');
-}

package/src/load-config.ts

@@ -1,109 +0,0 @@
-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 type MarkdocConfigResult = {
-	config: MarkdocConfig;
-	fileUrl: URL;
-};
-
-export async function loadMarkdocConfig(
-	astroConfig: Pick<AstroConfig, 'root'>
-): Promise<MarkdocConfigResult | undefined> {
-	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,98 +0,0 @@
-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/test/content-collections.test.js

@@ -1,110 +0,0 @@
-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

@@ -1,58 +0,0 @@
-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

@@ -1,7 +0,0 @@
-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

@@ -1,17 +0,0 @@
-#!/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

@@ -1,9 +0,0 @@
-{
-  "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

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

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

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

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

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

package/test/fixtures/content-collections/src/content/config.ts

@@ -1,12 +0,0 @@
-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

@@ -1,10 +0,0 @@
-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

@@ -1,10 +0,0 @@
-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

@@ -1,8 +0,0 @@
-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

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