Preserve HAST element data and properties #1204
Open
+25
−0
Conversation
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
✅ Deploy Preview for shiki-next ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for shiki-matsu ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1204 +/- ##
=======================================
Coverage 95.20% 95.20%
=======================================
Files 92 92
Lines 7922 7923 +1
Branches 1689 1689
=======================================
+ Hits 7542 7543 +1
Misses 374 374
Partials 6 6 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
PR Description
Title
feat(core): preserve HAST data and properties in codeToHast
Description
This PR adds support for preserving HAST
dataand properties when usingcodeToHast.Currently, when
codeToHastgenerates the HAST tree, it creates a newpreelement and does not allow passing customdataor properties to it (other thanmetawhich is handled specifically). This change adds adataproperty toCodeToHastOptionswhich is then assigned to thedataproperty of the rootpreelement in the generated HAST.This is useful for integrations (like
rehype-shikiorremark-rehype) that want to preserve metadata from the original code block (e.g.fileName, positional info) in the generated HAST, allowing other plugins to consume it.Changes
packages/types/src/options.ts: Addeddataproperty toCodeToHastOptionsCommon.packages/core/src/highlight/code-to-hast.ts: UpdatedtokensToHastto assignoptions.datatopreNode.data.Related Issue
Fixes #629 (Preserve HAST element data and properties)
Checklist