check-config 0.9.12

Check configuration files.
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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178

use derive_more::Display;

use crate::checkers::{
    base::{CheckDefinitionError, CheckError},
    file::{get_option_string_value_from_checktable, get_string_value_from_checktable},
};

mod command;
pub(crate) mod custom;
pub(crate) mod package_absent;
pub(crate) mod package_present;
pub(crate) mod python;
pub(crate) mod rust;

// inspiration: https://github.com/mason-org/mason.nvim/tree/ad7146aa61dcaeb54fa900144d768f040090bff0/lua/mason-core/installer/managers

#[derive(Clone, Debug, PartialEq, Display)]
#[display("custom: {name}")]
pub(crate) struct CustomInstaller {
    name: String,
    install_command: Option<String>,
    version_command: String,
    uninstall_command: Option<String>,
    version: String,
}

#[derive(Clone, Debug, PartialEq, Display)]
pub(crate) enum PackageType {
    #[display("python: {name}", name=_0.name)]
    Python(Package),
    #[display("crate: {name}", name=_0.name)]
    Rust(Package),
    #[display("github: {name}", name=_0.name)]
    GithubRelease(Package),
    #[display("gitlab: {name}", name=_0.name)]
    GitlabRelease(Package),
    #[display("command: {name}", name=_0.name)]
    Custom(CustomInstaller),
}

impl PackageType {
    // TODO: add installer to Package to differentiate between installer (ie uv or pipx for
    // PythonPackage)

    // Install a package
    pub(crate) fn install(&self) -> Result<(), CheckError> {
        match self {
            PackageType::Python(package) => python::UV::install(package),
            PackageType::Rust(package) => rust::Cargo::install(package),
            PackageType::Custom(package) => custom::install(package),

            _ => todo!(),
        }
    }

    pub(crate) fn uninstall(&self) -> Result<(), CheckError> {
        match self {
            PackageType::Python(package) => python::UV::uninstall(package),
            PackageType::Rust(package) => rust::Cargo::uninstall(package),
            PackageType::Custom(package) => custom::uninstall(package),
            _ => todo!(),
        }
    }

    // is the package installed with the given version.
    // if no version is given, return true if the package is installed
    pub(crate) fn is_installed(&self) -> Result<bool, CheckError> {
        match self {
            PackageType::Python(package) => python::UV::is_installed(package),
            PackageType::Rust(package) => rust::Cargo::is_installed(package),
            PackageType::Custom(package) => custom::is_installed(package),
            _ => todo!(),
        }
    }
    // if no version is specified, we will upgrade the package to the latest version.
    // return True when there is possible or certain a newer version available
    // Note: possible is the case when the package manager can not report a newer version without
    // installing it
    pub(crate) fn is_upgradable(&self) -> Result<bool, CheckError> {
        match self {
            PackageType::Python(package) => python::UV::is_upgradable(package),
            PackageType::Rust(package) => rust::Cargo::is_upgradable(package),
            PackageType::Custom(package) => custom::is_upgradable(package),
            _ => todo!(),
        }
    }
}

#[derive(Debug, Clone, PartialEq, Display)]
#[display("{name}")] // TODO: add version when not none
pub(crate) struct Package {
    pub(crate) name: String,
    pub(crate) version: Option<String>,
    pub(crate) bins: Vec<String>,
    // platform: Platform
    // arch: Arch
}

pub(crate) trait Installer {
    fn install(package: &Package) -> Result<(), CheckError>;
    fn uninstall(package: &Package) -> Result<(), CheckError>;
    fn is_installed(package: &Package) -> Result<bool, CheckError>;
    fn is_upgradable(package: &Package) -> Result<bool, CheckError>;
}

pub(crate) fn read_package_from_check_table(
    value: &toml_edit::Table,
) -> Result<PackageType, CheckDefinitionError> {
    let package_type = match value.get("type") {
        None => Err(CheckDefinitionError::InvalidDefinition(
            "No type present".into(),
        )),
        Some(package_type) => match package_type.as_str() {
            None => Err(CheckDefinitionError::InvalidDefinition(
                "type is not a string".into(),
            )),
            Some(package_type) => Ok(package_type.to_lowercase()),
        },
    }?;

    if package_type == "custom" {
        return Ok(PackageType::Custom(CustomInstaller {
            name: get_string_value_from_checktable(value, "package")?,
            install_command: get_option_string_value_from_checktable(value, "install_command")?,
            uninstall_command: get_option_string_value_from_checktable(value, "uninstall_command")?,
            version_command: get_string_value_from_checktable(value, "version_command")?,
            version: get_string_value_from_checktable(value, "version")?,
        }));
    }

    let package_name = read_package_name_from_check_table(value)?;

    let package_version = read_optional_version_from_check_table(value)?;

    let package = Package {
        name: package_name,
        version: package_version,
        bins: vec![],
    };

    match package_type.to_lowercase().as_str() {
        "python" => Ok(PackageType::Python(package)),
        "rust" => Ok(PackageType::Rust(package)),
        _ => Err(CheckDefinitionError::InvalidDefinition(format!(
            "unknown package_type {package_type}"
        ))),
    }
}

pub(crate) fn read_package_name_from_check_table(
    value: &toml_edit::Table,
) -> Result<String, CheckDefinitionError> {
    match value.get("package") {
        None => Err(CheckDefinitionError::InvalidDefinition(
            "No package present".into(),
        )),
        Some(package) => match package.as_str() {
            None => Err(CheckDefinitionError::InvalidDefinition(
                "package is not a string".into(),
            )),
            Some(package) => Ok(package.to_owned()),
        },
    }
}

pub(crate) fn read_optional_version_from_check_table(
    value: &toml_edit::Table,
) -> Result<Option<String>, CheckDefinitionError> {
    match value.get("version") {
        None => Ok(None),
        Some(package) => match package.as_str() {
            None => Err(CheckDefinitionError::InvalidDefinition(
                "version is not a string".into(),
            )),
            Some(package) => Ok(Some(package.to_owned())),
        },
    }
}