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

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

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

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

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

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

- 包体积（解压后）：47.9 kB，12 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：5 个
- 首次发布：2024-04-22T03:23:10.422Z
- 最新版本发布：2026-10-15T06:50:52.587Z
- 近 30 天下载量：485840（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：38（近 12 个月 14 个）

## 中文简介

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

## 安装

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

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

## README

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

> 在 @git-diff-view/core上建起的文件内容比较引擎

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

直接比较两个文件内容而不使用 git diff hunks 。 这个包包包 [`diff`](https://github.com/kpdecker/jsdiff) 财务报告和审定财务报表 `@git-diff-view/core` 以方便文件对文件的比较.

## 特征

-   QQ 直接文件内容比较( 不需要 git)
-   使用 diff 生成自动 `diff` 图书馆
-   与 @ git-diff- view/ core 相同的 API
-   使用 HAST AST 突出显示语法
-   & 统一视图支持
-   QQ 主题支持( 浅/ 暗)

## 安装

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

## 使用量

### 基本用途

```typescript
import { generateDiffFile } from "@git-diff-view/file";

// Generate diff from file contents
const file = generateDiffFile(
  "old.ts",      // old file name
  oldContent,    // old file content
  "new.ts",      // new file name
  newContent,    // new file content
  "typescript",  // old file language
  "typescript"   // new file language
);

// Initialize theme
file.initTheme('dark');

// Initialize diff
file.init();

// Build views
file.buildSplitDiffLines();
file.buildUnifiedDiffLines();
```

### 工人/公务员模式

```typescript
// Worker/Server side
import { generateDiffFile, DiffFile } from "@git-diff-view/file";

const file = generateDiffFile(
  oldFileName, oldContent,
  newFileName, newContent,
  oldLang, newLang
);

file.initTheme('dark');
file.init();
file.buildSplitDiffLines();
file.buildUnifiedDiffLines();

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

// Main thread/Client side
const mergedFile = DiffFile.createInstance(data, bundle);

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

## API 参考

### 生成 DiffFile ()

从文件内容生成 DiffFile 实例 .

```typescript
function generateDiffFile(
  oldFileName: string,
  oldContent: string,
  newFileName: string,
  newContent: string,
  oldFileLang?: string,
  newFileLang?: string
): DiffFile
```

### DiffFile 方法

与 [@ git- diff- 视图/ 核心](https://npmcn.com/package/%40git-diff-view/core#api-reference)数字 :

| 方法 | 说明 |
| --- | --- |
| `initTheme(theme)` | 设定主题 ("光" 或" 暗") |
| `init()` | 初始化 diff 数据 |
| `buildSplitDiffLines()` | 生成分割视图数据 |
| `buildUnifiedDiffLines()` | 生成统一视图数据 |
| `getBundle()` | 用于转让的导出数据 |

## 与 @git-diff- view/ core 的区别

| 软件包 | 使用大小写 | 投入 |
| --- | --- | --- |
| `@git-diff-view/core` | Git diff 可视化 | Git diff 猎人 |
| `@git-diff-view/file` | 文件比较 | 原始文件内容 |

## 使用大小写

-   不使用 git 来比较文件版本
-   Diff 编辑器集成
-   在线代码比较工具
-   文件上传比较
-   生活代码 diff

## 相关软件包

-   [@ git- diff- 视图/ 核心](https://www.npmjs.com/package/@git-diff-view/core) - Git diff 模式
-   [@ 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 组件
-   [微调](https://github.com/kpdecker/jsdiff) - 地下 Diff 图书馆

## 许可证

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

## 常见问题

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

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

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

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

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

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

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

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

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

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

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

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

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

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

