dependency-check-updates-core 0.1.13

Shared traits and types for dependency-check-updates (ManifestHandler, RegistryClient, Scanner)
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
105
106
107
108
109
110
111

use miette::Diagnostic;
use std::path::PathBuf;
use thiserror::Error;

/// Main error type for dependency-check-updates operations.
#[derive(Debug, Error, Diagnostic)]
pub enum DcuError {
    #[error("failed to read manifest at {path}")]
    #[diagnostic(
        code(dependency_check_updates::io_error),
        help("make sure the file exists and is readable")
    )]
    Io {
        path: PathBuf,
        #[source]
        source: std::io::Error,
    },

    #[error("failed to parse manifest at {path}")]
    #[diagnostic(code(dependency_check_updates::parse_error))]
    ManifestParse { path: PathBuf, detail: String },

    #[error("registry lookup failed for package `{package}`: {detail}")]
    #[diagnostic(
        code(dependency_check_updates::registry_error),
        help("check your internet connection, or set GITHUB_TOKEN if scanning workflows")
    )]
    RegistryLookup { package: String, detail: String },

    #[error("failed to apply patch to {path}")]
    #[diagnostic(code(dependency_check_updates::patch_error))]
    PatchFailed { path: PathBuf, detail: String },

    #[error("invalid semver: {input}")]
    #[diagnostic(code(dependency_check_updates::semver_error))]
    SemverParse { input: String, detail: String },

    #[error("no manifest found in {path}")]
    #[diagnostic(
        code(dependency_check_updates::no_manifest),
        help(
            "run dependency-check-updates in a directory containing package.json, or use --manifest"
        )
    )]
    NoManifest { path: PathBuf },
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_dcu_error_io() {
        let path = PathBuf::from("test.json");
        let io_err = std::io::Error::new(std::io::ErrorKind::NotFound, "file not found");
        let err = DcuError::Io {
            path: path.clone(),
            source: io_err,
        };
        assert_eq!(
            err.to_string(),
            format!("failed to read manifest at {}", path.display())
        );
    }

    #[test]
    fn test_dcu_error_manifest_parse() {
        let path = PathBuf::from("package.json");
        let err = DcuError::ManifestParse {
            path: path.clone(),
            detail: "unexpected token".to_string(),
        };
        assert_eq!(
            err.to_string(),
            format!("failed to parse manifest at {}", path.display())
        );
    }

    #[test]
    fn test_dcu_error_no_manifest() {
        let path = PathBuf::from("/some/dir");
        let err = DcuError::NoManifest { path: path.clone() };
        assert_eq!(
            err.to_string(),
            format!("no manifest found in {}", path.display())
        );
    }

    #[test]
    fn test_dcu_error_registry_lookup() {
        let err = DcuError::RegistryLookup {
            package: "lodash".to_string(),
            detail: "connection timeout".to_string(),
        };
        // Display now surfaces `detail` — without it, users hit a dead-end
        // when GitHub Tags API rate-limits them (no hint to set GITHUB_TOKEN).
        assert_eq!(
            err.to_string(),
            "registry lookup failed for package `lodash`: connection timeout"
        );
    }

    #[test]
    fn test_dcu_error_semver_parse() {
        let err = DcuError::SemverParse {
            input: "not.a.version".to_string(),
            detail: "invalid semver format".to_string(),
        };
        assert_eq!(err.to_string(), "invalid semver: not.a.version");
    }
}