#git #git-repository #inspection #github #hotspots #find #parser

hotspots-parser

用于在您的 git 仓库中查找热点的工具

4 个版本

0.0.8 2023 年 5 月 1 日
0.0.7 2023 年 5 月 1 日
0.0.6 2023 年 5 月 1 日
0.0.5 2023 年 4 月 30 日

#1754开发工具

Download history 1/week @ 2024-03-08 2/week @ 2024-03-15 17/week @ 2024-03-29 3/week @ 2024-04-05

54 每月下载量
git-hotspots 中使用

MIT 许可证

48KB
1K SLoC

Git Hotspots

GitHub Workflow Status Crates.io License

该工具有助于识别在 git 历史中发生了很多改变的函数。它是通过解析程序支持的文件,然后使用 git 历史来计算每个函数被更改的次数来做到这一点的。

请注意,这个工具还处于早期阶段,有很多地方需要改进。如果您有任何建议,请提交问题。

  1. 为什么这很有用
  2. 安装
  3. 用法
  4. 支持的编程语言
  5. 许可证

为什么这很有用

在您的工作项目中,您更改函数的次数越多,您再次工作在该函数上的可能性就越大。如果这个特定的函数更改得太频繁,这可能是一个标志,表明该函数需要更多的关注,并且可能造成技术债务。

使用这个工具,您可以识别那些太大或太复杂的函数,这些函数经常被重构,或者与程序的其他部分关系密切地被重构。

此外,当您想要决定如何重构您的代码时,您可以使用这个工具来找出哪些函数被更改得最多,并从这些函数开始。这可以帮助您更明智地决定如何重构您的代码。

安装

要安装

cargo install git-hotspots

假设二进制路径在您的 PATH 中,git 会自动将其作为子命令识别。

用法

要查看 git 历史中更改次数最多的前 50 个函数

git hotspots

您可以通过传递以下标志来控制工具的操作

  • --total, -t: 结果总数。默认:50
  • --skip, -s: 跳过前 n 个结果。默认:0
  • --log-level, -V: 日志级别。尝试 -VV 以获取更多日志!
  • --prefix-p:显示以给定字符串开头的结果。
  • --invert-match-v:排除部分匹配的路径。
  • --exclude-func-F:通过部分匹配排除函数。
  • --root-r:要检查的项目根目录。默认:.

支持的编程语言

目前支持以下语言

  • Rust
  • Go
  • Lua

然而,添加对其他语言的支持也很容易。只需为要支持的语言创建一个问题,我就会将其添加到列表中。

许可证

遵照MIT许可证。有关详细信息,请参阅LICENSE文件。

依赖项

~14–23MB
~453K SLoC