@git-diff-view/core

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

@git-diff-view/core

原始使用文档
文档目录11 节
  1. Features
  2. Installation
  3. Usage
  4. Basic Usage
  5. Advanced: Separate Initialization
  6. Worker/Server Pattern
  7. API Reference
  8. DiffFile Class
  9. Use Cases
  10. Related Packages
  11. License

@git-diff-view/core

Core diff engine for git diff processing with syntax highlighting

npm version npm downloads

Features

  • ✅ Git diff parsing and processing
  • ✅ Syntax highlighting with HAST AST
  • ✅ Split & Unified view data generation
  • ✅ Web Worker / Node.js compatible
  • ✅ Bundle-based data transfer
  • ✅ Theme support (light/dark)

Installation

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

Usage

Basic Usage

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

Advanced: Separate Initialization

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

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

Worker/Server Pattern

Process diff data in a separate thread or server for better performance:

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

DiffFile Class

Constructor

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

Methods

MethodDescription
initTheme(theme)Set theme ('light' or 'dark')
init()Initialize diff data (calls initRaw + initSyntax)
initRaw()Parse git diff without syntax highlighting
initSyntax()Apply syntax highlighting
buildSplitDiffLines()Generate split view data
buildUnifiedDiffLines()Generate unified view data
getBundle()Export data for transfer

Static Methods

MethodDescription
createInstance(data, bundle)Reconstruct DiffFile from bundle

Use Cases

  • Client-side: Direct rendering with UI frameworks
  • Worker pattern: Offload processing to Web Worker
  • Server-side: Pre-process diffs in Node.js, send to client
  • Hybrid: Mix of client and server processing

License

MIT © MrWangJustToDo

版本与发布记录

@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-view/core

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