-
-
Notifications
You must be signed in to change notification settings - Fork 2.6k
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.
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
Clean up Astro metadata in vfile.data #11861
Conversation
🦋 Changeset detectedLatest commit: 47c8e57 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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This PR is blocked because it contains a major
changeset. A reviewer will merge this at the next release if approved.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great @bluwy ! Just some minor grammar nits
Co-authored-by: Sarah Rainsberger <[email protected]>
Changes
Renames
vfile.data.__astroHeadings
->vfile.data.astro.headings
vfile.data.imagePaths
->vfile.data.astro.imagePaths
for handling markdown/mdx in remark/rehype plugins. This makes the APIs more consistent.
Also removed some internal APIs related to retrieving
vfile.data.astro
and validating frontmatter. And exposedisFrontmatterValid
for internal use. This makes some flow more direct.Testing
Existing tests should pass.
Docs
Add a main changeset (
.changeset/clean-donuts-walk.md
) explaining the breaking changes for users who depend on the previous API.