Medic - CLI 中的自诊断输出辅助库

[ lib.rs ] [ crates.io ]

这是一个命令行程序的辅助工具，用于输出环境信息。预期用途是在您的错误报告模板中提及您希望输出 --medic、--doctor 或类似的输出。这个库将帮助生成这种输出，并补充您程序特有的自己的检查。

您的检查可能能够捕获常见的错误，这样用户甚至不需要首先报告一个错误。但即使不能，现在您也有一些基本的信息（例如平台、Rust 版本等）可以参考。

示例输出（来自 chezmoi_modify_manager）

RESULT   CHECK             MESSAGE
Info     version           3.1.2
Warning  build             Github CI build (not official release)
Info     rustc-version     1.76.0
Info     host              os=linux, arch=x86_64, info=Arch Linux Rolling Release [64-bit]
Ok       has-chezmoi       Chezmoi found. Version: chezmoi version v2.46.1, built at 2024-02-12T09:19:56Z
Ok       chezmoi-override  CHEZMOI_MODIFY_MANAGER_ASSUME_CHEZMOI_VERSION is not set
Ok       in-path           chezmoi_modify_manager is in PATH at /home/user/bin/chezmoi_modify_manager
Ok       has-ignore        Ignore of **/*.src.ini found
Ok       no-hook-script    No legacy hook script found

Warning: Warning(s) found, consider investigating (especially if you have issues)

实际的输出也使用了 ANSI 颜色代码。

MSRV

当前最低支持的 Rust 版本是 1.75.0。这可能会根据需要更新。MSRV 的增加不被视为 semver 破坏性变更。

致谢

这个想法受到了 chezmoi doctor 的启发，并在 chezmoi_modify_manager 中实现，然后提取到一个独立的 crate 中，以便以后可以重用。