BlockNote代码块功能优化：如何减少语言支持带来的包体积膨胀

在富文本编辑器BlockNote中，代码块功能是其核心特色之一。该功能基于Shiki语法高亮库实现，支持多种编程语言的语法高亮显示。然而，随着支持语言的增加，这可能会带来显著的包体积膨胀问题，影响应用的加载性能。

问题背景

BlockNote默认会包含大量编程语言的语法高亮支持，这些语言文件会被打包到最终的生产构建中。虽然这些资源是按需加载的，但它们仍然会增加部署包的整体大小。对于需要优化部署体积或对资源使用有严格限制的应用来说，这是一个需要解决的问题。

解决方案

目前有两种主要方法可以优化这一问题：

1. 使用构建工具配置排除特定语言

对于使用Rollup或Webpack等模块打包工具的项目，可以通过配置external选项来排除不需要的语言文件。例如，在Vite配置中可以这样设置：

export default defineConfig({
  build: {
    rollupOptions: {
      external: (source) => {
        // 排除JavaScript语言支持
        if(source.includes("shiki/dist/langs/javascript")) {
          return true;
        }
        return false;
      }
    }
  }
})

这种方法需要开发者明确知道要排除哪些语言文件，并且需要配合BlockNote的代码块配置一起使用。

2. 自定义代码块支持的语言列表

BlockNote提供了customizeCodeBlockAPI，允许开发者精确控制支持哪些编程语言。配置示例如下：

const schema = BlockNoteSchema.create({
  blockSpecs: {
    ...defaultBlockSpecs,
    codeBlock: customizeCodeBlock({
      defaultLanguage: "javascript",
      supportedLanguages: [
        {
          id: "javascript",
          match: ["javascript", "js"],
          name: "JavaScript",
        },
        {
          id: "typescript",
          match: ["typescript", "ts"],
          name: "TypeScript",
        }
      ],
    }),
  },
});

这种方式不仅减少了不必要的语言支持，还能自定义语言的显示名称和匹配别名。

深入优化建议

1. 主题优化：除了语言文件外，Shiki的主题文件也会增加包体积。可以考虑排除未使用的主题文件。

2. 默认语言集合：BlockNote可以考虑提供一个默认语言集合的导出，方便开发者基于默认集合进行过滤，而不是从头开始配置。

3. 类型增强：当前API支持SupportedLanguageConfig类型，未来可以考虑同时支持简单的字符串ID形式，降低使用门槛。

实施注意事项

1. 确保使用的BlockNote版本包含相关优化（如#1219合并后的版本）。

2. 排除语言文件后，需要通过customizeCodeBlock明确配置支持的语言列表，否则可能导致功能异常。

3. 对于团队项目，建议将代码块配置集中管理，避免散落在多处。

通过以上优化措施，开发者可以在保留BlockNote强大代码块功能的同时，有效控制最终打包体积，实现性能与功能的平衡。