RAID: Refactoring-aware and Intelligent Diffs

RAID: Refactoring-aware and Intelligent Diffs

0.0.26
2024-02-20

介绍

向 GitHub diff 添加重构注释

代码审查是现代软件开发的关键实践。目前,这种做法是使用文本差异工具来执行的,例如 GitHub 提供的工具。然而,差异结果很容易变得复杂且难以理解。例如,重构在 diff 结果中根本不表示。这增加了对差异的理解,因为审阅者需要自己推断一组给定的添加和删除的代码行代表,例如提取方法。

RAID 是一个工具管道,可以通过重构信息无缝地丰富 GitHub diff 结果。该管道具有三个关键组件:

- RefDiff:检测提交中重构操作的工具。在我们的架构中,我们依靠 GitHub 操作在每个 Pull 请求后自动执行 RefDiff。
- 外部服务器,收集 RefDiff 生成的重构列表。
- 一个 Chrome 插件,可以无缝注释与重构相关的差异块。正如我们所描述的,目标是轻松地向开发人员传达添加/删除代码行背后的原因。

源代码:https://github.com/rodrigo-brito/refactoring-aware-diff

安装
- 安装 Refactoring-Aware Review Chrome 扩展
- 在 GitHub CI 中包含重构感知差异操作(可在 Github 描述中找到)
- 提交新的 Pull Request 来测试扩展

可以在此处查看带有提取的重构的 Pull 请求示例:https://github.com/rodrigo-brito/refactoring-aware-diff/pull/5/commits

错误报告:https://github.com/rodrigo-brito/refactoring-aware-diff/issues


查看更多
评分 0
无评分 位用户参与评分
使用人数
24+
插件大小
320KB
版本号 0.0.26
所属类别 开发者工具
提供方 Rodrigo Brito
支持语言 英语
更新时间 2024-02-20 21:32:56
ID bclbegekihgpelanbbleaceefgmekjdd