perf: improve performance for the includeExplanation option
#701
Conversation
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
✅ Deploy Preview for shiki-next ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for shiki-matsu ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
antfu
changed the title
includeExplanation optionincludeExplanation option
antfu
approved these changes
Jun 15, 2024
renovate bot
referenced
this pull request
in r4ai/r4ai.dev
Jun 16, 2024
[](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [shiki](https://togithub.com/shikijs/shiki) ([source](https://togithub.com/shikijs/shiki/tree/HEAD/packages/shiki)) | [`1.6.4` -> `1.6.5`](https://renovatebot.com/diffs/npm/shiki/1.6.4/1.6.5) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>shikijs/shiki (shiki)</summary> ### [`v1.6.5`](https://togithub.com/shikijs/shiki/releases/tag/v1.6.5) [Compare Source](https://togithub.com/shikijs/shiki/compare/v1.6.4...v1.6.5) ##### 🐞 Bug Fixes - **rehype**: Fix type issues - by [@​remcohaszing](https://togithub.com/remcohaszing) in [https://github.com/shikijs/shiki/issues/699](https://togithub.com/shikijs/shiki/issues/699) [<samp>(0297c)</samp>](https://togithub.com/shikijs/shiki/commit/0297cd94) ##### 🏎 Performance - Improve performance for the `includeExplanation` option - by [@​thetarnav](https://togithub.com/thetarnav) in [https://github.com/shikijs/shiki/issues/701](https://togithub.com/shikijs/shiki/issues/701) [<samp>(966e7)</samp>](https://togithub.com/shikijs/shiki/commit/966e7e40) ##### [View changes on GitHub](https://togithub.com/shikijs/shiki/compare/v1.6.4...v1.6.5) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/r4ai/r4ai.dev). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4zOTMuMCIsInVwZGF0ZWRJblZlciI6IjM3LjM5My4wIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6W119--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
](https://renovatebot.com){kind=link}
diegohaz
referenced
this pull request
in ariakit/ariakit
Jun 18, 2024
[](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [shiki](https://togithub.com/shikijs/shiki) ([source](https://togithub.com/shikijs/shiki/tree/HEAD/packages/shiki)) | [`1.6.4` -> `1.7.0`](https://renovatebot.com/diffs/npm/shiki/1.6.4/1.7.0) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>shikijs/shiki (shiki)</summary> ### [`v1.7.0`](https://togithub.com/shikijs/shiki/releases/tag/v1.7.0) [Compare Source](https://togithub.com/shikijs/shiki/compare/v1.6.5...v1.7.0) ##### 🚀 Features - **core**: Warning on too many instances, close [#​693](https://togithub.com/shikijs/shiki/issues/693) - by [@​antfu](https://togithub.com/antfu) in [https://github.com/shikijs/shiki/issues/693](https://togithub.com/shikijs/shiki/issues/693) [<samp>(412fe)</samp>](https://togithub.com/shikijs/shiki/commit/412fe10e) ##### 🐞 Bug Fixes - **core**: Add missing `UTF8ToString` function, close [#​693](https://togithub.com/shikijs/shiki/issues/693) - by [@​antfu](https://togithub.com/antfu) in [https://github.com/shikijs/shiki/issues/693](https://togithub.com/shikijs/shiki/issues/693) [<samp>(0c891)</samp>](https://togithub.com/shikijs/shiki/commit/0c89157f) ##### [View changes on GitHub](https://togithub.com/shikijs/shiki/compare/v1.6.5...v1.7.0) ### [`v1.6.5`](https://togithub.com/shikijs/shiki/releases/tag/v1.6.5) [Compare Source](https://togithub.com/shikijs/shiki/compare/v1.6.4...v1.6.5) ##### 🐞 Bug Fixes - **rehype**: Fix type issues - by [@​remcohaszing](https://togithub.com/remcohaszing) in [https://github.com/shikijs/shiki/issues/699](https://togithub.com/shikijs/shiki/issues/699) [<samp>(0297c)</samp>](https://togithub.com/shikijs/shiki/commit/0297cd94) ##### 🏎 Performance - Improve performance for the `includeExplanation` option - by [@​thetarnav](https://togithub.com/thetarnav) in [https://github.com/shikijs/shiki/issues/701](https://togithub.com/shikijs/shiki/issues/701) [<samp>(966e7)</samp>](https://togithub.com/shikijs/shiki/commit/966e7e40) ##### [View changes on GitHub](https://togithub.com/shikijs/shiki/compare/v1.6.4...v1.6.5) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/ariakit/ariakit). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy40MTAuMSIsInVwZGF0ZWRJblZlciI6IjM3LjQxMC4xIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6W119--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
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.
This improves the performance for using
codeToTokenswithincludeExplanationoption enabled.I'm working with a file that is 3k lines long, and getting the tokens with explanations was taking way too much time, around 7 to 9 seconds.
Turns out that the
explainThemeScopefunction was redoing a decent amount of work for each token, for each scope, and for each setting, without depending on any of those. So it would be calculated once and reused.Now I get tokens for that file in ~1.5s
Probably could be improved more, but I didn't want to change any logic.