oakum 0.12.1

A polyglot release tool that derives dependent version bumps from the dependency graph
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
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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
//! A member manifest's dependency tables across a change (ADR-0040). Cargo's
//! entries come from discovery instead ([`crate::plan::declaration_changes`]).

use std::collections::{BTreeMap, BTreeSet};

use serde_json::{Map, Value as Json};
use toml::{Table, Value as Toml};

use super::catalog_file::{catalog_target, CatalogFile, CatalogTarget};
use super::npm_spec::split_name_version;
use crate::plan::dependency_update::diff_entries;
use crate::plan::{DeclarationChanges, DependencyKind, Ecosystem, Outside};

const CARGO_TABLES: [&str; 5] = [
    "dependencies",
    "dev-dependencies",
    "dev_dependencies",
    "build-dependencies",
    "build_dependencies",
];

const CARGO_DEV_TABLES: [&str; 2] = ["dev-dependencies", "dev_dependencies"];

const NPM_TABLES: [&str; 4] = [
    "dependencies",
    "devDependencies",
    "optionalDependencies",
    "peerDependencies",
];

#[derive(Clone, PartialEq)]
enum Rest {
    Cargo(Table),
    Npm(Map<String, Json>),
}

/// Whether the manifest changed outside its dependency tables, or in an entry
/// naming a member, which is never a dependency update (ADR-0040). A root
/// manifest's `[workspace.dependencies]` counts as a dependency table, and a
/// change confined to development tables, a member entry there included, is
/// [`Outside::DevelopmentOnly`].
///
/// `members` holds every key a member is declared under on either side, its
/// name and any rename or inherited alias, as discovery reads the edges.
///
/// # Errors
///
/// A side that does not parse as the ecosystem's manifest format, named by
/// `base` or `head`.
pub fn changed_outside_dependencies(
    ecosystem: Ecosystem,
    base: &str,
    head: &str,
    members: &BTreeSet<String>,
) -> Result<Outside, String> {
    let (base, head) = (
        parse(ecosystem, base, "base")?,
        parse(ecosystem, head, "head")?,
    );
    let rest = |side: &Rest, with_dev: bool| match side.clone() {
        Rest::Cargo(table) => Rest::Cargo(cargo_rest(table, members, with_dev)),
        Rest::Npm(object) => Rest::Npm(npm_rest(object, members, with_dev)),
    };
    if rest(&base, true) == rest(&head, true) {
        Ok(Outside::Same)
    } else if rest(&base, false) == rest(&head, false) {
        Ok(Outside::DevelopmentOnly)
    } else {
        Ok(Outside::Changed)
    }
}

/// Whether both sides parse to the same manifest: an edit to comments or
/// formatting alone.
///
/// # Errors
///
/// As [`changed_outside_dependencies`].
pub fn parses_equal(ecosystem: Ecosystem, base: &str, head: &str) -> Result<bool, String> {
    Ok(parse(ecosystem, base, "base")? == parse(ecosystem, head, "head")?)
}

fn parse(ecosystem: Ecosystem, text: &str, side: &str) -> Result<Rest, String> {
    match ecosystem {
        Ecosystem::Cargo => text
            .parse()
            .map(Rest::Cargo)
            .map_err(|err| format!("{side} side is not TOML: {err}")),
        Ecosystem::Npm => match serde_json::from_str(text) {
            Ok(Json::Object(object)) => Ok(Rest::Npm(object)),
            Ok(_) => Err(format!("{side} side is not a JSON object")),
            Err(err) => Err(format!("{side} side is not JSON: {err}")),
        },
    }
}

fn cargo_rest(mut table: Table, members: &BTreeSet<String>, with_dev: bool) -> Table {
    let strip = |table: &mut Table| {
        if !with_dev {
            for key in CARGO_DEV_TABLES {
                table.remove(key);
            }
        }
        keep_member_entries(table, members);
    };
    strip(&mut table);
    if let Some(Toml::Table(targets)) = table.get_mut("target") {
        targets.retain(|_, spec| {
            let Toml::Table(spec) = spec else {
                return true;
            };
            strip(spec);
            !spec.is_empty()
        });
        if targets.is_empty() {
            table.remove("target");
        }
    }
    if let Some(Toml::Table(workspace)) = table.get_mut("workspace") {
        keep_member_entries_of(workspace, "dependencies", members);
    }
    table
}

