Skip to content

Commit 09671c1

Browse files
Merge pull request #7 from Zhang-JiahangH/codex/update-version-in-package.json-and-readme
docs: bump package version to v0.1.3 and surface benchmark results
2 parents 3ad0ed7 + 00be5c5 commit 09671c1

File tree

3 files changed

+35
-1
lines changed

3 files changed

+35
-1
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,12 @@ Metrics collected for each dataset size (`1k / 10k / 50k / 100k` lines):
9898
- Memory usage (`usedJSHeapSize` in Chromium)
9999
- Per benchmark case timeout: `60000 ms` (timeout cases are recorded in results instead of failing the run)
100100

101+
Quick result highlights (from the latest run):
102+
103+
- At **10k lines**, `react-virtualized-diff` keeps ~**60 FPS**, with **187.2 ms** initial render and **9.5 MB** memory.
104+
- At **50k/100k lines**, `react-diff-viewer` and `react-diff-viewer-continued` hit timeout, while this project finishes both cases.
105+
- At **100k lines**, this project uses **141.1 MB** memory vs `react-diff-view` at **1297.0 MB** (~9.2x lower), and keeps **60.4 FPS** vs **5.6 FPS**.
106+
101107
Run:
102108

103109
```bash
@@ -114,6 +120,8 @@ Output files:
114120
- `benchmark-results/results.json`
115121
- `benchmark-results/results.md`
116122

123+
➡️ See detailed benchmark table: [benchmark-results/results.md](./benchmark-results/results.md)
124+
117125
## Monorepo structure
118126

119127
```text

README.zh-CN.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,32 @@ export function Example() {
7979

8080
---
8181

82+
## Benchmark(性能基准)
83+
84+
我们提供了可运行的 benchmark,对比以下组件:
85+
86+
- `react-virtualized-diff`(本项目)
87+
- `react-diff-viewer`
88+
- `react-diff-viewer-continued`
89+
- `react-diff-view`
90+
91+
最新结果亮点:
92+
93+
- **10k 行**:本项目保持约 **60 FPS**,首屏渲染 **187.2 ms**,内存 **9.5 MB**
94+
- **50k / 100k 行**`react-diff-viewer``react-diff-viewer-continued``60000 ms` 超时限制内未完成。
95+
- **100k 行**:本项目内存 **141.1 MB**,而 `react-diff-view`**1297.0 MB**(约 **9.2 倍**差距);FPS 分别为 **60.4 vs 5.6**
96+
97+
运行方式:
98+
99+
```bash
100+
pnpm install
101+
pnpm benchmark
102+
```
103+
104+
详细结果请查看:[`benchmark-results/results.md`](./benchmark-results/results.md)
105+
106+
---
107+
82108
## 仓库结构
83109

84110
```text

packages/react/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "react-virtualized-diff",
3-
"version": "0.1.1",
3+
"version": "0.1.3",
44
"description": "High-performance React diff viewer for large files",
55
"main": "./dist/index.cjs",
66
"module": "./dist/index.mjs",

0 commit comments

Comments
 (0)