rusty-fez 0.2.0

Agent-native management CLI for Fedora/RHEL (drives cockpit-bridge)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

#!/usr/bin/env python3
"""Enforce docstring (doc comment) coverage from rustdoc --show-coverage JSON.

Reads the JSON emitted by:

    cargo +nightly rustdoc --lib -- \
        -Z unstable-options --show-coverage --output-format=json

The JSON is a flat map of file path -> {"total": N, "with_docs": M, ...}.
This sums with_docs/total across all files, prints the percentage, and exits
non-zero when it is below the DOCS_MIN environment variable (default 100).
"""

from __future__ import annotations

import json
import os
import sys


def main() -> int:
    min_pct = float(os.environ.get("DOCS_MIN", "100"))

    try:
        data = json.load(sys.stdin)
    except json.JSONDecodeError as exc:
        print(f"docs-coverage: could not parse rustdoc JSON: {exc}", file=sys.stderr)
        return 2

    total = 0
    documented = 0
    for stats in data.values():
        total += stats.get("total", 0)
        documented += stats.get("with_docs", 0)

    if total == 0:
        print("docs-coverage: no documentable items found", file=sys.stderr)
        return 2

    pct = 100.0 * documented / total
    print(f"docstring coverage: {documented}/{total} ({pct:.1f}%), min {min_pct:.0f}%")

    if pct + 1e-9 < min_pct:
        print(
            f"docs-coverage: FAILED ({pct:.1f}% < {min_pct:.0f}%)",
            file=sys.stderr,
        )
        return 1

    return 0


if __name__ == "__main__":
    sys.exit(main())