fn keep_member_entries(table: &mut Table, members: &BTreeSet<String>) {
    for key in CARGO_TABLES {
        keep_member_entries_of(table, key, members);
    }
}

fn keep_member_entries_of(table: &mut Table, key: &str, members: &BTreeSet<String>) {
    let Some(Toml::Table(entries)) = table.get_mut(key) else {
        return;
    };
    entries.retain(|name, entry| {
        let package = entry.get("package").and_then(Toml::as_str).unwrap_or(name);
        members.contains(package)
    });
    if entries.is_empty() {
        table.remove(key);
    }
}

fn npm_rest(
    mut object: Map<String, Json>,
    members: &BTreeSet<String>,
    with_dev: bool,
) -> Map<String, Json> {
    if !with_dev {
        object.remove("devDependencies");
    }
    for key in NPM_TABLES {
        let Some(Json::Object(entries)) = object.get_mut(key) else {
            continue;
        };
        entries.retain(|name, spec| {
            let spec = spec.as_str().unwrap_or_default().trim();
            spec.starts_with("workspace:") || members.contains(&npm_target(name, spec).0)
        });
        if entries.is_empty() {
            object.remove(key);
        }
    }
    object
}

/// The package an entry installs, and its range: the key and spec, or an
/// `npm:` alias's target and version.
fn npm_target(key: &str, spec: &str) -> (String, String) {
    match spec.strip_prefix("npm:").and_then(split_name_version) {
        Some((target, version)) => (target.to_owned(), version.trim().to_owned()),
        None => (key.to_owned(), spec.trim().to_owned()),
    }
}

#[derive(Clone, Copy, Debug)]
pub struct NpmSide<'a> {
    pub manifest: &'a str,
    pub workspace_file: Option<&'a str>,
}

/// Both ranges resolved through the catalog.
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct NpmMoved {
    pub kind: DependencyKind,
    pub declared_as: String,
    pub before: String,
    pub after: String,
}

/// As [`crate::plan::declaration_changes`], for an npm member: the entries in
/// force, an `optionalDependencies` entry shadowing the same name in
/// `dependencies` as npm installs them. An entry installing a workspace member,
/// by name, `npm:` alias or `workspace:`, directly or through a catalog, is
/// never a dependency update (ADR-0008, ADR-0010): one that differs needs
/// intent, or is development-only in `devDependencies`.
///
/// # Errors
///
/// A side that does not parse, or a `catalog:` entry its catalog does not name.
pub fn npm_declaration_changes(
    base: NpmSide<'_>,
    head: NpmSide<'_>,
    members: &BTreeSet<String>,
) -> Result<DeclarationChanges<NpmMoved>, String> {
    let (base, head) = (
        npm_entries(base, "base", members)?,
        npm_entries(head, "head", members)?,
    );
    let split =
        |entries: &BTreeMap<EntryKey, NpmEntry>, member: bool| -> BTreeMap<EntryKey, NpmEntry> {
            entries
                .iter()
                .filter(|(_, entry)| entry.member == member)
                .map(|(key, entry)| (key.clone(), entry.clone()))
                .collect()
        };
    let development = |(kind, _): &EntryKey| *kind == DependencyKind::Development;
    let mut changes = diff_entries(
        &split(&base, false),
        &split(&head, false),
        development,
        |before: &NpmEntry, after| before.target == after.target && before.range == after.range,
        |before, after| before.target == after.target,
        |(kind, declared_as), before, after| NpmMoved {
            kind: *kind,
            declared_as: declared_as.clone(),
            before: before.range.clone(),
            after: after.range.clone(),
        },
    );
    let members_changed = diff_entries(
        &split(&base, true),
        &split(&head, true),
        development,
        |before: &NpmEntry, after| before == after,
        |_, _| false,
        |_, _, _| (),
    );
    changes.needs_intent |= members_changed.needs_intent;
    changes.development |= members_changed.development;
    Ok(changes)
}

type EntryKey = (DependencyKind, String);

#[derive(Clone, Debug, PartialEq, Eq)]
struct NpmEntry {
    /// As written, so a member entry rewritten to the same target still differs.
    spec: String,
    /// The key, or an `npm:` alias's target.
    target: String,
    range: String,
    member: bool,
}

