18 KiB
18 KiB
DiffLens 应用开发与版本迭代规范
适用项目：DiffLens（MetonaTeam / thzxx） 文档维护：随应用版本同步更新
1. 版本号总规范
版本号遵循 语义化版本（SemVer）三段式：x.y.z
x = 主版本号（Major）
y = 次版本号（Minor）
z = 补丁版本号（Patch）
本项目最重要的约束：
x永远是0，永远不要提升到1.0.0。 版本迭代只允许修改y和z，x保持0不变。
当前基线版本：0.7.1
2. x / y / z 各自的含义与规则
| 段位 | 值 | 何时提升 | 举例 |
|---|---|---|---|
x 主版本 |
恒为 0 |
永不提升 | 不生效 |
y 次版本 |
0, 1, 2, 3 … |
新增功能 / 界面较大调整 / 构建方式变更 | 0.1.0 → 0.2.0 |
z 补丁 |
0, 1, 2, 3 … |
Bug 修复 / 样式微调 / 文档 / 依赖小升级 | 0.1.0 → 0.1.1 |
何时走 y（次版本升级 0.x.z → 0.(x+1).0）
- 新增用户可见的功能特性
- UI / 交互有较大调整
- 引入新的差异能力（如导出报告、文件夹对比）
- 内部引擎算法 / 数据结构的兼容性变更
何时走 z（补丁升级 0.x.z → 0.x.(z+1)）
- 修复 Bug、崩溃、显示异常
- 细微的样式 / 文案优化
- 文档补充、依赖补丁级升级
- 非功能性重构（不改变用户可见行为）
反例（禁止）
- ❌ 直接跳到
1.0.0或更高 - ❌ 只升
x不升y/z - ❌ 同时改
y与z（一次发布只应改动一段）
3. 版本演进示意
0.1.0 ← 初始版本（已发布）
0.1.1 ← 体验打磨补丁（已发布）：拖拽编码识别 · 行级右键菜单 · 尾部换行显示修正
0.2.0 ← 导出差异报告（已发布）：HTML / 纯文本 / Markdown 三种格式
0.2.1 ← 建立测试体系（已发布）：Vitest 单元+组件测试 · 测试策略文档
0.2.2 ← 体验打磨（已发布）：拖拽处处可用 · 手动粘贴对比 · 导出后一键定位 · 报告/可读性增强 · 仅限文本文件
0.2.3 ← 安装器优化（已发布）：NSIS 向导式安装，支持手动选择安装目录
0.2.4 ← 健壮性与体验打磨（已发布）：读取容错与 10MB 大文件防护 · 横向滚动同步 · 下拉点击外部/Esc 关闭 · 二进制误判预警
0.2.5 ← 一致性与边角修复（已发布）：右键菜单边缘防溢出 · 粘贴入口 10MB 防护 · 拖拽读取失败提示 · 多文件拖拽提示 · 剪贴板统一走主进程 · 主进程异步读取
0.2.6 ← 主进程异步收尾与边角防护（已发布）：保存报告异步写盘 · 拖拽解码 handler 异步化 · 空白粘贴拦截 · 超多行卡顿预警 · 清理 mac 无效签名配置 · 文档与测试同步
0.3.0 ← 大文件性能与差异导航增强（已发布）：自研虚拟滚动 · 仅看差异过滤（折叠提示行） · F7/Shift+F7 导航快捷键 · 交换左右侧 · 忽略空行
0.3.1 ← 稳健性与测试补强（已发布）：超长单行词级 diff 防护 · 打开对话框补“所有文件”筛选 · 虚拟滚动 minWidth 测试覆盖 · 滚动同步去锁化重构
0.3.2 ← 报告对齐与性能收尾（已发布）：纯文本报告行号右对齐 · 超长行列宽封顶防卡顿 · 对话框与拖拽扩展名清单对齐 · 右键菜单打开时导航快捷键守卫 · 清理导出死属性
0.4.0 ← 差异计算 worker 化（已发布）：大文件 diff 移入 Worker 后台计算不阻塞界面 · 输入去抖与过期任务丢弃（终止重建实现取消） · 小输入同步快路径 · 无 Worker 环境回退 · 计算中遮罩与导出禁用
0.4.1 ← worker 创建开销优化与文档对齐（已发布）：worker 延迟至去抖到期才创建（去抖期内取消零创建开销，无 Worker 回退同样走去抖） · 质量门禁文档补 npm test · README 架构树补 hooks · Markdown 报告标题移出引用块 · 安装包排除开发期文件
0.4.2 ← 导出菜单溢出修复与报告可读性重设计（已发布）：底部工具栏导出菜单改向上弹出（修复超出窗口底边选不到） · HTML 报告全新设计（Hero 概览/人话结论/文件卡片/统计卡/图例/差异分块目录/相同段折叠可展开/打印亮色/窄屏适配，零 JS） · TXT 与 Markdown 报告头部补人话结论
0.4.3 ← 忽略所有空白比较选项与报告选项说明（已发布）：新增“忽略所有空白”开关（行内空格/制表符/全角空格不参与判等，展示仍为原文，换行结构仍参与对比） · 三种报告头部新增“比较选项”说明行（HTML 为 Hero 区徽标）
0.5.0 ← 字符级对比模式（已发布）：新增“字符级对比”开关（空白与换行结构全部不参与判等，两侧归一化为字符流 diff，跨行重组也能判等） · 字符差异回映射到行（跨界行配对、单侧行回拉、锚行 zip 配对，输出仍为 DiffRow，视图/报告/导航零改动） · 归一化流超 20 万字符自动降级行级对比并提示（报告头部按实际语义描述） · 字符级开启时三个空白选项置灰（语义已包含）
0.5.1 ← 字符级同行多块变更重复输出修复（已发布）：字符换位专项测试暴露并修复两处回映射缺陷——同行内多处变更（ne-eq-ne 同行，如换位、同行两处替换）不再重复输出多个 modified · 回拉跨界判定与对齐行判定锚定同一 eq 块，多行换位不再把全 common 行误判为 added · 新增字符换位专项测试组（对齐任意性下的不变量固化）
0.5.2 ← 稳健性收尾与偏好记忆（已发布）：diff worker 运行崩溃 onerror 兜底（终止实例回退主线程同步计算，effect 取消/jobId 已推进的迟到错误不回填） · 主进程 will-navigate 导航白名单加固（仅放行回到应用首页） · nativeTheme 暗色主题（Windows 标题栏等系统控件跟随应用风格） · 比较选项与仅看差异开关持久化（localStorage 记忆用户偏好，损坏数据防御性回退默认） · 字符级降级报告选项构造与引擎降级分支对齐（补 trimWhitespace 置否）
0.5.3 ← 稳健性补漏与偏好记忆收尾（已发布）：字符级对比少行大字符量输入改走 worker 后台计算（重输入判定补入字符量维度，行数防不住 diffChars O(ND) 耗时失控） · toast 队列化（最多 3 条堆叠、各自独立计时，二进制预警不再被行数预警顶掉） · 清空按钮二次确认（toast 提示 + 3 秒确认窗口，超时自动复位） · 窗口尺寸/位置记忆（关闭保存 bounds，启动恢复并钳制回工作区，损坏数据回退默认） · 文件对话框记忆上次打开目录 · 状态栏显示两侧行数 · 偏好读取挂载期单次化 · 主进程测试基建建立（windowState 纯逻辑模块 + vitest include 扩展至 src/main）
0.5.4 ← 比较选项联动可视化与状态透明（已发布）：修复禁用开关零视觉反馈的样式缺陷（原 CSS 仅有 button:disabled，checkbox 禁用后外观不变，用户不知哪些可选） · 字符级开启时三个空白选项灰显勾选（循系统惯例表达“语义已包含且生效”，仅为视觉呈现不改写用户原状态，关闭字符级即复原） · 常显“已包含”徽标（原仅 hover title 可知禁用原因） · 点击被包含选项弹 toast 解释而非无反应 · 字符级因内容超限自动降级时开关旁常显“已降级”标记（状态透明）
0.5.5 ← 字符级对比无界计算卡死修复（已发布）：diffChars 携 maxEditLength=3000 封顶 Myers 迭代轮数（编辑距离超限立即放弃并降级行级，根治大字符量+大差异输入 O(ND) 无界计算导致遮罩永久卡死——实测 3 万字符全不同无上限需数十分钟） · 字符量降级阈值 20 万收紧至 3 万（双限配合将最坏耗时锁在约 2 秒，worker 内计算界面不冻结） · 重输入 worker 派发阈值随动收紧（原始字符 7500，同步快路径最坏冻结压至 0.5 秒内） · 降级提示文案改“内容或差异过大”覆盖两种降级原因 · DiffOptions 增内部测试参数 charDiffMaxEdit（测试以小阈值毫秒级构造降级场景）
0.6.0 ← 解码 worker 化 · Playwright E2E · 文件夹对比（已发布）：
- 主进程解码 worker 化：≥256KB 缓冲移入 worker_threads 后台解码（GBK 纯 JS 解码大文件可达数百毫秒，不再阻塞主进程事件循环） · 解码与编码探测抽为纯逻辑模块 decode.ts（Uint8Array 入参，主进程同步路径与 worker 克隆路径共用） · worker 单例管理（崩溃拒绝在途任务并销毁重建，创建/运行失败回退主进程同步解码，行为不降级） · 构建改双入口（index + decodeWorker，iconv-lite 打包进产物） · out/main 整体 asarUnpack（Electron 的 asar 补丁不覆盖 worker 线程，unpacked 路径下无法解析 asar 内 node_modules）
- Playwright E2E 测试体系建立：对 build 产物启动真实 Electron 验收（复用项目自带 Electron，无需下载浏览器） · 首批 11 用例覆盖 jsdom 无法触达的主进程真实链路（GBK/BOM/大文件 worker 解码、报告写盘、剪贴板、偏好跨实例重启、文件夹真实扫描） · 主进程 dialog stub（showOpenDialog/showSaveDialog 可自动化） · 用例间清空 localStorage 隔离偏好污染 · npm run test:e2e 一键构建+验收，纳入发布 checklist
- 文件夹对比（MVP）：新增「对比文件夹」入口（依次选择两侧目录） · 递归扫描按相对路径对齐，文件级状态判定（相同/不同/仅左/仅右；大小不同即不同，大小一致做字节级全量比对，超 10MB 采样头部 8KB 近似判定并标注 ≈） · symlink 跳过防环，单侧文件数上限 10000（超限截断提示） · FolderView 虚拟滚动列表（统计徽章/仅看差异默认开/大小列示） · 双击条目进入单文件对比复用全部 diff 能力，一键返回文件夹列表（扫描结果保留） · file:open 与 file:read-by-path 共用同一读取管线（10MB 上限/编码探测/二进制预警一致）
0.6.1 ← 文件夹对比收尾打磨（已发布）：文件夹扫描内容比对受控并发化（大小一致条目按 16 并发分批读取比对，批内 Promise.all 批间串行，大目录不再逐文件串行等 IO，输出与失败语义和串行实现完全一致） · 「返回文件对比」清空两侧面板（修复先有文件对比再进文件夹退出后残留旧对比，对齐文档的单文件空态） · 两次选择同一文件夹防呆提示（不进入扫描） · ScanResult.total 注释修正（真实枚举总数，原注释误写为上限值） · README 版本号补同步 0.6.0 遗漏（元信息维护表要求随版本同步）
0.6.2 ← 文件夹对比稳健性与性能修复（已发布）：双击文件夹条目任一侧读取失败时清空该侧面板（修复失败侧残留旧对比内容与旧文件名组成“名不符实”对比的缺陷，readByPath 异常/空返回/error 三条失败路径全覆盖） · 文件夹枚举改手写 BFS 遍历凑满即停（替换 readdir recursive 无法提前终止的实现，误选超大目录如 node_modules 不再枚举耗时数秒；截断时 total 为已遍历下限，界面提示改“文件过多（N+）”）
0.7.0 ← 文件夹对比增强 · 字符级分块与滚动回弹修复（已发布）：
- 语义判等：字节级判“不同”的文本文件（≤2MB）二次判等——剔除全部空白（换行符 CRLF/LF、缩进、空行、排版重排）后一致计为“语义同”（大小写敏感，大小写差异仍为实质差异），消除换行符误报；解码复用解码 worker（大缓冲后台解码不阻塞），与文件打开共用同一管线；开关默认开启并持久化，切换即重扫；语义同不计入差异（仅看差异过滤），双击仍可查看明细
- 子目录树形展示：条目按路径聚合为目录树（folderTree 纯逻辑模块：建树/状态聚合/扁平化/过滤），目录行展示子树聚合状态（different > unreadable > only > 语义同 > 相同 优先级）与文件计数，点击折叠/展开（默认全展开）；树形扁平化行数组保持虚拟滚动；过滤/搜索后无文件的目录自动剪枝
- 搜索与状态过滤：文件名搜索框（相对路径子串、不区分大小写，命中路径强制展开）；统计徽章可点击作状态精确过滤（可多选，与“仅看差异”互斥联动）
- 文件夹报告导出：HTML/纯文本/Markdown 三格式（folderReport 模块），HTML 延续单文件报告主题（目录卡/统计卡/条目表/打印适配），报告含全量条目与判定口径说明，与界面过滤无关
- 差异文件导航：从文件夹进入单文件对比后 header 出现“差异文件 x/y”导航（Alt+↓/Alt+↑ 快捷键，不循环），语义同不计入序列；批量审查无需反复返回双击
- 大目录单点失败降级：单文件读取失败（Windows 文件锁/Defender 占用）标记“无法读取”状态（琥珀警示徽章，默认显示），单目录不可读跳过——不再整体失败丢弃全部结果（万级目录真机冒烟验证：被锁的 electron asar 正确降级，其余 9999 项正常判定）
- 字符级对比分块锚定（恢复 0.6.3 算法）：行归一化锚定 + 变更组分块字符流两阶段——相同内容不进入 diffChars，大文件字符级不再整篇受限（组上限 5 万字符/编辑距离 5000/组总流 10 万，任一超限降级行级）；引擎输出经真机验证精确无误（0.6.3 事故根因不在引擎）
- 滚动回弹修复（0.6.3 事故真因，0.5.3 起即存在）：worker 重路径计算期间保留旧结果撑住虚拟滚动容器高度（快路径结果兜底首次重算），items 不再塌陷——scrollTop 不被浏览器钳制归零；文本变化（打开新文件/交换左右）仍清空防过期差异误导；E2E 新增滚动稳定性回归锚（真实文件+行数不等+开字符级+切选项重算断言位置保持）
0.7.1 ← 文件夹扫描竞态守卫与边角修复（已发布）：文件夹扫描会话序号丢弃过期结果（语义切换触发重扫与重新选择新目录的并发扫描按序号判定，慢的旧扫描后完成不再覆盖新扫描的目录与条目、不误弹失败提示、不误清扫描态；退出文件夹对比作废在途扫描，迟到的结果不把界面拉回文件夹模式、遮罩不残留） · FolderView 补窗口尺寸变化监听（拉伸窗口变高后虚拟滚动窗口即时补齐，底部不再出现空白区，对齐 DiffView 行为） · 行号列改不透明等效合成背景（真机证实横向滚动时行文字透过 sticky 半透明行号列叠印，修复后完全遮盖，视觉色值为原叠加的预合成） · 最大化/全屏关闭改存 getNormalBounds 普通状态（本次会话调整过的窗口位置不因最大化关闭丢失，最小化仍不记录） · 行 id 生成统一为 rows.length（消除 flushRemoved 与 commitModified 双轨） · fmtSize 收敛为 folderReport 导出的单一实现（报告与列表共用） · 文档与版本号同步
...
0.y.z ← 长期停留，永不进入 1.x
4. 应用命名约束（三重一致）
交付给用户的所有可见名称必须统一为 DiffLens：
| 环节 | 名称 |
|---|---|
| 安装包文件名 | DiffLens-{version}-setup.exe |
| 安装后主程序 | DiffLens.exe |
| 开始菜单 / 桌面快捷方式 | DiffLens |
| 窗口标题 | DiffLens |
| 工程内部 name / productName | DiffLens |
注：
appId为内部安装标识（如com.metonateam.difflens），不展示给用户，不受此约束。
5. 开发流程
需求确认 → 方案权衡 → 开发实现 → 本地自测 → 类型检查 → 生产构建 → 代码评审 → 合并 → 发布
- 需求确认：明确目标，先梳理全貌，避免返工
- 方案权衡：涉及取舍时列出利弊，由负责拍板
- 开发实现：聚焦需求本身，不过度设计
- 本地自测：
npm run dev运行验证 - 质量门禁：见第 7 节
- 发布：见第 8 节
6. 分支与合并规范
main：唯一稳定主干，始终可运行、可发布- 功能分支：
feature/<功能名> - 修复分支：
fix/<问题描述>
main
└─ feature/xxx → （评审后合并回 main）
合并且无二次改动时，才允许 rebase 保持历史整洁；否则用普通合并提交。
7. 质量门禁（提交/推送前必须通过）
每次提交与推送前执行：
npm run typecheck # 类型检查（node + web 双端）
npm test # Vitest 单元 + 组件测试（覆盖率 80% 硬门禁）
npm run build # 生产构建（main/preload/renderer 三端）
任一命令失败则禁止提交；修复通过后再提交。与《测试策略与方案》第 7 节保持一致。
8. 发布流程
npm run build:win # Windows NSIS 安装包（在 Windows 上）
发布前 checklist：
- 更新
package.json的version到新的0.y.z - 更新本文件第 3 节演进记录
- 通过质量门禁（typecheck + test + build）
- 通过 E2E 验收（
npm run test:e2e，对 build 产物跑真实 Electron 主链路，0.6.0 起纳入发布必跑） - 打标签并推送到远程
git.metona.cn/MetonaTeam/DiffLens - 如需发布安装包，生成对应平台产物与 Release 说明
9. 元信息维护表
| 文件 | 维护内容 |
|---|---|
package.json |
version（唯一版本来源）、name、productName 保持 DiffLens |
electron-builder.yml |
productName / executableName / artifactName 保持 DiffLens |
README.md |
特性描述与发布版本号随版本同步 |
| 本文件 | 第 3 节演进记录同步补写 |
版本号只以
package.json的version为唯一来源，其余打包产物名由它派生。
附：提交信息格式
采用约定式提交：
<type>: <描述>
feat: 新增功能 （配 y 版本）
fix: 修复问题 （配 z 版本）
docs: 文档变更
build: 构建/依赖
refactor: 重构（不改行为，配 z 版本）
例如：
feat: 新增导出差异报告→0.2.0fix: 修复 GBK 文件乱码→0.1.1
© 2026 MetonaTeam · thzxx · DiffLens