fix: show file name with invalid frontmatter errors for MDX #12355
Conversation
github-actions
bot
added
the
pkg: astro
| @@ -232,7 +234,7 @@ async function syncContentCollections( | |||
| { | |||
| ...AstroErrorData.GenerateContentTypesError, | |||
| hint, | |||
| message: AstroErrorData.GenerateContentTypesError.message(safeError.message), | |||
| message: AstroErrorData.GenerateContentTypesError.message(`${safeError.message} in ${fileId}`), | |||
There was a problem hiding this comment.
instead of using the file id in the message, you could pass it under loc
There was a problem hiding this comment.
Sure, I will do that.
There was a problem hiding this comment.
removed fileId and added location
Co-authored-by: Emanuele Stoppa <[email protected]>
It seems to be an existing issue with how AstroError uses location. Do I need to address this in this PR, or should I pass the location information differently? |
|
Pushed a few changes to improve errors with sync in general, it was using a lot of custom code to do things we already have.
|
| await sync({ flags }); | ||
| return; |
There was a problem hiding this comment.
We already have a global handler for CLI that handles more stuff (telemetry, error formatting etc) so this wasn't really useful.
| if (showFullStacktrace && err.loc) { | ||
| output.push(` ${bold('Location:')}`); | ||
| output.push(` ${underline(`${err.loc.file}:${err.loc.line ?? 0}:${err.loc.column ?? 0}`)}`); | ||
| } |
There was a problem hiding this comment.
This was something removed by Fred's previous pass on errors making them shorter 😃
I added it back, but only when the full stack trace is shown (which is either in debug in dev, or on full crashes in the CLI), so it should be shown in only contexts where it's not available elsewhere.
Changes
-
astro builddoes not report which file has an invalid frontmatter for MDX files.This PR fixes that.
After the fix, the error looks like the below:
Closes #12352
Testing
It was manually tested by running a local build.
Docs
Not needed as it just enhances existing error messages.