From 93a1231f14d97339e38d8a67cf541337960e7d5e Mon Sep 17 00:00:00 2001 From: Chris Swithinbank Date: Tue, 5 Sep 2023 12:48:39 +0200 Subject: [PATCH] Add location data to MDX compile errors (#8405) --- .changeset/spotty-glasses-grin.md | 5 +++ packages/integrations/mdx/src/index.ts | 48 +++++++++++++++----------- 2 files changed, 32 insertions(+), 21 deletions(-) create mode 100644 .changeset/spotty-glasses-grin.md diff --git a/.changeset/spotty-glasses-grin.md b/.changeset/spotty-glasses-grin.md new file mode 100644 index 000000000000..3a903b79dd32 --- /dev/null +++ b/.changeset/spotty-glasses-grin.md @@ -0,0 +1,5 @@ +--- +'@astrojs/mdx': patch +--- + +Add location data to MDX compile errors diff --git a/packages/integrations/mdx/src/index.ts b/packages/integrations/mdx/src/index.ts index 8366698d5991..9053e824c81d 100644 --- a/packages/integrations/mdx/src/index.ts +++ b/packages/integrations/mdx/src/index.ts @@ -2,7 +2,7 @@ import { markdownConfigDefaults } from '@astrojs/markdown-remark'; import { toRemarkInitializeAstroData } from '@astrojs/markdown-remark/dist/internal.js'; import { compile as mdxCompile, type CompileOptions } from '@mdx-js/mdx'; import type { PluggableList } from '@mdx-js/mdx/lib/core.js'; -import type { AstroIntegration, ContentEntryType, HookParameters } from 'astro'; +import type { AstroIntegration, ContentEntryType, HookParameters, SSRError } from 'astro'; import astroJSXRenderer from 'astro/jsx/renderer.js'; import { parse as parseESM } from 'es-module-lexer'; import fs from 'node:fs/promises'; @@ -129,27 +129,33 @@ export default function mdx(partialMdxOptions: Partial = {}): AstroI const code = await fs.readFile(fileId, 'utf-8'); const { data: frontmatter, content: pageContent } = parseFrontmatter(code, id); - const compiled = await mdxCompile(new VFile({ value: pageContent, path: id }), { - ...mdxPluginOpts, - elementAttributeNameCase: 'html', - remarkPlugins: [ - // Ensure `data.astro` is available to all remark plugins - toRemarkInitializeAstroData({ userFrontmatter: frontmatter }), - ...(mdxPluginOpts.remarkPlugins ?? []), - ], - recmaPlugins: [ - ...(mdxPluginOpts.recmaPlugins ?? []), - () => recmaInjectImportMetaEnvPlugin({ importMetaEnv }), - ], - SourceMapGenerator: config.vite.build?.sourcemap - ? SourceMapGenerator - : undefined, - }); + try { + const compiled = await mdxCompile(new VFile({ value: pageContent, path: id }), { + ...mdxPluginOpts, + elementAttributeNameCase: 'html', + remarkPlugins: [ + // Ensure `data.astro` is available to all remark plugins + toRemarkInitializeAstroData({ userFrontmatter: frontmatter }), + ...(mdxPluginOpts.remarkPlugins ?? []), + ], + recmaPlugins: [ + ...(mdxPluginOpts.recmaPlugins ?? []), + () => recmaInjectImportMetaEnvPlugin({ importMetaEnv }), + ], + SourceMapGenerator: config.vite.build?.sourcemap + ? SourceMapGenerator + : undefined, + }); - return { - code: escapeViteEnvReferences(String(compiled.value)), - map: compiled.map, - }; + return { + code: escapeViteEnvReferences(String(compiled.value)), + map: compiled.map, + }; + } catch (e: any) { + const err: SSRError = e; + err.loc = { file: fileId, line: e.line, column: e.column }; + throw err; + } }, }, {