chore: migrate to shiki for syntax highlighting #4840
Merged
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.
What does this PR do?
react-syntax-highlighter
has some vulnerabilities based on its use of an outdated prismjs and refractor (which uses prismjs). It no longer appears thatreact-syntax-highlighter
is being maintained so its time for a new syntax highlighter.There are several options out there but shiki appears to be the library that many are moving towards. Upon review, it provides several benefits for us with only main con:
react-syntax-highlighter
io
package (raw: ~450k to ~1000k / gzip: ~148k to ~240k)Given the gzip impact is small enough, this PR:
shiki
, removingreact-syntax-highlighter
js/ts/css/json/yaml/css
syntax highlighting in markdown/code components (previously we only supportedjs/ts/yaml
Testing
Manual testing confirms, ci & e2e will cover rest.
Before Markdown Component
After Markdown Component
Before Code Panel
After Code Panel