@haklex/rich-diff-core

中文文档
0.66.0发布于 2026/11/15MITTypeScriptES Module零依赖构建来源已验证近 30 天下载 1.1万

Lexical diff engine — character-level and structural diff with node decoration

原始使用文档
文档目录13 节
  1. Installation
  2. Peer Dependencies
  3. Usage
  4. Compute a diff between two editor states
  5. Decorate nodes with diff annotations
  6. Compute and format diff statistics
  7. Exports
  8. Core Diff
  9. Decoration
  10. Statistics
  11. Sub-path Exports
  12. Part of Haklex
  13. License

@haklex/rich-diff-core

Headless Lexical diff engine providing character-level and structural diffing between two editor states, with node decoration for visual annotation. Zero UI dependencies — shared by the @haklex/rich-diff viewer and @haklex/rich-agent-core for AI edit review.

Installation

pnpm add @haklex/rich-diff-core

Peer Dependencies

PackageVersion
lexical^0.45.0

Usage

Compute a diff between two editor states

import { computeDiff } from '@haklex/rich-diff-core';

const hunks = computeDiff(beforeEditorState, afterEditorState);
// hunks: DiffHunk[] with op: 'add' | 'remove' | 'equal'

Decorate nodes with diff annotations

import { decorateSubtree, diffMergedNode, diffModifiedNode } from '@haklex/rich-diff-core';

// Decorate a subtree to show additions/removals
const decorated = decorateSubtree(rootNode, hunks);

// Mark a single merged (modified) node
const merged = diffMergedNode(node);

Compute and format diff statistics

import { computeDeltaStats, formatDeltaStats } from '@haklex/rich-diff-core';

const stats = computeDeltaStats(beforeState, afterState);
// { addedChars: 42, removedChars: 10, addedNodes: 3, removedNodes: 1 }

const summary = formatDeltaStats(stats);
// "+42 / -10 characters, +3 / -1 nodes"

Exports

Core Diff

ExportDescription
computeDiff(before, after)Compute diff hunks between two EditorState objects
DiffHunkA single diff hunk with op type and content
DiffOpTypeDiff operation type ('add' | 'remove' | 'equal')
MarkKindMark decoration kind ('add' | 'remove')

Decoration

ExportDescription
decorateSubtree(node, hunks)Apply diff decorations to a node subtree
diffMergedNode(node)Mark a node as modified (merged add/remove)
diffModifiedNode(node)Mark a node with inline modified marks

Statistics

ExportDescription
computeDeltaStats(before, after)Compute character and node-level delta statistics
formatDeltaStats(stats)Format delta stats as a human-readable string
DeltaStatsType for diff statistics (character + node counts)

Sub-path Exports

Import PathDescription
@haklex/rich-diff-coreFull exports — diff engine, decoration, and statistics

Note: This package is headless (no React, no DOM). For a React diff viewer component, see @haklex/rich-diff.

Part of Haklex

This package is part of the Haklex rich editor ecosystem.

License

MIT

版本与发布记录

@haklex/rich-diff-core 共发布 151 个版本,首次发布于 2026/03/31;过去 12 个月发布了 151 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.66.0latest2026/11/151 天前
0.65.72026/11/143 天前
0.65.62026/11/124 天前
0.65.52026/11/124 天前
0.65.42026/11/124 天前
0.65.32026/11/124 天前

关于 @haklex/rich-diff-core 的常见问题

@haklex/rich-diff-core 是什么?

Lexical diff engine — character-level and structural diff with node decoration

如何安装 @haklex/rich-diff-core?

在项目目录运行 npm install @haklex/rich-diff-core,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:lexical(^0.53.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@haklex/rich-diff-core 支持 TypeScript 吗?

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

@haklex/rich-diff-core 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@haklex/rich-diff-core 可以商用吗?

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

@haklex/rich-diff-core 的下载量有多少?

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

@haklex/rich-diff-core 还在维护吗?

最新版本 0.66.0 发布于 2026/11/15(1 天前);至今共发布 151 个版本,其中过去 12 个月发布了 151 个;首次发布于 2026/03/31。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。