-
-
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
Perf: reuse Shiki highlighters per theme/lang #3130
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
'astro': patch | ||
--- | ||
|
||
Updates `<Code />` component to cache and reuse Shiki highlighters |
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
import { getHighlighter as getShikiHighlighter } from 'shiki'; | ||
|
||
// Caches Promise<Highligher> for reuse when the same theme and langs are provided | ||
const _resolvedHighlighters = new Map(); | ||
|
||
function stringify(opts) { | ||
// Always sort keys before stringifying to make sure objects match regardless of parameter ordering | ||
return JSON.stringify(opts, Object.keys(opts).sort()); | ||
} | ||
|
||
export function getHighlighter(opts) { | ||
const key = stringify(opts); | ||
|
||
// Highlighter has already been requested, reuse the same instance | ||
if (_resolvedHighlighters.has(key)) { return _resolvedHighlighters.get(key) } | ||
|
||
// Start the async getHighlighter call and cache the Promise | ||
const highlighter = getShikiHighlighter(opts); | ||
_resolvedHighlighters.set(key, highlighter); | ||
|
||
return highlighter; | ||
} |
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.
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.
Did a bit more poking around and confirmed that this looks like the memory issue was just due to pages being built in parallel. Each page initialized a highlighter and Node couldn't garbage collect them in between page builds
Caching the promise here makes sure that each page gets an immediate response and they can all share the same highlighter instance
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.
ah nice, we had to do this in the remark plugin also, wish we could reuse more logic between teh two!