diff --git a/.changeset/spotty-glasses-grin.md b/.changeset/spotty-glasses-grin.md new file mode 100644 index 000000000..3a903b79d --- /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/astro/src/@types/astro.ts b/packages/astro/src/@types/astro.ts index c6d27ab36..73b652db6 100644 --- a/packages/astro/src/@types/astro.ts +++ b/packages/astro/src/@types/astro.ts @@ -642,7 +642,7 @@ export interface AstroUserConfig { * import netlify from '@astrojs/netlify/functions'; * { * // Example: Build for Netlify serverless deployment - * adapter: netlify(), + * adapter: netlify(), * } * ``` */ @@ -658,9 +658,9 @@ export interface AstroUserConfig { * * Specifies the output target for builds. * - * - 'static' - Building a static site to be deploy to any static host. - * - 'server' - Building an app to be deployed to a host supporting SSR (server-side rendering). - * - 'hybrid' - Building a static site with a few server-side rendered pages. + * - `'static'` - Building a static site to be deploy to any static host. + * - `'server'` - Building an app to be deployed to a host supporting SSR (server-side rendering). + * - `'hybrid'` - Building a static site with a few server-side rendered pages. * * ```js * import { defineConfig } from 'astro/config'; @@ -685,8 +685,8 @@ export interface AstroUserConfig { * @default `'directory'` * @description * Control the output file format of each page. - * - If 'file', Astro will generate an HTML file (ex: "/foo.html") for each page. - * - If 'directory', Astro will generate a directory with a nested `index.html` file (ex: "/foo/index.html") for each page. + * - If `'file'`, Astro will generate an HTML file (ex: "/foo.html") for each page. + * - If `'directory'`, Astro will generate a directory with a nested `index.html` file (ex: "/foo/index.html") for each page. * * ```js * { @@ -970,7 +970,7 @@ export interface AstroUserConfig { /** * @docs * @kind heading - * @name Image options + * @name Image Options */ image?: { /** @@ -980,7 +980,7 @@ export interface AstroUserConfig { * @default `{entrypoint: 'astro/assets/services/sharp', config?: {}}` * @version 2.1.0 * @description - * Set which image service is used for Astro’s experimental assets support. + * Set which image service is used for Astro’s assets support. * * The value should be an object with an entrypoint for the image service to use and optionally, a config object to pass to the service. * @@ -1004,7 +1004,7 @@ export interface AstroUserConfig { * @default `{domains: []}` * @version 2.10.10 * @description - * Defines a list of permitted image source domains for local image optimization. No other remote images will be optimized by Astro. + * Defines a list of permitted image source domains for remote image optimization. No other remote images will be optimized by Astro. * * This option requires an array of individual domain names as strings. Wildcards are not permitted. Instead, use [`image.remotePatterns`](#imageremotepatterns) to define a list of allowed source URL patterns. * @@ -1027,7 +1027,7 @@ export interface AstroUserConfig { * @default `{remotePatterns: []}` * @version 2.10.10 * @description - * Defines a list of permitted image source URL patterns for local image optimization. + * Defines a list of permitted image source URL patterns for remote image optimization. * * `remotePatterns` can be configured with four properties: * 1. protocol diff --git a/packages/integrations/mdx/src/index.ts b/packages/integrations/mdx/src/index.ts index 8366698d5..9053e824c 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; + } }, }, {