Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix MDX stack trace location with frontmatter #11717

Merged
merged 1 commit into from
Aug 16, 2024
Merged

Fix MDX stack trace location with frontmatter #11717

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/mighty-trees-teach.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@astrojs/mdx': patch
---

Fixes stack trace location when failed to parse an MDX file with frontmatter
5 changes: 3 additions & 2 deletions packages/integrations/mdx/src/vite-plugin-mdx.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,10 @@ export function vitePluginMdx(mdxOptions: MdxOptions): Plugin {
async transform(code, id) {
if (!id.endsWith('.mdx')) return;

const { data: frontmatter, content: pageContent } = parseFrontmatter(code, id);
const { data: frontmatter, content: pageContent, matter } = parseFrontmatter(code, id);
const frontmatterLines = matter ? matter.match(/\n/g)?.join('') + '\n\n' : '';

const vfile = new VFile({ value: pageContent, path: id });
const vfile = new VFile({ value: frontmatterLines + pageContent, path: id });
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there any risk of this being breaking?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think so, it's only prepending new lines. Do you have something in mind that could break?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I figured that perhaps a remark/hype plugin could be relying on certain positions, but I guess that's unlikely

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm I guess you're right since the mdast/hast nodes do have offset information, but since they only work upon the vfile.value, it should still be fine. Just that if they return any offset values then it'd be incorrect, but I don't think you'd do so in practice, except in the linked issue where the returned error uses line/col instead of offsets.

We could replace the frontmatter with spaces and new lines, but I think maybe for now new lines could be enough and we can monitor it again.

// Ensure `data.astro` is available to all remark plugins
setVfileFrontmatter(vfile, frontmatter);

Expand Down
Loading