🦋 Changeset detected

Latest commit: 1aa8241

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

✅ Deploy Preview for astro-starlight ready!

Name	Link
🔨 Latest commit	1aa8241
🔍 Latest deploy log	https://app.netlify.com/projects/astro-starlight/deploys/68a065f1647c120008c641c7
😎 Deploy Preview	https://deploy-preview-3380--astro-starlight.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 100 (no change from production) Accessibility: 100 (no change from production) Best Practices: 92 (no change from production) SEO: 100 (no change from production) PWA: - View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

Thanks for the review 🙌

(I also double checked if there‘s a better way to display the suggested config in the error messages, but Astro’s error renderer doesn’t have code block support, so we can’t easily style it any better than this 👍)

Yeah, added a todo about that to play with at some point and see if I can come up with an RFC to improve that, feels like it could be helpful in some cases (and not the first time I wanted something similar).

I also tried playing with different output format, e.g. config vs frontmatter, and while it's easy to distinguish between the two, it gets tricky with frontmatter format between JSON, YAML, and TOML, so I think the JSON format should be a good enough indicator of what the fix should look like.

I also tried playing with different output format

Oh, good point! I didn’t even put two and two together that this same JSON would display also when you make the error in your frontmatter.

I guess we could make the schema dynamic based on where it’s used maybe?

So, head({ format: 'js' }) and head({ format: 'md' }) or something like that return a schema that throws the relevant error? Then we could at least show YAML for frontmatter errors which I guess is the most common syntax (and what we show in our docs).

So, head({ format: 'js' }) and head({ format: 'md' }) or something like that return a schema that throws the relevant error? Then we could at least show YAML for frontmatter errors which I guess is the most common syntax (and what we show in our docs).

We definitely could, that's even how I initially coded it, then thought about the different Markdown possible format and remove it but I can definitely quickly add it back, and decide how we feel about it 👍

thought about the different Markdown possible format

I think Astro only supports YAML and TOML? And TOML is pretty recent and I’d guess fairly rare? So YAML seems a safe bet to me.

And TOML is pretty recent and I’d guess fairly rare?

And I assume that one is even more rare 😅

Updated the PR with the discussed changes, here is the new output:

with attrs	without attrs

While the JSON output seems fine, I wonder if for the YAML one, we should not include more context, e.g.:

head:
  - tag: meta
    attrs:
      name: test:id
      content: '1234'

Instead of just:

tag: meta
attrs:
  name: test:id
  content: '1234'

I also wonder if the start of the sentence should be different between the two cases, e.g.:

The \`head\` configuration includes…

The \`head\` frontmatter field includes…

Any thoughts on this?

While the JSON output seems fine, I wonder if for the YAML one, we should not include more context

I actually like the current one from the screenshots. If you include the head: line, it might look like it’s the first item always? Although maybe the - could be helpful?

- tag: meta
  attrs:
    name: test:id
    content: '1234'

Definitely would be clearer with some code block styling to distinguish it.

I also wonder if the start of the sentence should be different between the two cases

I’m fairly neutral here as “configuration” could be interpreted OK in the frontmatter context where the lines above show more clearly that it’s about the specific entry. But yeah “frontmatter field” does slightly more hint where to look.

Although maybe the - could be helpful?

- tag: meta
  attrs:
    name: test:id
    content: '1234'

Definitely would be clearer with some code block styling to distinguish it.

Awesome idea, just pushed that change which I think is enough now.