rust-llm-tidy-cli 0.8.3

CLI for linting and tidying Rust, C#, and documentation source.
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

//! DOC009 module files without top-level docs over the Rust fixtures.
//!
//! Every test runs `--include DOC009` on a fixture in
//! `tests/fixtures/doc/rust/` and asserts on its exit code and stderr
//! diagnostics. The shared runner helper lives in `mod.rs`.

use super::{run_command, rust_fixture_dir};

/// Missing headers fail with purpose, shape, and module-root navigation guidance.
#[test]
fn doc009_should_explain_header_writing_when_module_docs_are_missing() {
    let path = rust_fixture_dir().join("doc009_missing_module_docs.rs");
    let expected = indoc::indoc! {"
        :1: error[DOC009]: module file is missing `//!` module docs.

        Why: A purpose-first header helps readers understand the module
        without reading its implementation.

        Suggestions:
        - Read the module and relevant callers; document only supported facts.
        - Start with one concise sentence explaining what the module does and why.
          Do not just restate its name. A simple module needs no more.
        - If more detail is useful, put it below the summary, separated by a blank doc line.
        - Use that detail to outline major responsibilities, entry points, or non-obvious constraints.
        - Use bullets for multiple topics.
        - Link to item docs instead of repeating their details.
        - Add `//!` docs before the first top-level item.
        - For a module root (`mod.rs`, or `foo.rs` with child modules), identify
          main entry points and relevant child-module responsibilities.
        - Keep this change to header writing; do not move code. (file)"};

    let output = run_command(&["--include", "DOC009"], &path);

    let stderr = String::from_utf8_lossy(&output.stderr);
    assert_ne!(
        output.status.code().unwrap_or(-1),
        0,
        "a module file without `//!` docs should fail"
    );
    assert!(
        stderr.contains(expected),
        "DOC009 must render its pinned line-1 diagnostic:\n{stderr}"
    );
    assert_eq!(
        stderr.matches("DOC009").count(),
        1,
        "one finding per file, never per item:\n{stderr}"
    );
}