/// The keys whose entry installs one of `members`, as
/// [`npm_declaration_changes`] reads them.
///
/// # Errors
///
/// As [`npm_declaration_changes`].
pub fn npm_member_keys(
    side: NpmSide<'_>,
    members: &BTreeSet<String>,
) -> Result<BTreeSet<String>, String> {
    Ok(npm_entries(side, "the", members)?
        .into_iter()
        .filter(|(_, entry)| entry.member)
        .map(|((_, key), _)| key)
        .collect())
}

fn npm_entries(
    side: NpmSide<'_>,
    name: &str,
    members: &BTreeSet<String>,
) -> Result<BTreeMap<EntryKey, NpmEntry>, String> {
    let Json::Object(object) = serde_json::from_str(side.manifest)
        .map_err(|err| format!("{name} side is not JSON: {err}"))?
    else {
        return Err(format!("{name} side is not a JSON object"));
    };
    let catalogs = side
        .workspace_file
        .map(CatalogFile::parse)
        .transpose()
        .map_err(|err| format!("{name} side's pnpm-workspace.yaml does not parse: {err}"))?;
    let table = |key: &str| -> Result<BTreeMap<String, String>, String> {
        match object.get(key) {
            None => Ok(BTreeMap::new()),
            Some(Json::Object(entries)) => entries
                .iter()
                .map(|(dep, spec)| match spec {
                    Json::String(spec) => Ok((dep.clone(), spec.clone())),
                    _ => Err(format!("{name} side's `{key}.{dep}` is not a string")),
                })
                .collect(),
            Some(_) => Err(format!("{name} side's `{key}` is not an object")),
        }
    };
    let optional = table("optionalDependencies")?;
    let mut normal = table("dependencies")?;
    normal.retain(|dep, _| !optional.contains_key(dep));
    let mut entries = BTreeMap::new();
    for (kind, specs) in [
        (DependencyKind::Normal, normal),
        (DependencyKind::Optional, optional),
        (DependencyKind::Peer, table("peerDependencies")?),
        (DependencyKind::Development, table("devDependencies")?),
    ] {
        for (dep, spec) in specs {
            let spec = spec.trim();
            let resolved = match spec.strip_prefix("catalog:") {
                _ if spec.starts_with("workspace:") => spec.to_owned(),
                Some(catalog) => resolve_catalog(catalogs.as_ref(), catalog.trim(), &dep)
                    .map_err(|why| format!("{name} side's `{dep}: {spec}` {why}"))?,
                None => spec.to_owned(),
            };
            let (target, range) = npm_target(&dep, &resolved);
            let member = spec.starts_with("workspace:") || members.contains(&target);
            entries.insert(
                (kind, dep),
                NpmEntry {
                    spec: spec.to_owned(),
                    target,
                    range,
                    member,
                },
            );
        }
    }
    Ok(entries)
}

fn resolve_catalog(
    catalogs: Option<&CatalogFile>,
    catalog: &str,
    dep: &str,
) -> Result<String, &'static str> {
    let catalogs = catalogs.ok_or("names no catalog entry")?;
    let name = (!catalog.is_empty() && catalog != "default").then_some(catalog);
    match catalog_target(
        name,
        dep,
        catalogs.catalog.is_some(),
        catalogs.has_default_table(),
    ) {
        CatalogTarget::Duplicate => {
            Err("resolves against both `catalog` and `catalogs.default`, which pnpm refuses")
        }
        CatalogTarget::At { path, .. } => catalogs
            .string_at(&path)
            .map(str::to_owned)
            .ok_or("names no catalog entry"),
    }
}

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

    const CARGO: &str = r#"[package]
name = "cli"
version = "0.1.0"
description = "a tool"

[dependencies]
rusqlite = "0.31"

[dev-dependencies]
insta = "1"

