feat: synchronous Shiki usage #764
Merged
+337
−181
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 PR introduces two exports
createShikiInternalSync
andcreateHighlighterCoreSync
that allow completely synchronous usage of Shiki. (made possible by forkingvscode-textmate
as https://github.com/shikijs/vscode-textmate)For example:
These APIs require explicit
engine
field to be provided, and alllangs
andthemes
should be provided as already-resolved objects. Combining with #761, it's able to achieve full synchronous.If you still want to use Oniguruma, it's also possible if you are able to init the engine beforehand:
Additionally, this PR also provides two additional properties to the highlighter instance,
loadThemeSync
andloadLanugageSync
:Note
Note that these features are only available to the fine-grain bundle, the main bundled usage would still need asynchronous to load langs/themes on-demand.