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

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

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

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

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

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

- 包体积（解压后）：1.4 MB，32 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：4 个
- 首次发布：2024-01-30T02:28:04.512Z
- 最新版本发布：2026-10-15T06:49:33.539Z
- 近 30 天下载量：940425（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：50（近 12 个月 14 个）

## 中文简介

@ git- diff- 视图/ 核心

## 安装

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

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

## README

# @ git- diff- 视图/ 核心

> Git diff 处理的核心 diff 引擎,带有语法加亮

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

## 特征

-   Git diff 解析和处理
-   使用 HAST AST 突出显示语法
-   & 统一视图数据生成
-   相容的网络工作人 / 节点. js
-   QQ 基于捆绑的数据传输
-   QQ 主题支持( 浅/ 暗)

## 安装

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

## 使用量

### 基本用途

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

// Create diff file instance
const file = new DiffFile(
  oldFileName,
  oldContent,
  newFileName,
  newContent,
  hunks,        // git diff hunks
  oldFileLang,  // e.g., "typescript"
  newFileLang
);

// Initialize theme (optional, default: light)
file.initTheme('dark');

// Initialize diff data
file.init();

// Build view data
file.buildSplitDiffLines();      // For split view
file.buildUnifiedDiffLines();    // For unified view
```

### 高级: 单独初始化

```typescript
// For more control over initialization
file.initRaw();      // Parse git diff
file.initSyntax();   // Apply syntax highlighting (optional)

file.buildSplitDiffLines();
file.buildUnifiedDiffLines();
```

### 工人/公务员模式

在单独的线程或服务器中处理 diff 数据以更好的性能 :

```typescript
// Worker/Server side - generate bundle
const file = new DiffFile(/* ... */);
file.initTheme('dark');
file.init();
file.buildSplitDiffLines();
file.buildUnifiedDiffLines();

const bundle = file.getBundle();
// Send bundle to main thread/client

// Main thread/Client side - reconstruct
import { DiffFile } from "@git-diff-view/core";

const mergedFile = DiffFile.createInstance(data, bundle);

// Use with UI components
<DiffView diffFile={mergedFile} />
```

## API 参考

### DiffFile 类

#### 构造器

```typescript
new DiffFile(
  oldFileName: string,
  oldContent: string,
  newFileName: string,
  newContent: string,
  hunks: string[],
  oldFileLang?: string,
  newFileLang?: string
)
```

#### 方法

| 方法 | 说明 |
| --- | --- |
| `initTheme(theme)` | 设定主题 ("光" 或" 暗") |
| `init()` | 初始化 diff 数据(调用 initRaw + initSyntax) |
| `initRaw()` | 解析 git diff 不强调语法 |
| `initSyntax()` | 应用语法加亮 |
| `buildSplitDiffLines()` | 生成分割视图数据 |
| `buildUnifiedDiffLines()` | 生成统一视图数据 |
| `getBundle()` | 用于转让的导出数据 |

#### 静态方法

| 方法 | 说明 |
| --- | --- |
| `createInstance(data, bundle)` | 从捆绑中重建 DiffFile |

## 使用大小写

-   **客户端**: 直接渲染UI框架
-   **工人模式**: 卸载处理到Web Worker
-   **服务器侧**: 预处理 diffs in Node.js, 发送到客户端
-   **混合**: 客户端和服务器处理的混合

## 相关软件包

-   [@ git- diff- 视图/ 反应](https://www.npmjs.com/package/@git-diff-view/react) - 反应组件
-   [@git-diff-view/vue (英语)](https://www.npmjs.com/package/@git-diff-view/vue) - Vue 组件
-   [@ git- diff- view/ file (英语)](https://www.npmjs.com/package/@git-diff-view/file) - 文件比较模式
-   [@git-diff-view/lowlight (英语)](https://www.npmjs.com/package/@git-diff-view/lowlight) - 默认语法亮点
-   [@git-diff-view/shiki (英语)](https://www.npmjs.com/package/@git-diff-view/shiki) - 石基亮点
-   [@git-diff-view/lezer (英语)](https://www.npmjs.com/package/@git-diff-view/lezer) - 勒泽突出显示器

## 许可证

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

## 常见问题

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

@ git- diff- 视图/ 核心

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

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

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

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

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

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

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

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

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

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

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

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

