Shiki项目在Safari浏览器中的语法高亮异常问题解析

问题背景

Shiki作为一款流行的代码语法高亮工具，近期在Safari浏览器中出现了异常表现。具体表现为：当使用JavaScript引擎进行语法高亮时，在Safari浏览器中会出现高亮错误，而Chrome等其他浏览器则表现正常。这一问题在Shiki 3.2.0及以上版本中出现，且仅在使用JavaScript引擎时发生。

问题现象

在Safari浏览器中，特别是当使用服务器端渲染(SSR)和客户端水合(hydration)时，语法高亮会出现以下异常：

1. 高亮区域不正确，部分语法元素未被正确识别
2. 在某些情况下，文本内容会被错误地复制到行末
3. 问题在SSR阶段表现正常，但在客户端水合后出现异常

相比之下，Chrome浏览器和WebKit内核在完整页面加载前都能正确显示高亮效果。

技术分析

经过深入调查，发现问题根源在于WebKit引擎对正则表达式v标志的处理存在缺陷。具体表现为：

1. 正则表达式v标志问题：WebKit在处理嵌套的否定字符类时存在错误。例如，正则表达式/[a[^a-z]]/v在WebKit中会错误地匹配字符'b'，而无法正确匹配字符'!'。

2. 版本依赖关系：

   • Shiki 3.2.0开始使用Oniguruma-To-ES 4.1.0及以上版本
   • 问题与tm-grammars 1.23.1版本引入的变更有关
   • 该版本引入了oniguruma-parser正则表达式优化器，导致大量正则表达式发生变化

3. 引擎差异：

   • 使用Oniguruma引擎时表现正常
   • 仅在使用JavaScript引擎时出现问题
   • 将JavaScript引擎目标设置为'ES2018'可以规避此问题

解决方案

针对这一问题，开发者采取了以下解决方案：

1. Oniguruma-To-ES修复：在Oniguruma-To-ES 4.3.3版本中，对嵌套的否定字符类进行了特殊处理，将其转换为与u标志兼容的形式。例如，将[a[^a-z]]转换为(?:[a]|[^a-z])。

2. 临时解决方案：

   • 使用Oniguruma引擎替代JavaScript引擎
   • 将JavaScript引擎目标显式设置为'ES2018'
   • 对于SSR应用，确保服务器端和客户端使用相同的引擎

最佳实践建议

1. 版本选择：确保使用包含修复的Oniguruma-To-ES 4.3.3及以上版本。

2. 引擎配置：在Safari占比较高的用户群体中，考虑统一使用Oniguruma引擎或设置ES2018目标。

3. 测试策略：在跨浏览器测试中，特别关注Safari下的语法高亮表现。

4. 问题监测：关注WebKit引擎的更新，特别是对正则表达式v标志处理的改进。

总结

这一案例展示了浏览器引擎差异可能导致的复杂问题。作为开发者，我们需要：

1. 充分理解所依赖工具的技术实现细节
2. 建立完善的跨浏览器测试机制
3. 保持对上游问题的关注和反馈
4. 在技术选型时考虑浏览器兼容性因素

通过这次问题的分析和解决，Shiki项目在浏览器兼容性方面又迈出了重要一步，为开发者提供了更可靠的语法高亮解决方案。