#analysis #line #module #counter #rustc-version #dependencies #programming-language

countroo

Countroo 是一个在 Rust 项目中提供基本代码分析的工具,它支持行数统计、模块统计、依赖统计、项目列表以及 Rust 版本和 rustc 版本检测。

8 个版本

0.1.7 2024 年 2 月 29 日
0.1.6 2024 年 2 月 28 日

#168过程宏

每月 32 次下载

自定义许可证

67KB
831

CountRoo 🦘👀

欢迎来到 CountRoo 的野性世界,它是您在代码库浩瀚荒野中探索的首选 Rust 库!

🌲🔭 无论您是追踪 Rust 代码中的每一行,还是只是对项目统计数据感到好奇。

或者只是想了解每种语言的贡献比例,CountRoo 会直接跳转到那里,一边为您提供所需见解,一边增添乐趣。 🎉

output.png

这份 README 是由 ChatGPT 生成的,而不是库的作者,因为我很懒。

快速入门 🚀

CountRoo 添加到您的 Rust 项目比在桉树丛中发现考拉还要简单!以下是您如何开始的方法

  1. 将 CountRoo 添加到您的 Cargo.toml 📄

    [build-dependencies]
    countroo = { version = "0.1.7", features = ["default"]}
    
  2. 创建或更新您的 build.rs 🛠️

    确保您的项目根目录中有一个 build.rs 文件(紧挨着 Cargo.toml)。如果它缺失,现在就是添加它的时候了!

  3. 使用魔法宏调用 CountRoo

    在您的 build.rs 中,通过使用其提供的宏来分析您的项目,让 CountRoo 发挥其魔法。

    use countroo::prelude::*;
    fn main() {
        count_it_all!();
        // Or for the adventurous:
        // countroo::count_some!();
        // If you're using it for a workspace, you can just use it like this inside any project's build.rs
        count_it_all!(workspace: true);
    }
    

功能一览 🌟

CountRoo 并非普通的库;它包含了许多功能,使代码分析既富有洞察力又令人愉快。

  • 代码行数计数器 📊:发现您的项目包含多少行代码,可以选择是否包含空行。

  • 配置灵活性 📑:支持多种配置格式,包括 TOML、JSON、YAML、XML,甚至简单的换行符分隔配置,尽管在最初版本中它们将不可用。

  • 并行处理 ⚡:利用 rayon 进行快速分析,因为谁喜欢等待呢?

  • 可定制和可扩展 🛠️:通过指定要包含在计数中的文件扩展名来定制 CountRoo 以满足您的需求。

示例宏使用 📝

想要快速统计所有代码行数?只需在你的build.rs文件中使用count_it_all!宏。对于更精确的统计,count_some!宏是你的好朋友。下面是如何使用它的示例:

use countroo::prelude::*;
fn main() {
    // To count everything:
    count_it_all!();
    
    // Feeling selective?
    count_some!();
}

深入探索 🤿

CountRoo为那些想要挖掘其全部潜能的人提供了全面的文档。从处理自定义错误到深入配置,一切都在你的指尖。

总结 🎁

那么,还在等什么?让CountRoo带你开始代码统计之旅。发现你代码库中的隐藏宝藏,也许,你甚至会发现它比你想象的要大(或小)。祝编码愉快,Rust爱好者!🦀🎉

依赖项

~3–12MB
~137K SLoC