os checker

【WIP】针对 Rust 库的代码检查工具集合和应用，用于督促和提高代码库的质量。

（尽管工具名称暗示与操作系统相关，但名称仅以它为背景。）

计划/实施步骤：

二进制工具：os-checker

os-checker 生成最常见的 Rust 代码检查工具的运行结果报告。

注意：虽然 miri 具有最高质量的 UB 检查效果，但并不适用于所有代码库。

据我所知，由于 miri 是动态检查的，这意味着检查的前提是需要实际的代码执行路径，也就是需要运行二进制程序，比如 cargo miri run 或者 cargo miri test，这可能会排除某些操作系统的二进制文件，因为它们具有不寻常的、miri 不直接支持的目标平台（尽管 miri 被设计为跨平台，但可能需要一些工作才能适配成功）。

因此，我们还需要静态代码检查工具作为补充。这里暂时只选取 lockbud，它看起来更简单和实用。在安全检查工具方面，有一个完整的清单，可供以后添加。

其他

• 开发日志
• 目前仅支持 fmt/clippy。其他功能正在开发中。

$ os-checker --help
Usage: os-checker [--config <config>]

Run a collection of checkers targeting Rust crates, and report bad checking results and statistics.

Options:
  --config          A yaml configuration file. Refer to
                    https://github.com/os-checker/os-checker/issues/5 for the
                    defined format.

$ os-checker --config assets/repos.yaml
The result of checking os-checker-test-suite | src: ./repos/os-checker-test-suite/
os-checker-test-suite counts on kind
╭───┬───────────────────┬───────╮
│   │ kind              │ count │
├───┼───────────────────┼───────┤
│ 1 │ Unformatted(File) │ 4     │
├───┼───────────────────┼───────┤
│ 2 │ Unformatted(Line) │ 6     │
├───┼───────────────────┼───────┤
│ 3 │ Clippy(Warn)      │ 1     │
├───┼───────────────────┼───────┤
│ 4 │ Clippy(Error)     │ 1     │
╰───┴───────────────────┴───────╯
os-checker-test-suite counts on file
╭───┬─────────────────────────────┬────────┬───────╮
│   │ file                        │ inside │ count │
├───┼─────────────────────────────┼────────┼───────┤
│ 1 │ examples/need-clippy-fix.rs │ true   │ 2     │
├───┼─────────────────────────────┼────────┼───────┤
│ 2 │ examples/need-fmt.rs        │ true   │ 2     │
├───┼─────────────────────────────┼────────┼───────┤
│ 3 │ src/main.rs                 │ true   │ 5     │
├───┼─────────────────────────────┼────────┼───────┤
│ 4 │ tests/need-fmt.rs           │ true   │ 3     │
╰───┴─────────────────────────────┴────────┴───────╯

$ os-checker --config assets/repos.yaml --emit path/to/a.json
[
  {
    "key": "0",
    "data": {
      "user": "repos",
      "repo": "os-checker-test-suite",
      "package": "",
      "total_count": 6,
      "Unformatted(File)": 4,
      "Unformatted(Line)": 6,
      "Clippy(Warn)": 1,
      "Clippy(Error)": 1
    },
    "children": [
      {
        "key": "1",
        "data": {
          "user": "repos",
          "repo": "os-checker-test-suite",
          "package": "os-checker-test-suite",
          "total_count": 6,
          "Unformatted(File)": 4,
          "Clippy(Warn)": 1,
          "Clippy(Error)": 1
        },
        "children": null
      }
    ]
  }
]