[target.'cfg(windows)'.dependencies]
winapi = "0.3"
"#;

    fn members() -> BTreeSet<String> {
        BTreeSet::from([String::from("core")])
    }

    fn cargo_outside(base: &str, head: &str) -> Outside {
        changed_outside_dependencies(Ecosystem::Cargo, base, head, &members()).expect("parses")
    }

    fn cargo(base: &str, head: &str) -> bool {
        cargo_outside(base, head) == Outside::Changed
    }

    #[test]
    fn a_dev_table_edit_is_development_only_even_naming_a_member() {
        let dev = |entry: &str| CARGO.replace("insta = \"1\"", &format!("insta = \"1\"\n{entry}"));
        assert_eq!(
            cargo_outside(
                &dev(r#"core = { path = "../core" }"#),
                &dev(r#"core = { path = "../core", features = ["x"] }"#)
            ),
            Outside::DevelopmentOnly
        );
        let unix = |req: &str| {
            format!("{CARGO}\n[target.'cfg(unix)'.dev-dependencies]\ncore = {{ path = \"../core\", version = \"{req}\" }}\n")
        };
        assert_eq!(
            cargo_outside(&unix("1"), &unix("2")),
            Outside::DevelopmentOnly
        );
        assert_eq!(cargo_outside(CARGO, CARGO), Outside::Same);
    }

    #[test]
    fn an_inherited_alias_of_a_member_is_read_as_the_member() {
        let with = |features: &str| {
            CARGO.replace(
                "rusqlite = \"0.31\"",
                &format!("rusqlite = \"0.31\"\nmy-core = {{ workspace = true{features} }}"),
            )
        };
        let aliased = BTreeSet::from([String::from("core"), String::from("my-core")]);
        let read = |members: &BTreeSet<String>| {
            changed_outside_dependencies(
                Ecosystem::Cargo,
                &with(""),
                &with(", features = [\"x\"]"),
                members,
            )
            .expect("parses")
        };
        assert_eq!(read(&aliased), Outside::Changed);
        assert_eq!(read(&members()), Outside::Same);
    }

    #[test]
    fn a_first_target_section_of_dependencies_is_not_outside() {
        let base = CARGO.replace(
            "[target.'cfg(windows)'.dependencies]\nwinapi = \"0.3\"\n",
            "",
        );
        assert_eq!(cargo_outside(&base, CARGO), Outside::Same);
    }

    #[test]
    fn every_cargo_table_spelling_is_a_dependency_table() {
        for table in [
            "build-dependencies",
            "build_dependencies",
            "dev_dependencies",
        ] {
            let at = |req: &str| format!("{CARGO}\n[{table}]\ncc = \"{req}\"\n");
            assert!(!cargo(&at("1"), &at("1.1")), "{table}");
        }
        let unix = format!("{CARGO}\n[target.'cfg(unix)'.dependencies]\nlibc = \"0.2\"\n");
        assert!(!cargo(CARGO, &unix));
    }

    #[test]
    fn an_edit_to_an_entry_naming_a_member_is_outside() {
        let with = |entry: &str| {
            CARGO.replace(
                "rusqlite = \"0.31\"",
                &format!("rusqlite = \"0.31\"\ncore = {entry}"),
            )
        };
        assert!(cargo(
            &with(r#"{ path = "../core" }"#),
            &with(r#"{ path = "../core", features = ["x"] }"#)
        ));
        assert!(cargo(
            &with(r#"{ path = "../core" }"#),
            &with(r#"{ path = "../core", version = "2" }"#)
        ));
        let renamed = |features: &str| {
            CARGO.replace(
                "rusqlite = \"0.31\"",
                &format!("rusqlite = \"0.31\"\nmine = {{ package = \"core\", path = \"../core\"{features} }}"),
            )
        };
        assert!(cargo(&renamed(""), &renamed(", features = [\"x\"]")));
    }

    #[test]
    fn a_root_workspace_dependency_move_is_not_outside_but_a_member_entry_is() {
        let root = |rusqlite: &str, core: &str| {
            format!(
                "{CARGO}\n[workspace]\nmembers = [\"core\"]\n\n[workspace.dependencies]\nrusqlite = \"{rusqlite}\"\ncore = {{ path = \"core\"{core} }}\n"
            )
        };
        assert!(!cargo(&root("0.31", ""), &root("0.32", "")));
        assert!(cargo(
            &root("0.31", ""),
            &root("0.31", ", features = [\"x\"]")
        ));
        assert!(cargo(
            &root("0.31", ""),
            &root("0.31", "").replace("members = [\"core\"]", "members = [\"core\", \"cli\"]")
        ));
    }

    #[test]
    fn a_cargo_dependency_edit_changes_nothing_outside() {
        let head = CARGO
            .replace(
                "rusqlite = \"0.31\"",
                "rusqlite = { version = \"0.32\", features = [\"bundled\"] }",
            )
            .replace("insta = \"1\"", "insta = \"1.41\"\ntempfile = \"3\"")
            .replace("winapi = \"0.3\"", "winapi = \"0.4\"");
        assert!(!cargo(CARGO, &head));
    }

    #[test]
    fn a_cargo_edit_beside_the_dependencies_is_outside() {
        assert!(cargo(CARGO, &CARGO.replace("a tool", "the tool")));
        assert!(cargo(
            CARGO,
            &format!("{CARGO}\n[target.'cfg(windows)'.rustflags]\nx = 1\n")
        ));
        assert!(cargo(CARGO, &format!("{CARGO}\n[features]\nfast = []\n")));
    }

    #[test]
    fn formatting_alone_changes_nothing_outside() {
        assert!(!cargo(
            CARGO,
            &CARGO.replace("[package]", "# the cli\n[package]")
        ));
    }

    const NPM: &str = r#"{
  "name": "app",
  "version": "1.0.0",
  "description": "an app",
  "dependencies": { "react": "^18.2.0" },
  "devDependencies": { "vitest": "^2.0.0" },
  "peerDependencies": { "host": "^1" }
}"#;

    fn npm_outside(base: &str, head: &str) -> Outside {
        changed_outside_dependencies(Ecosystem::Npm, base, head, &members()).expect("parses")
    }

    fn npm(base: &str, head: &str) -> bool {
        npm_outside(base, head) == Outside::Changed
    }

    #[test]
    fn npm_dev_member_edits_are_development_only_and_spacing_is_read_through() {
        assert_eq!(
            npm_outside(
                &deps("devDependencies", r#""core": "workspace:^""#),
                &deps("devDependencies", r#""core": "workspace:~""#),
            ),
            Outside::DevelopmentOnly
        );
        assert!(npm(
            &deps("dependencies", r#""core": " workspace:^""#),
            &deps("dependencies", r#""core": " workspace:~""#),
        ));
        assert_eq!(
            npm_changes(
                &deps("dependencies", r#""lodash": "npm:lodash-es@ ^4""#),
                &deps("dependencies", r#""lodash": "npm:lodash-es@^4""#),
            ),
            DeclarationChanges::default()
        );
    }

    #[test]
    fn an_npm_edit_to_an_entry_naming_a_member_is_outside() {
        assert!(npm(
            &deps("dependencies", r#""core": "workspace:^""#),
            &deps("dependencies", r#""core": "workspace:~""#),
        ));
        assert!(npm(
            &deps("dependencies", r#""mine": "npm:core@^1""#),
            &deps("dependencies", r#""mine": "npm:core@^2""#),
        ));
        assert!(npm(
            &deps("dependencies", r#""x": "workspace:*""#),
            &deps("dependencies", r#""x": "workspace:^""#),
        ));
    }

    #[test]
    fn an_npm_dependency_edit_changes_nothing_outside() {
        let head = NPM
            .replace("^18.2.0", "^19.0.0")
            .replace("\"^1\"", "\"^1 || ^2\"")
            .replace(
                "\"devDependencies\"",
                "\"optionalDependencies\": { \"fsevents\": \"^2\" },\n  \"devDependencies\"",
            );
        assert!(!npm(NPM, &head));
    }

    #[test]
    fn an_npm_edit_beside_the_dependencies_is_outside() {
        assert!(npm(NPM, &NPM.replace("an app", "the app")));
        assert!(npm(
            NPM,
            &NPM.replace(
                "\"name\"",
                "\"peerDependenciesMeta\": { \"host\": { \"optional\": true } },\n  \"name\""
            )
        ));
    }

    fn npm_changes(base: &str, head: &str) -> DeclarationChanges<NpmMoved> {
        npm_changes_with(base, head, None, None).expect("reads")
    }

    fn npm_changes_with(
        base: &str,
        head: &str,
        base_yaml: Option<&str>,
        head_yaml: Option<&str>,
    ) -> Result<DeclarationChanges<NpmMoved>, String> {
        npm_declaration_changes(
            NpmSide {
                manifest: base,
                workspace_file: base_yaml,
            },
            NpmSide {
                manifest: head,
                workspace_file: head_yaml,
            },
            &BTreeSet::from([String::from("core")]),
        )
    }

    fn deps(section: &str, entries: &str) -> String {
        format!(r#"{{ "name": "app", "version": "1.0.0", "{section}": {{ {entries} }} }}"#)
    }

    #[test]
    fn an_npm_range_move_is_a_dependency_update() {
        let got = npm_changes(
            &deps("dependencies", r#""react": "^18.2.0""#),
            &deps("dependencies", r#""react": "^19.0.0""#),
        );
        assert_eq!(
            got,
            DeclarationChanges::<NpmMoved> {
                moved: vec![NpmMoved {
                    kind: DependencyKind::Normal,
                    declared_as: String::from("react"),
                    before: String::from("^18.2.0"),
                    after: String::from("^19.0.0"),
                }],
                ..DeclarationChanges::<NpmMoved>::default()
            }
        );
    }

    #[test]
    fn a_shadowed_dependencies_entry_is_not_read() {
        let manifest = |shadowed: &str| {
            format!(
                r#"{{ "dependencies": {{ "fsevents": "{shadowed}" }}, "optionalDependencies": {{ "fsevents": "^2" }} }}"#
            )
        };
        assert_eq!(
            npm_changes(&manifest("^1"), &manifest("^3")),
            DeclarationChanges::<NpmMoved>::default()
        );
    }

    #[test]
    fn an_alias_keeping_its_target_moves_and_one_changing_it_needs_intent() {
        let alias = |spec: &str| deps("dependencies", &format!(r#""lodash": "{spec}""#));
        let kept = npm_changes(
            &alias("npm:lodash-es@^4.17.0"),
            &alias("npm:lodash-es@^4.18.0"),
        );
        assert_eq!(kept.moved.len(), 1, "{kept:?}");
        assert_eq!(kept.moved[0].after, "^4.18.0");
        let retargeted = npm_changes(&alias("npm:lodash-es@^4"), &alias("npm:lodash@^4"));
        assert!(
            retargeted.needs_intent && retargeted.moved.is_empty(),
            "{retargeted:?}"
        );
    }

    #[test]
    fn a_catalog_switch_resolving_to_the_same_range_changes_nothing() {
        let yaml = "catalog:\n  react: ^18.2.0\n";
        let got = npm_changes_with(
            &deps("dependencies", r#""react": "^18.2.0""#),
            &deps("dependencies", r#""react": "catalog:""#),
            None,
            Some(yaml),
        )
        .expect("resolves");
        assert_eq!(got, DeclarationChanges::<NpmMoved>::default());
    }

    #[test]
    fn a_catalog_entry_naming_nothing_is_an_error() {
        let err = npm_changes_with(
            &deps("dependencies", r#""react": "^18.2.0""#),
            &deps("dependencies", r#""react": "catalog:web""#),
            None,
            Some("catalog:\n  react: ^18.2.0\n"),
        )
        .expect_err("no `web` catalog");
        assert!(err.contains("names no catalog entry"), "{err}");
    }

    #[test]
    fn npm_development_member_and_added_entries() {
        assert_eq!(
            npm_changes(
                &deps("devDependencies", r#""vitest": "^2""#),
                &deps("devDependencies", r#""vitest": "^3", "tsx": "^4""#),
            ),
            DeclarationChanges::<NpmMoved> {
                development: true,
                ..DeclarationChanges::<NpmMoved>::default()
            }
        );
        assert!(
            npm_changes(
                &deps("peerDependencies", r#""host": "^1""#),
                &deps("peerDependencies", r#""host": "^1", "other": "^2""#),
            )
            .needs_intent
        );
        for (base, head) in [
            (r#""core": "^1""#, r#""core": "workspace:^""#),
            (r#""x": "workspace:*""#, r#""x": "workspace:^""#),
        ] {
            let got = npm_changes(&deps("dependencies", base), &deps("dependencies", head));
            assert!(got.needs_intent && got.moved.is_empty(), "{head}: {got:?}");
        }
        assert_eq!(
            npm_changes(
                &deps("devDependencies", r#""core": "workspace:*""#),
                &deps("devDependencies", r#""core": "workspace:^""#),
            ),
            DeclarationChanges::<NpmMoved> {
                development: true,
                ..DeclarationChanges::<NpmMoved>::default()
            }
        );
    }

    /// Found through a catalog, `mine` installs the member `core`: switching
    /// its catalog is an edit to a member entry, which needs intent.
    #[test]
    fn a_member_reached_through_a_catalog_alias_is_a_member_entry() {
        let yaml = "catalog:\n  mine: npm:core@^1\ncatalogs:\n  next:\n    mine: npm:core@^2\n";
        let at = |spec: &str| deps("dependencies", &format!(r#""mine": "{spec}""#));
        let got = npm_changes_with(&at("catalog:"), &at("catalog:next"), Some(yaml), Some(yaml))
            .expect("resolves");
        assert!(got.needs_intent && got.moved.is_empty(), "{got:?}");
    }

    /// A same-named entry in another table does not hide a member entry.
    #[test]
    fn member_keys_are_read_per_table() {
        let side = NpmSide {
            manifest: r#"{ "dependencies": { "alias": "npm:core@^1" }, "devDependencies": { "alias": "npm:left-pad@^1", "other": "^1" } }"#,
            workspace_file: None,
        };
        assert_eq!(
            npm_member_keys(side, &members()).expect("reads"),
            BTreeSet::from([String::from("alias")])
        );
    }

    #[test]
    fn an_entry_moving_between_tables_needs_intent() {
        for table in ["peerDependencies", "optionalDependencies"] {
            let got = npm_changes(
                &deps("dependencies", r#""react": "^18""#),
                &deps(table, r#""react": "^18""#),
            );
            assert!(got.needs_intent && got.moved.is_empty(), "{table}: {got:?}");
        }
    }

    #[test]
    fn default_and_named_catalogs_resolve() {
        let yaml = "catalog:\n  react: ^18.2.0\ncatalogs:\n  web:\n    react: ' ^19.0.0 '\n";
        let at = |spec: &str| deps("dependencies", &format!(r#""react": "{spec}""#));
        let read = |spec: &str| {
            npm_changes_with(&at("^18.2.0"), &at(spec), Some(yaml), Some(yaml)).expect(spec)
        };
        assert_eq!(read("catalog:default"), DeclarationChanges::default());
        assert_eq!(read("catalog:"), DeclarationChanges::default());
        assert_eq!(read("catalog:web").moved()[0].after, "^19.0.0");
    }

    #[test]
    fn a_duplicate_default_catalog_is_named() {
        let err = npm_changes_with(
            &deps("dependencies", r#""react": "^18""#),
            &deps("dependencies", r#""react": "catalog:""#),
            None,
            Some("catalog:\n  react: ^18\ncatalogs:\n  default:\n    react: ^18\n"),
        )
        .expect_err("two default catalogs");
        assert!(
            err.contains("both `catalog` and `catalogs.default`"),
            "{err}"
        );
    }

    #[test]
    fn a_malformed_npm_side_is_an_error_naming_it() {
        let good = deps("dependencies", r#""react": "^18""#);
        for (head, says) in [
            (String::from("[]"), "head side is not a JSON object"),
            (
                String::from(r#"{ "dependencies": [] }"#),
                "head side's `dependencies` is not an object",
            ),
            (
                deps("dependencies", r#""react": 1"#),
                "head side's `dependencies.react` is not a string",
            ),
        ] {
            assert_eq!(
                npm_changes_with(&good, &head, None, None),
                Err(String::from(says))
            );
        }
        let err = npm_changes_with(&good, &good, None, Some(":\n  - ["))
            .expect_err("yaml does not parse");
        assert!(err.starts_with("head side's pnpm-workspace.yaml"), "{err}");
    }

    #[test]
    fn an_unreadable_side_is_an_error_naming_it() {
        let err = changed_outside_dependencies(Ecosystem::Cargo, CARGO, "[package", &members())
            .expect_err("head is not TOML");
        assert!(err.starts_with("head side is not TOML"), "{err}");
        let err =
            changed_outside_dependencies(Ecosystem::Npm, "[]", NPM, &members()).expect_err("base");
        assert_eq!(err, "base side is not a JSON object");
    }
}