os-checker 工具集

对 Rust 编写的代码运行一系列检查工具，并对结果进行报告和统计，用以督促和提高代码库的质量。

虽然工具名称暗示与操作系统相关，但仅仅是以它为背景而起的名字。也就是说， os-checker 适用于任何 Rust 代码库。

详细文档见： os-checker book | 工作原理。

os-checker 由以下部分组成：

工具	仓库	version	功能
os-checker CLI	os-checker		对目标仓库运行一系列检查工具，最终输出检查结果
os-checker-types Lib	os-checker		os-checker 公开可序列化和反序列的类型库
os-checker-database CLI	os-checker		操作数据库文件并生成 WebUI 所需的基于目录的 JSONs
plugin Lib	plugin		作为其他 plugin CLIs 的功能共享库
plugin-docs CLI	plugin-docs		构建基于仓库最新提交的所有库的 rustdoc 文档
plugin-cargo CLI	plugin-cargo		解析仓库的 cargo 和 git 信息，比如每个包的信息
plugin-github-api CLI	plugin-github-api		通过 API 获取仓库在 Github 上的基本信息
WebUI	os-checker.github.io		通过网页应用呈现检查结果，并部署到 Github Pages
database	database		存储检查结果和基础信息数据
Github Action Workflow	os-checker-action		在 Github 仓库 CI 中自动化部署上述工具
Docker 容器	zjpzjp/os-checker		基于 Docker 容器自动化部署上述工具
文档	book		介绍 os-checker

上述仓库统一作为子模块放到 os-checker-repertoire 仓库。

os-checker 目前设计为检查 Github 上的仓库代码，并且采用 Github Action 进行自动化检查。

已支持 Github Action Workflow 和 Docker 镜像，来对上述工具进行自动化部署。

已集成 以下检查工具：

此外，os-checker 生成包括基础信息：

• Cargo.toml：Package 维度；由许多工具读取和使用，应该正确维护
• Github API：仓库维度

Licenses

This project is under dual licensing GPL-3.0 OR MulanPubL.