Lib.rs

home-prelude 是一个Rust库，旨在简化Rust应用程序的跟踪和错误处理。

它提供了预配置的跟踪和错误输出配置，可以快速集成到二进制项目中，特别是那些旨在在家庭或个人环境中运行的项目。

特性

• 预配置跟踪：使用合理的默认值设置跟踪，包括自定义时间格式、ANSI颜色支持和panic钩子。
• 增强错误报告：利用 color-eyre 进行更好的错误报告。
• 统一错误类型：使用 StdResult 类型别名，以便在整个应用程序中进行一致的错误处理。

入门指南

安装

将 home-prelude 添加到您的 Cargo.toml

[dependencies]
home-prelude = "1"

使用

要在您的Rust项目中使用 home-prelude，您需要在应用程序开头设置跟踪和错误处理

use home_prelude::{configure_tracing, configure_color_eyre, StdResult};

fn main() -> StdResult {
    // Configure tracing and error handling
    configure_tracing();
    configure_error_output();

    // Your application logic goes here

    Ok(())
}

配置细节

• 跟踪配置:

  • 跟踪输出发送到 stderr。
  • 自定义时间格式（%Y-%m-%d %H:%M:%S）用于日志时间戳。
  • 根据 NO_COLOR 环境变量可选地禁用ANSI颜色。
  • 禁用在日志中包含线程名称、线程ID、目标、文件和行号，以获得更干净的输出。

• 错误处理配置:

  • 集成 color-eyre 以增强错误报告。
  • 根据 NO_COLOR 环境变量的存在自动切换颜色主题。

贡献

欢迎贡献！请查看 问题 以获取要工作的任务。如果您发现错误或有功能请求，请随时提交问题。

致谢

• 此库建立在Rust社区的优秀工作之上，特别是 tracing、color-eyre 和其他依赖项的创建者和维护者。

许可证

本项目采用MIT许可证。有关更多详细信息，请参阅 LICENSE 文件。

联系方式

如有任何问题或支持，请提交问题或通过仓库的 主页 联系维护者。