正则表达式引擎

TextMate 语法基于匹配标记的正则表达式。更具体地说，它们假设将使用 Oniguruma （一个用 C 编写的强大正则表达式引擎）来解释正则表达式。为了在 JavaScript 中实现这一点，我们将 Oniguruma 编译为 WebAssembly 以在浏览器或 Node.js 中运行。

自 v1.15 起，我们提供了让用户切换正则表达式引擎或提供自定义实现的功能。要实现这一点，请在 createHighlighter 或 createHighlighterCore 中添加 engine 选项。例如：

import { createHighlighter } from 'shiki'

const shiki = await createShiki({
  themes: ['nord'],
  langs: ['javascript'],
  engine: { /* custom engine */ }
})

Shiki 附带两个内置引擎：

Oniguruma 引擎

这是默认的引擎，使用编译后的 Oniguruma WebAssembly。

import { createHighlighter } from 'shiki'
import { createOnigurumaEngine } from 'shiki/engine/oniguruma'

const shiki = await createShiki({
  themes: ['nord'],
  langs: ['javascript'],
  engine: createOnigurumaEngine(import('shiki/wasm'))
})

JavaScript 正则表达式引擎

该引擎使用 JavaScript 的原生 RegExp。由于 TextMate 语法使用的正则表达式是为 Oniguruma 编写的，因此它们可能包含 JavaScript 的 RegExp 不支持的语法，或者对相同语法的行为期待不同。因此，我们使用 Oniguruma-To-ES 将 Oniguruma 模式转译为原生 JavaScript 正则表达式。

import { createHighlighter } from 'shiki'
import { createJavaScriptRegexEngine } from 'shiki/engine/javascript'

const jsEngine = createJavaScriptRegexEngine()

const shiki = await createHighlighter({
  themes: ['nord'],
  langs: ['javascript'],
  engine: jsEngine
})

const html = shiki.codeToHtml('const a = 1', { lang: 'javascript', theme: 'nord' })

使用 JavaScript 引擎的优点是它不需要加载一个大型的 WebAssembly 文件用于 Oniguruma，并且对于某些语法来说运行速度更快（因为正则表达式作为本地 JavaScript 运行）。

请检查 兼容性表 以了解您正在使用的语言的支持状态。

JavaScript 引擎默认是严格的，如果遇到无法转换的模式，它会抛出错误。如果不匹配是可以接受的，并且您希望对不支持的语法进行尽力而为的结果，可以启用 forgiving 选项以抑制任何转换错误：

const jsEngine = createJavaScriptRegexEngine({ forgiving: true })
// ...使用引擎

INFO

如果您在 Node.js（或构建时）运行 Shiki，并且包大小或 WebAssembly 支持不是问题，我们仍然建议使用 Oniguruma 引擎。

JavaScript 引擎在浏览器中运行时及当您想要控制包大小时效果最佳。

JavaScript 运行时目标

为了获得最佳效果，JavaScript 引擎使用 RegExp 的 v 标志，该标志在 Node.js v20+ 和 ES2024 中可用 (浏览器兼容性)。对于较旧的环境，它会自动改用 u 标志，但这会导致支持的语法减少。

默认情况下，运行时目标会自动检测。您可以通过设置 target 选项来覆盖此行为：

const jsEngine = createJavaScriptRegexEngine({
  target: 'ES2018', // or 'auto' (default), 'ES2024', 'ES2025'
})