Skip to content

Commit 8fcbe3f

Browse files
authored
docs: warn in docs that precompiled langs aren't yet supported (#944)
1 parent 4720501 commit 8fcbe3f

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

docs/guide/regex-engines.md

+4
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,10 @@ const jsEngine = createJavaScriptRegexEngine({
8787

8888
Instead of compiling regular expressions on-the-fly, we also provide pre-compiled languages for the JavaScript engine to further reduce startup time.
8989

90+
::: warn
91+
Pre-compiled languages are not yet supported, due to a [known issue](https://github.com/shikijs/shiki/issues/918) that affects many languages. Please use with caution.
92+
:::
93+
9094
::: info
9195
Pre-compiled languages require support for RegExp UnicodeSets (the `v` flag), which requires **ES2024** or Node.js 20+, and may not work in older environments. [Can I use](https://caniuse.com/mdn-javascript_builtins_regexp_unicodesets).
9296
:::

0 commit comments

Comments
 (0)