Shiki项目中如何使用codeToHtml结合transformerMetaHighlight实现代码高亮

在代码高亮工具Shiki中，开发者经常需要实现特定行号的高亮效果。本文将详细介绍如何通过codeToHtml方法和transformerMetaHighlight转换器来实现这一功能。

核心概念解析

Shiki提供了codeToHtml方法用于将代码转换为HTML格式，同时支持通过transformerMetaHighlight转换器处理元数据高亮。这种组合方式特别适合需要精确控制代码行高亮的场景。

实现方法

要使用meta高亮功能，需要按照以下方式配置：

import { codeToHtml } from 'shiki'
import { transformerMetaHighlight } from '@shikijs/transformers'

const code = 'const a = 1'
const html = await codeToHtml(code, {
  lang: 'javascript',
  theme: 'vitesse-dark',
  transformers: [
    transformerMetaHighlight()
  ],
  meta: {
    __raw: '{1,3-4}' // 高亮第1行和第3-4行
  }
})

实现原理

1. meta参数中的__raw属性用于传递原始元数据字符串
2. transformerMetaHighlight会解析这个字符串中的行号信息
3. 解析后的行号会被转换为对应的HTML class
4. 最终生成的HTML会包含这些高亮行的特殊样式

注意事项

1. 行号范围使用逗号分隔不同行或行范围
2. 行范围使用短横线连接起始和结束行号
3. 该方法不直接支持Markdown/MDX语法，仅处理纯代码高亮
4. 对于更复杂的高亮需求，建议考虑使用专门的notation转换器

替代方案

如果项目中使用的是Markdown或MDX，建议使用rehype-shiki等集成方案，这些方案能更好地处理代码块中的元数据。但对于纯JavaScript环境下的代码高亮需求，上述方法是最直接有效的解决方案。

通过这种方式，开发者可以灵活地控制代码高亮效果，为技术文档或代码展示提供更好的视觉体验。