3a9f72c7f3
* feat: better validation logs * chore: add warning to restart server on config chnage * feat: expose Markdoc global from markdoc/config * docs: update `nodes` reference * chore: changeset * docs: simplify headings explainer * chore: ignore eslint log errors * fix: make legacyConfig prop optional
109 lines
2.9 KiB
TypeScript
109 lines
2.9 KiB
TypeScript
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
|
|
}
|
|
}
|
|
}
|