在VS Code扩展中集成Shiki语法高亮的实践指南

背景介绍

Shiki是一个基于TextMate语法的代码高亮工具，它能够提供与VS Code编辑器一致的语法高亮效果。许多VS Code扩展开发者希望将Shiki集成到自己的扩展中，以实现高质量的代码展示功能。然而，在将Shiki打包到VSIX扩展文件中时，开发者常常会遇到模块缺失或功能异常的问题。

核心挑战

当开发者尝试将Shiki集成到VS Code扩展中时，主要面临两个技术难点：

1. 动态导入问题：Shiki的语言和主题文件采用动态导入方式，VS Code的打包工具(vsce)可能无法正确识别这些依赖

2. WASM安全限制：Shiki底层依赖WebAssembly模块，需要正确处理WASM文件的加载和安全策略

解决方案

1. 使用Shiki的标准API

避免使用深层导入路径，转而使用Shiki提供的高级API。这种方式更加稳定且易于维护：

import { createHighlighter } from "shiki";

const highlighter = await createHighlighter({
  themes: ["github-dark", "github-light"],
  langs: ["python", "javascript", "typescript"]
});

const html = await highlighter.codeToHtml(code, {
  lang: "python",
  theme: "github-dark"
});

2. 配置Vite构建工具

在基于webview的UI部分，需要正确配置Vite以处理WASM文件：

// vite.config.ts
export default defineConfig({
  plugins: [
    {
      name: "wasm",
      async load(id) {
        if (id.endsWith(".wasm")) {
          const wasmBinary = await import(id);
          return `
            const wasmModule = new WebAssembly.Module(${wasmBinary});
            export default wasmModule;
          `;
        }
      }
    }
  ],
  assetsInclude: ["**/*.wasm"]
});

3. 内容安全策略(CSP)配置

虽然最初尝试使用wasm-unsafe-eval可以解决问题，但这不是最佳实践。通过正确配置构建工具和加载方式，可以避免使用这个不安全的策略。

最佳实践建议

1. 明确声明依赖：在package.json中明确列出所有需要的Shiki语言包和主题

2. 错误处理：为Shiki的高亮操作添加完善的错误处理逻辑，确保在异常情况下有合理的降级方案

3. 主题适配：根据VS Code当前主题自动切换Shiki的亮/暗主题，保持UI一致性

4. 性能优化：考虑预加载常用语言的高亮器，减少用户首次使用时的等待时间

实现效果

通过上述方法实现的Shiki集成能够：

• 在开发调试和生产打包环境下一致工作
• 支持多种编程语言的语法高亮
• 自动适配VS Code的当前主题
• 不依赖不安全的内容安全策略

总结

在VS Code扩展中集成Shiki需要特别注意模块打包和WASM处理的问题。通过使用Shiki的标准API、合理配置构建工具以及完善错误处理，开发者可以构建出稳定可靠的代码高亮功能。这种方法不仅解决了打包问题，还为未来的功能扩展和维护奠定了良好的基础。