rust-doctor 0.1.16

A unified code health tool for Rust — scan, score, and fix your codebase
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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104

use std::path::PathBuf;

/// Top-level error for the rust-doctor scan pipeline.
#[derive(thiserror::Error, Debug)]
pub enum ScanError {
    #[error(transparent)]
    Discovery(#[from] DiscoveryError),

    #[error("workspace resolution failed: {0}")]
    Workspace(#[from] WorkspaceError),

    #[error("diff resolution failed: {0}")]
    Diff(#[from] DiffError),
}

/// Errors from workspace member resolution.
#[derive(thiserror::Error, Debug)]
pub enum WorkspaceError {
    #[error("unknown workspace member '{name}'. Available members: {available}")]
    UnknownMember { name: String, available: String },

    #[error("workspace has no members")]
    NoMembers,
}

/// Errors from diff mode resolution.
#[derive(thiserror::Error, Debug)]
pub enum DiffError {
    #[error("invalid ref '{name}': {reason}")]
    InvalidRef { name: String, reason: String },

    #[error("git is not available or directory is not a git repository")]
    GitNotFound,

    #[error("failed to find merge base: {0}")]
    MergeBaseFailed(String),

    #[error("{0}")]
    Other(String),
}

/// Errors from project discovery via `cargo metadata`.
#[derive(thiserror::Error, Debug)]
pub enum DiscoveryError {
    #[error("cargo metadata failed: {source}")]
    CargoMetadata {
        #[source]
        source: cargo_metadata::Error,
    },

    #[error("no packages found in workspace")]
    NoPackages,
}

/// Errors from individual analysis passes.
#[derive(thiserror::Error, Debug)]
pub enum PassError {
    #[error("{pass}: {message}")]
    Failed { pass: String, message: String },

    #[error("{pass}: analysis pass panicked")]
    Panicked { pass: String },

    #[error("{pass}: skipped ({reason})")]
    Skipped { pass: String, reason: String },
}

/// Errors from project bootstrapping (shared between CLI and MCP).
#[derive(thiserror::Error, Debug)]
pub enum BootstrapError {
    #[error("invalid directory '{path}': {source}")]
    InvalidDirectory {
        path: String,
        #[source]
        source: std::io::Error,
    },

    #[error("no Cargo.toml found in '{}'", path.display())]
    NoCargo { path: PathBuf },

    #[error(transparent)]
    Discovery(#[from] DiscoveryError),
}

/// Errors from loading the config file (`rust-doctor.toml`).
#[derive(thiserror::Error, Debug)]
pub enum ConfigError {
    #[error("failed to read config file '{}': {source}", path.display())]
    Io {
        path: std::path::PathBuf,
        #[source]
        source: std::io::Error,
    },

    #[error("failed to parse config file '{}': {source}", path.display())]
    Parse {
        path: std::path::PathBuf,
        #[source]
        source: toml::de::Error,
    },

    #[error("failed to parse [package.metadata.rust-doctor] in Cargo.toml: {0}")]
    MetadataParse(#[from] serde_json::Error),
}