@git-diff-view/file

中文文档
0.1.8发布于 2026/10/15MITTypeScriptESM + CJS近 30 天下载 48.6万

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

中文使用文档
文档目录12 节
  1. 特征
  2. 安装
  3. 使用量
  4. 基本用途
  5. 工人/公务员模式
  6. API 参考
  7. 生成 DiffFile ()
  8. DiffFile 方法
  9. 与 @git-diff- view/ core 的区别
  10. 使用大小写
  11. 相关软件包
  12. 许可证

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

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

npm version npm downloads

直接比较两个文件内容而不使用 git diff hunks 。 这个包包包 diff 财务报告和审定财务报表 @git-diff-view/core 以方便文件对文件的比较.

特征

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

安装

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

使用量

基本用途

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();

工人/公务员模式

// 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 实例 .

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

DiffFile 方法

与 @ git- diff- 视图/ 核心数字 :

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

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

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

使用大小写

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

许可证

麻省理工学院 万正东先生

版本与发布记录

@git-diff-view/file 共发布 38 个版本,首次发布于 2024/04/22;过去 12 个月发布了 14 个版本。

版本发布日期距今
0.1.8latest2026/10/151 个月前
0.1.72026/07/134 个月前
0.1.62026/06/214 个月前
0.1.52026/05/265 个月前
0.1.42026/05/185 个月前
0.1.32026/03/207 个月前

关于 @git-diff-view/file 的常见问题

@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 和提交记录判断。