repoke 0.7.0

Finds the package managers on your system and keeps them up to date, interactively or unattended
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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210

use std::env;
use std::fs;
use std::path::{Path, PathBuf};

use serde_json::Value;

use crate::manager::{self, Installed, Manager, Output, Package, Step, capture};
use crate::snapshot;

/// Global packages of Yarn 1. Yarn 2 and later dropped `yarn global`, so they aren't offered.
pub struct Yarn;

impl Manager for Yarn {
    fn id(&self) -> &'static str {
        "yarn"
    }

    fn name(&self) -> &'static str {
        "yarn (global)"
    }

    fn binary(&self) -> &'static str {
        "yarn"
    }

    fn locate(&self) -> Option<PathBuf> {
        let bin = manager::locate("yarn")?;
        let version = capture(&bin, ["--version"]).ok()?.stdout;
        version.trim().starts_with("1.").then_some(bin)
    }

    fn invocation(&self, bin: &Path) -> Vec<String> {
        let mut program = env_prefix();
        program.push(bin.display().to_string());
        program
    }

    /// The global folder is a plain Yarn project, so `outdated` works inside it.
    fn outdated(&self, bin: &Path) -> Result<Vec<Package>, String> {
        let dir = yarn(bin, &["global", "dir"])
            .and_then(|o| o.expect(&[0]))
            .map_err(explain)?;
        let json = yarn(bin, &["--cwd", dir.trim(), "outdated", "--json"])
            .and_then(|o| o.expect(&[0, 1]))
            .map_err(explain)?;
        Ok(parse_outdated(&json))
    }

    fn upgrade_steps(&self, _bin: &Path, packages: &[Package]) -> Vec<Step> {
        let specs = packages.iter().map(|p| format!("{}@{}", p.name, p.latest));
        vec![Step::new(
            ["global".to_string(), "add".to_string()]
                .into_iter()
                .chain(specs),
            packages,
        )]
    }

    /// Yarn has no `view` for one field, so npm reads `engines.node` when it is there.
    fn incompatible(&self, bin: &Path, packages: &[Package]) -> Vec<(Package, String)> {
        match manager::locate("npm") {
            Some(npm) => super::engines::incompatible(bin, &npm, packages),
            None => Vec::new(),
        }
    }

    fn installed(&self, bin: &Path) -> Result<Vec<Installed>, String> {
        let text = yarn(bin, &["global", "list"])
            .and_then(|o| o.expect(&[0]))
            .map_err(explain)?;
        let lines: Vec<String> = text.lines().map(|l| l.trim().to_string()).collect();
        Ok(parse_list(&lines))
    }

    fn install_steps(&self, _bin: &Path, packages: &[Installed]) -> Vec<Step> {
        Step::install_all(&["global", "add"], packages)
    }

    fn config_files(&self) -> &'static [&'static str] {
        &[".yarnrc"]
    }
}

/// Yarn 1 stops on any `${VAR}` in `.npmrc` that isn't set, where npm only warns. Those are set
/// to empty for yarn alone, through `env`, so it behaves like npm; Windows has no `env`.
fn env_prefix() -> Vec<String> {
    let npmrc = snapshot::home().and_then(|home| fs::read_to_string(home.join(".npmrc")).ok());
    let unset: Vec<String> = npmrc
        .map(|text| referenced_vars(&text))
        .unwrap_or_default()
        .into_iter()
        .filter(|var| env::var_os(var).is_none())
        .map(|var| format!("{var}="))
        .collect();
    if unset.is_empty() || cfg!(windows) {
        return Vec::new();
    }
    ["env".to_string()].into_iter().chain(unset).collect()
}

fn yarn(bin: &Path, args: &[&str]) -> Result<Output, String> {
    let mut command = env_prefix();
    if command.is_empty() {
        return capture(bin, args);
    }
    command.push(bin.display().to_string());
    command.extend(args.iter().map(|a| a.to_string()));
    capture(&command[0], &command[1..])
}

