jarvy 0.0.3

Jarvy is a fast, cross-platform CLI that installs and manages developer tools across macOS and Linux.
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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140

//! Standardized process exit codes for Jarvy CLI.
//!
//! These codes are intended to be stable and shared across the codebase.
//! Keep meanings aligned with README/docs and CI expectations.
#![allow(dead_code)]

/// 0 — Success
///
/// Meaning: Command completed successfully.
/// Typical remediation: N/A
pub const EXIT_SUCCESS: i32 = 0;

/// 2 — Config/manifest error
///
/// Meaning: jarvy.toml or jarvy-extension.toml is missing or malformed.
/// Typical remediation: Fix the configuration file(s) and retry.
pub const CONFIG_ERROR: i32 = 2;

/// 3 — Prerequisite missing
///
/// Meaning: Required package manager or dependency (e.g., Homebrew) is not installed.
/// Typical remediation: Install the missing prerequisite and rerun.
pub const PREREQ_MISSING: i32 = 3;

/// 4 — Network/timeout
///
/// Meaning: Network issue, timeout, or proxy-related failure occurred.
/// Typical remediation: Check connectivity and proxy settings; retry.
pub const NETWORK_TIMEOUT: i32 = 4;

/// 5 — Permission/elevation required
///
/// Meaning: Operation requires elevated privileges (admin/sudo).
/// Typical remediation: Re-run with admin/sudo or adjust permissions.
pub const PERMISSION_REQUIRED: i32 = 5;

/// 6 — Incompatible OS/arch
///
/// Meaning: The current OS/architecture is unsupported for the requested action.
/// Typical remediation: Adjust the target or use an alternative installer.
pub const INCOMPATIBLE_OS_ARCH: i32 = 6;

/// 7 — Hook execution failed
///
/// Meaning: A pre_setup, post_install, or post_setup hook script failed.
/// Typical remediation: Check the hook script for errors or use --no-hooks to skip.
pub const HOOK_FAILED: i32 = 7;

pub struct ErrorCodeInfo {
    pub code: i32,
    pub key: &'static str,
    pub meaning: &'static str,
    pub remediation: &'static str,
    pub slug: &'static str,
}

static ERROR_CODES: &[ErrorCodeInfo] = &[
    ErrorCodeInfo {
        code: EXIT_SUCCESS,
        key: "EXIT_SUCCESS",
        meaning: "Command completed successfully.",
        remediation: "N/A",
        slug: "exit_success",
    },
    ErrorCodeInfo {
        code: CONFIG_ERROR,
        key: "CONFIG_ERROR",
        meaning: "jarvy.toml or jarvy-extension.toml is missing or malformed.",
        remediation: "Fix the configuration file(s) and retry.",
        slug: "config_error",
    },
    ErrorCodeInfo {
        code: PREREQ_MISSING,
        key: "PREREQ_MISSING",
        meaning: "Required package manager or dependency (e.g., Homebrew) is not installed.",
        remediation: "Install the missing prerequisite and rerun.",
        slug: "prereq_missing",
    },
    ErrorCodeInfo {
        code: NETWORK_TIMEOUT,
        key: "NETWORK_TIMEOUT",
        meaning: "Network issue, timeout, or proxy-related failure occurred.",
        remediation: "Check connectivity and proxy settings; retry.",
        slug: "network_timeout",
    },
    ErrorCodeInfo {
        code: PERMISSION_REQUIRED,
        key: "PERMISSION_REQUIRED",
        meaning: "Operation requires elevated privileges (admin/sudo).",
        remediation: "Re-run with admin/sudo or adjust permissions.",
        slug: "permission_required",
    },
    ErrorCodeInfo {
        code: INCOMPATIBLE_OS_ARCH,
        key: "INCOMPATIBLE_OS_ARCH",
        meaning: "The current OS/architecture is unsupported for the requested action.",
        remediation: "Adjust the target or use an alternative installer.",
        slug: "incompatible_os_arch",
    },
    ErrorCodeInfo {
        code: HOOK_FAILED,
        key: "HOOK_FAILED",
        meaning: "A pre_setup, post_install, or post_setup hook script failed.",
        remediation: "Check the hook script for errors or use --no-hooks to skip.",
        slug: "hook_failed",
    },
];

pub fn list_error_codes() -> &'static [ErrorCodeInfo] {
    ERROR_CODES
}

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

    #[test]
    fn codes_have_expected_values() {
        assert_eq!(EXIT_SUCCESS, 0);
        assert_eq!(CONFIG_ERROR, 2);
        assert_eq!(PREREQ_MISSING, 3);
        assert_eq!(NETWORK_TIMEOUT, 4);
        assert_eq!(PERMISSION_REQUIRED, 5);
        assert_eq!(INCOMPATIBLE_OS_ARCH, 6);
        assert_eq!(HOOK_FAILED, 7);
    }

    #[test]
    fn list_contains_all_codes() {
        let list = list_error_codes();
        let codes: Vec<i32> = list.iter().map(|e| e.code).collect();
        assert!(codes.contains(&EXIT_SUCCESS));
        assert!(codes.contains(&CONFIG_ERROR));
        assert!(codes.contains(&PREREQ_MISSING));
        assert!(codes.contains(&NETWORK_TIMEOUT));
        assert!(codes.contains(&PERMISSION_REQUIRED));
        assert!(codes.contains(&INCOMPATIBLE_OS_ARCH));
        assert!(codes.contains(&HOOK_FAILED));
    }
}