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.

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

Merged
merged 8 commits into from
Sep 2, 2024
Merged

Clean up Astro metadata in vfile.data #11861

merged 8 commits into from
Sep 2, 2024

Conversation

bluwy
Copy link
Member

@bluwy bluwy commented Aug 28, 2024

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 exposed isFrontmatterValid 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.

Copy link

changeset-bot bot commented Aug 28, 2024

🦋 Changeset detected

Latest 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

@github-actions github-actions bot added feat: markdown Related to Markdown (scope) pkg: integration Related to any renderer integration (scope) pkg: astro Related to the core `astro` package (scope) semver: major Change triggers a `major` release labels Aug 28, 2024
Copy link
Contributor

@github-actions github-actions bot left a 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.

.changeset/clean-donuts-walk.md Outdated Show resolved Hide resolved
Copy link
Member

@sarah11918 sarah11918 left a 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

.changeset/clean-donuts-walk.md Outdated Show resolved Hide resolved
.changeset/clean-donuts-walk.md Outdated Show resolved Hide resolved
@bluwy bluwy merged commit 3ab3b4e into next Sep 2, 2024
13 checks passed
@bluwy bluwy deleted the plt-1897-vfile-data branch September 2, 2024 13:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feat: markdown Related to Markdown (scope) pkg: astro Related to the core `astro` package (scope) pkg: integration Related to any renderer integration (scope) semver: major Change triggers a `major` release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants