Skip to content
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.

Sign up for GitHub

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

feat(engine-js): update deps, support more languages #890

Merged
merged 2 commits into from
Jan 15, 2025
Merged

feat(engine-js): update deps, support more languages #890

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
505d92c
feat(engine-js): update deps, support more languages
slevithan Jan 14, 2025
568c7a7
chore: update snapshot
antfu Jan 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions docs/guide/regex-engines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,6 @@ const html = shiki.codeToHtml('const a = 1', { lang: 'javascript', theme: 'nord'

The advantages of using the JavaScript engine are that it doesn't require loading a large WebAssembly file for Oniguruma and it is faster for some grammars (since the regular expressions run as native JavaScript).

Although the JavaScript engine's Oniguruma emulation is quite robust, it's not guaranteed that the highlighting will be 100% the same in some edge cases. Additionally, a few grammars are unsupported.

Please check the [compatibility table](/references/engine-js-compat) for the support status of languages you are using.

The JavaScript engine is strict by default, and will throw an error if it encounters a pattern that it cannot convert. If mismatches are acceptable and you want best-effort results for unsupported grammars, you can enable the `forgiving` option to suppress any conversion errors:
Expand All @@ -68,7 +66,7 @@ const jsEngine = createJavaScriptRegexEngine({ forgiving: true })
```

::: info
If you run Shiki on Node.js (or at build time) and bundle size or WebAssembly support is not a concern, we still recommend using the Oniguruma engine for best results.
If you run Shiki on Node.js (or at build time) and bundle size or WebAssembly support is not a concern, we still recommend using the Oniguruma engine.

The JavaScript engine is best when running in the browser and in cases when you want to control the bundle size.
:::
Expand Down
22 changes: 11 additions & 11 deletions docs/references/engine-js-compat.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,19 @@

Compatibility reference of all built-in grammars with the [JavaScript RegExp engine](/guide/regex-engines#javascript-regexp-engine).

> Generated on Monday, January 13, 2025
> Generated on Tuesday, January 14, 2025
>
> Version `1.26.1`
> Version `1.27.0`
>
> Runtime: Node.js v22.12.0
> Runtime: Node.js v22.11.0

## Report Summary

| | Count |
| :-------------- | --------------------------: |
| Total Languages | 219 |
| Supported | [212](#supported-languages) |
| Mismatched | [1](#mismatched-languages) |
| Supported | [213](#supported-languages) |
| Mismatched | [0](#mismatched-languages) |
| Unsupported | [6](#unsupported-languages) |

## Supported Languages
Expand Down Expand Up @@ -147,6 +147,7 @@ In some edge cases, it's not guaranteed that the highlighting will be 100% the s
| move | ✅ OK | 120 | - | |
| narrat | ✅ OK | 34 | - | |
| nextflow | ✅ OK | 32 | - | |
| nginx | ✅ OK | 378 | - | |
| nim | ✅ OK | 1130 | - | |
| nix | ✅ OK | 80 | - | |
| nushell | ✅ OK | 81 | - | |
Expand Down Expand Up @@ -204,7 +205,7 @@ In some edge cases, it's not guaranteed that the highlighting will be 100% the s
| talonscript | ✅ OK | 44 | - | |
| tasl | ✅ OK | 23 | - | |
| tcl | ✅ OK | 34 | - | |
| templ | ✅ OK | 680 | - | |
| templ | ✅ OK | 682 | - | |
| terraform | ✅ OK | 68 | - | |
| tex | ✅ OK | 106 | - | |
| toml | ✅ OK | 44 | - | |
Expand Down Expand Up @@ -246,11 +247,10 @@ In some edge cases, it's not guaranteed that the highlighting will be 100% the s

## Mismatched Languages

Languages that do not throw with the JavaScript RegExp engine, but will produce different results than the WASM engine. Please use with caution.
Languages that do not throw with the JavaScript RegExp engine, but will produce different results than the WASM engine.

| Language | Highlight Match | Patterns Parsable | Patterns Failed | Diff |
| -------- | :------------------------------------------------------------------------- | ----------------: | --------------: | ---: |
| nginx | [🚧 Mismatch](https://textmate-grammars-themes.netlify.app/?grammar=nginx) | 378 | - | 122 |
| Language | Highlight Match | Patterns Parsable | Patterns Failed | Diff |
| -------- | :-------------- | ----------------: | --------------: | ---: |

## Unsupported Languages

Expand All @@ -262,5 +262,5 @@ Languages that throw with the JavaScript RegExp engine, either because they cont
| sass | ✅ OK | 67 | 2 | |
| purescript | ❌ Error | 72 | 1 | |
| csharp | ❌ Error | 310 | 3 | 137 |
| swift | ❌ Error | 326 | 3 | 8 |
| swift | ❌ Error | 326 | 3 | |
| razor | ❌ Error | 957 | 5 | |
3 changes: 0 additions & 3 deletions packages/engine-javascript/src/engine-compile.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,6 @@ export function defaultJavaScriptRegexConstructor(pattern: string, options?: Oni
asciiWordBoundaries: true,
// Follow `vscode-oniguruma` which enables this Oniguruma option by default
captureGroup: true,
// Removing `\G` anchors in cases when they're not supported for emulation allows
// supporting more grammars, but also allows some mismatches
ignoreUnsupportedGAnchors: true,
// Oniguruma uses depth limit `20`; lowered here to keep regexes shorter and maybe
// sometimes faster, but can be increased if issues reported due to low limit
recursionLimit: 5,
Expand Down
12 changes: 9 additions & 3 deletions packages/langs-precompiled/scripts/__snapshots__/precompile.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,9 @@ exports[`precompile 1`] = `
],
},
},
end: /(?<=^|\\n(?!$))(?=\\P{space})|(?!)/dgv,
end: new EmulatedRegExp("(?<=^|\\\\n(?!$))(?=\\\\P{space})|(?!^)", "dgv", {
strategy: "search_start_clip",
}),
patterns: [
{
begin: /(?<=^|\\n(?!$))([ ]+)(?! )/dgv,
Expand All @@ -110,7 +112,9 @@ exports[`precompile 1`] = `
beginCaptures: {
"1": { name: "punctuation.whitespace.comment.leading.yaml" },
},
end: new EmulatedRegExp("", "dgv", { strategy: "not_search_start" }),
end: new EmulatedRegExp("(?!^)", "dgv", {
strategy: "search_start_clip",
}),
patterns: [
{
begin: /#/dgv,
Expand Down Expand Up @@ -373,7 +377,9 @@ exports[`precompile 1`] = `
node: { patterns: [{ include: "#block-node" }] },
property: {
begin: /(?=!|&)/dgv,
end: new EmulatedRegExp("", "dgv", { strategy: "not_search_start" }),
end: new EmulatedRegExp("(?!^)", "dgv", {
strategy: "search_start_clip",
}),
name: "meta.property.yaml",
patterns: [
{
Expand Down
14 changes: 7 additions & 7 deletions pnpm-lock.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion pnpm-workspace.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ catalog:
monaco-editor-core: ^0.52.2
ofetch: ^1.4.1
ohash: ^1.1.4
oniguruma-to-es: ^1.0.0
oniguruma-to-es: ^2.0.0
picocolors: ^1.1.1
pinia: ^2.3.0
pnpm: ^9.15.4
Expand Down
2 changes: 1 addition & 1 deletion scripts/report-engine-js-compat.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ async function run() {
'',
'## Mismatched Languages',
'',
'Languages that do not throw with the JavaScript RegExp engine, but will produce different results than the WASM engine. Please use with caution.',
'Languages that do not throw with the JavaScript RegExp engine, but will produce different results than the WASM engine.',
'',
createTable(reportMismatch),
'',
Expand Down
Loading