Repository navigation
Clean up Astro metadata in vfile.data - #11861
Merged
Merged
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 |
Princesseuh
approved these changes
Sep 2, 2024
bluwy
commented
Sep 2, 2024
sarah11918
approved these changes
Sep 2, 2024
sarah11918
left a comment
Member
There was a problem hiding this comment.
Looks great @bluwy ! Just some minor grammar nits
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changes
Renames
vfile.data.__astroHeadings->vfile.data.astro.headingsvfile.data.imagePaths->vfile.data.astro.imagePathsfor handling markdown/mdx in remark/rehype plugins. This makes the APIs more consistent.
Also removed some internal APIs related to retrieving
vfile.data.astroand validating frontmatter. And exposedisFrontmatterValidfor 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.