fn referenced_vars(npmrc: &str) -> Vec<String> {
    let mut vars: Vec<String> = npmrc
        .split("${")
        .skip(1)
        .filter_map(|rest| rest.split_once('}').map(|(var, _)| var.to_string()))
        .filter(|var| !var.is_empty() && var.chars().all(|c| c.is_ascii_alphanumeric() || c == '_'))
        .collect();
    vars.sort();
    vars.dedup();
    vars
}

/// What is left when `env` can't be used.
fn explain(error: String) -> String {
    let Some(start) = error.find("Failed to replace env in config: ${") else {
        return error;
    };
    let var = error[start..]
        .split(['{', '}'])
        .nth(1)
        .unwrap_or("a variable");
    format!("yarn 1 can't read your .npmrc: {var} isn't set. Export it, even empty, and try again")
}

/// The `table` event's rows are `[name, current, wanted, latest, type, url]`.
fn parse_outdated(json: &str) -> Vec<Package> {
    json.lines()
        .filter_map(|l| serde_json::from_str::<Value>(l).ok())
        .filter(|event| event["type"] == "table")
        .flat_map(|event| {
            event["data"]["body"]
                .as_array()
                .cloned()
                .unwrap_or_default()
        })
        .filter_map(|row| {
            let cell = |i: usize| row.get(i)?.as_str().map(String::from);
            Some(Package {
                name: cell(0)?,
                current: cell(1)?,
                latest: cell(3)?,
            })
        })
        .collect()
}

/// `info "create-vite@4.1.0" has binaries:`; a scoped name has its own `@`.
fn parse_list(lines: &[String]) -> Vec<Installed> {
    lines
        .iter()
        .filter_map(|l| {
            let spec = l.strip_prefix("info \"")?.split('"').next()?;
            let (name, version) = spec.rsplit_once('@')?;
            (!name.is_empty()).then(|| Installed::new(name).version(version))
        })
        .collect()
}

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

    #[test]
    fn reads_the_outdated_table() {
        let json = r#"{"type":"warning","data":"package.json: No license field"}
{"type":"table","data":{"head":["Package","Current","Wanted","Latest","Package Type","URL"],"body":[["create-vite","4.1.0","4.4.1","9.3.3","dependencies","https://github.com/vitejs/vite"],["typescript","5.2.2","5.9.3","7.0.2","dependencies","https://www.typescriptlang.org/"]]}}"#;
        let packages = parse_outdated(json);
        assert_eq!(packages.len(), 2);
        assert_eq!(packages[0].name, "create-vite");
        assert_eq!(packages[0].current, "4.1.0");
        assert_eq!(packages[0].latest, "9.3.3");
    }

    #[test]
    fn reads_global_list() {
        let lines = [
            "yarn global v1.22.22".to_string(),
            "info \"create-vite@4.1.0\" has binaries:".to_string(),
            "   - create-vite".to_string(),
            "info \"@vue/cli@5.0.8\" has binaries:".to_string(),
        ];
        let names: Vec<String> = parse_list(&lines).iter().map(|p| p.to_string()).collect();
        assert_eq!(names, ["create-vite==4.1.0", "@vue/cli==5.0.8"]);
    }

    #[test]
    fn finds_the_variables_npmrc_uses() {
        let npmrc = "registry=https://registry.npmjs.org/\n//npm.pkg.github.com/:_authToken=${NODE_AUTH_TOKEN}\n//x/:_authToken=${NODE_AUTH_TOKEN}\nemail=${EMAIL}\nbad=${not valid}\n";
        assert_eq!(referenced_vars(npmrc), ["EMAIL", "NODE_AUTH_TOKEN"]);
    }

    #[test]
    fn explains_unset_npmrc_variables() {
        let error = "exited with 1: error Error: Failed to replace env in config: ${NODE_AUTH_TOKEN}\n    at cli.js";
        assert_eq!(
            explain(error.into()),
            "yarn 1 can't read your .npmrc: NODE_AUTH_TOKEN isn't set. Export it, even empty, and try again"
        );
    }
}