首页
/ Shiki v3.0.0 发布:现代化代码高亮引擎的重大更新

Shiki v3.0.0 发布:现代化代码高亮引擎的重大更新

2025-06-04 01:40:10作者:毕习沙Eudora

Shiki 是一个基于 TextMate 语法的代码高亮引擎,它能够为开发者提供精准且美观的代码高亮效果。与传统的代码高亮工具不同,Shiki 直接使用 TextMate 语法文件(.tmLanguage),这意味着它可以支持 VS Code 支持的所有语言和主题,提供与编辑器一致的高亮体验。

重大变更

Shiki v3.0.0 带来了几项重要的破坏性变更,开发者需要特别注意:

  1. 移除废弃 API:为了保持代码库的简洁和现代化,v3.0.0 版本移除了之前版本中标记为废弃的 API。这意味着如果项目中仍在使用这些 API,升级后将会出现错误。

  2. 放弃 Node 10 支持:随着 Node.js 生态系统的演进,Shiki 不再支持 Node 10 的 TypeScript 解析。这一变更反映了现代 JavaScript 生态系统的需求,鼓励开发者使用更新的 Node.js 版本。

  3. Twoslash 默认模块解析策略变更:Twoslash(Shiki 的一个功能模块)现在默认使用 bundler 作为模块解析策略,这更好地反映了现代前端构建工具的工作方式。

核心改进

转换器(Transformers)优化

  1. 多余换行符处理:修复了在某些情况下会生成多余换行符的问题,使得代码块的渲染更加精确。

  2. 注释匹配增强:现在能够正确处理嵌套注释的情况,解决了在某些语言中注释内包含注释时的高亮问题。

  3. 单词高亮匹配优化:改进了单词高亮功能的匹配算法,现在能够更准确地定位和突出显示代码中的特定单词。

技术影响分析

对于开发者而言,升级到 Shiki v3.0.0 需要注意以下几点:

  1. 迁移成本:由于移除了废弃 API,项目需要检查并更新相关代码。建议开发者查阅变更日志,了解具体哪些 API 被移除。

  2. 构建环境要求:不再支持 Node 10 意味着开发和生产环境需要升级到更新的 Node.js 版本(建议至少使用 Node 14 或更高版本)。

  3. Twoslash 行为变化:默认模块解析策略的变更可能会影响一些特殊用例,开发者需要测试相关功能是否按预期工作。

升级建议

对于正在使用 Shiki 的项目,建议采取以下步骤进行升级:

  1. 首先检查项目是否使用了任何废弃 API,并进行相应替换。

  2. 确保构建环境满足新的 Node.js 版本要求。

  3. 全面测试代码高亮功能,特别是使用了 Twoslash 或自定义转换器的部分。

  4. 对于大型项目,可以考虑分阶段升级,先升级到最新 v2.x 版本,再迁移到 v3.0.0。

Shiki v3.0.0 的这些变更虽然带来了一些升级成本,但它们为项目的长期维护和性能优化奠定了基础,同时也更好地适应了现代 JavaScript 生态系统的发展趋势。

登录后查看全文
热门项目推荐
相关项目推荐