@git-diff-view/core

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

@ git- diff- 视图/ 核心

中文使用文档
文档目录11 节
  1. 特征
  2. 安装
  3. 使用量
  4. 基本用途
  5. 高级: 单独初始化
  6. 工人/公务员模式
  7. API 参考
  8. DiffFile 类
  9. 使用大小写
  10. 相关软件包
  11. 许可证

@ git- diff- 视图/ 核心

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

npm version npm downloads

特征

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

安装

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

使用量

基本用途

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

高级: 单独初始化

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

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

工人/公务员模式

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

// 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 类

构造器

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-view/core 共发布 50 个版本,首次发布于 2024/01/30;过去 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 个月前

其他发布通道:beta → 0.0.1-beta.2。

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

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