@ git- diff- 视图/ 核心
Git diff 处理的核心 diff 引擎,带有语法加亮
特征
- 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- 视图/ 反应 - 反应组件
- @git-diff-view/vue (英语) - Vue 组件
- @ git- diff- view/ file (英语) - 文件比较模式
- @git-diff-view/lowlight (英语) - 默认语法亮点
- @git-diff-view/shiki (英语) - 石基亮点
- @git-diff-view/lezer (英语) - 勒泽突出显示器
许可证
麻省理工学院 万正东先生