# @git-diff-view/shiki 中文文档

规范地址：https://npmcn.com/package/%40git-diff-view/shiki/

版本：0\.1\.8
npm 元数据更新时间：2026-10-15T06:49:01.876Z
中文译文更新时间：2026-11-16T10:21:17.314Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40git-diff-view/shiki
原文对照：https://npmcn.com/package/%40git-diff-view/shiki/?lang=original
项目主页：https://mrwangjusttodo.github.io/git-diff-view
源码仓库：https://github.com/MrWangJustToDo/git-diff-view

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：93.9 kB，9 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2024-03-22T06:22:47.164Z
- 最新版本发布：2026-10-15T06:49:01.451Z
- 近 30 天下载量：112249（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：41（近 12 个月 14 个）

## 中文简介

@git-diff-view/shiki (英语)

## 安装

```sh
npm install @git-diff-view/shiki
```

也可以使用：`pnpm add @git-diff-view/shiki`、`yarn add @git-diff-view/shiki`、`bun add @git-diff-view/shiki`

## README

# @git-diff-view/shiki (英语)

> 使用 Shiki 查看 @ git- diff- 视图的高级语法亮点

[![npm version](https://img.shields.io/npm/v/@git-diff-view/shiki)](https://www.npmjs.com/package/@git-diff-view/shiki) [![npm downloads](https://img.shields.io/npm/dm/@git-diff-view/shiki)](https://www.npmjs.com/package/@git-diff-view/shiki)

使用替代语法提示器 [志纪](https://shiki.style/) 用于以 TextMate 语法和 VSCode 主题更精确地突出.

## 特征

-   VSCode 质量语法突出显示
-   QQ TextMate 语法支持
-   VSCode 相容主题
-   QQ 更准确的语言支持
-   彩色忠诚
-   QQ 启动

## 安装

```bash
npm install @git-diff-view/shiki
# or
pnpm add @git-diff-view/shiki
# or
yarn add @git-diff-view/shiki
```

## 使用量

### 基本用途

```typescript
import { DiffFile } from "@git-diff-view/core";
import { getDiffViewHighlighter } from "@git-diff-view/shiki";

const diffFile = new DiffFile(
  oldFileName,
  oldContent,
  newFileName,
  newContent,
  hunks,
  "typescript",
  "typescript"
);

// Initialize raw diff data first
diffFile.initRaw();

// Get Shiki highlighter (async)
const highlighter = await getDiffViewHighlighter();

// Apply syntax highlighting with Shiki
diffFile.initSyntax({ registerHighlighter: highlighter });

// Build views
diffFile.buildSplitDiffLines();
diffFile.buildUnifiedDiffLines();

// Get bundle
const bundle = diffFile.getBundle();
```

### 带有自定义 Shiki 配置

```typescript
import { getDiffViewHighlighter } from "@git-diff-view/shiki";

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

diffFile.initSyntax({ registerHighlighter: highlighter });
```

## API 参考

### 获取 DiffView 高亮度 ()

获取配置的 Shiki 亮点实例 .

```typescript
async function getDiffViewHighlighter(
  options?: ShikiOptions
): Promise<Highlighter>
```

#### 选项

接受标准 [Shiki 配置选项](https://shiki.style/guide/install)。 。 。 .

## 比较

| 特性 | @git-diff-view/lowlight (英语) | @git-diff-view/shiki (英语) | @git-diff-view/lezer (英语) |
| --- | --- | --- | --- |
| 默认 | \* 内建 | 分离软件包 | 分离软件包 |
| 设置 | 不需要设置 | 同步初始化 | 同步剖析 / aync API |
| 准确性 | 不错 | 优秀( VSCode- 级别) | 强 (LR 语法) |
| 主题 | 突出显示.js 主题 | VSCode 主题 | GitHub 类似 CSS 变量 |
| 套装大小 | 小一点 | 大一点 | 中 (每语) |
| 刚才 | 没有 | 可选 | 没有 |
| 限制运行时间 | 有限 | 有限 | 更强的合身 |

## 何时使用

使用 **@git-diff-view/shiki (英语)** 需要时:

-   VSCode 质量语法突出显示
-   准确的语言语法
-   VSCode 兼容主题
-   更好的颜色忠贞

使用 **@git-diff-view/lowlight (英语)** (默认)当:

-   您想要零配置
-   套装大小很关键
-   选择同步初始化
-   基本强调就够了

使用 **[@git-diff-view/lezer (英语)](https://npmcn.com/package/%40git-diff-view/lezer)** 当:

-   您需要纯 JS 解析器( 无 WASM / 节点)
-   锁定 Lynx 等有限的运行时间
-   CodeMiror 质量 LR 语法足够了

## 相关软件包

-   [@ git- diff- 视图/ 核心](https://www.npmjs.com/package/@git-diff-view/core) - 核心diff发动机
-   [@git-diff-view/lowlight (英语)](https://www.npmjs.com/package/@git-diff-view/lowlight) - 默认亮点
-   [@git-diff-view/lezer (英语)](https://www.npmjs.com/package/@git-diff-view/lezer) - 勒泽突出显示器
-   [志纪](https://shiki.style/) - 地下图书馆

## 许可证

麻省理工学院 [万正东先生](https://github.com/MrWangJustToDo)

## 常见问题

### @git-diff-view/shiki 是什么？

@git-diff-view/shiki \(英语\)

### 如何安装 @git-diff-view/shiki？

在项目目录运行 npm install @git-diff-view/shiki，或使用 pnpm add / yarn add / bun add。

### @git-diff-view/shiki 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @git-diff-view/shiki 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @git-diff-view/shiki 可以商用吗？

@git-diff-view/shiki 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @git-diff-view/shiki 的下载量有多少？

根据 npm 官方下载统计，@git-diff-view/shiki 在 2026/10/17 – 2026/11/15 这 30 天内被下载 112,249 次，日均约 3,742 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @git-diff-view/shiki 还在维护吗？

最新版本 0\.1\.8 发布于 2026/10/15（1 个月前）；至今共发布 41 个版本，其中过去 12 个月发布了 14 个；首次发布于 2024/03/22。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

