Skip to content

Commit f72d73b

Browse files
committed
fix(add): Preserve comments when updating simple deps
A case the tests showed but isn't covered here is when a `[features]` table is created, the dependencies-end comment gets attached to that, e.g. see cargo_add/overwrite_optional Fixes #13645
1 parent 57944a7 commit f72d73b

File tree

7 files changed

+28
-11
lines changed

7 files changed

+28
-11
lines changed

src/cargo/util/toml_mut/dependency.rs

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -474,9 +474,18 @@ impl Dependency {
474474
item: &mut toml_edit::Item,
475475
) {
476476
if str_or_1_len_table(item) {
477-
// Nothing to preserve
478-
*item = self.to_toml(crate_root);
479-
key.fmt();
477+
// Little to preserve
478+
let mut new_item = self.to_toml(crate_root);
479+
match (&item, &mut new_item) {
480+
(toml_edit::Item::Value(old), toml_edit::Item::Value(new)) => {
481+
*new.decor_mut() = old.decor().clone();
482+
}
483+
(toml_edit::Item::Table(old), toml_edit::Item::Table(new)) => {
484+
*new.decor_mut() = old.decor().clone();
485+
}
486+
(_, _) => {}
487+
}
488+
*item = new_item;
480489
} else if let Some(table) = item.as_table_like_mut() {
481490
match &self.source {
482491
Some(Source::Registry(src)) => {

tests/testsuite/cargo_add/overwrite_default_features/out/Cargo.toml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ version = "0.0.0"
66
edition = "2015"
77

88
[dependencies]
9-
my-package1 = "99999.0.0"
10-
my-package2 = "0.4.1"
9+
# Before my-package1
10+
my-package1 = "99999.0.0" # After my-package1
11+
# Before my-package2
12+
my-package2 = "0.4.1" # After my-package2
1113
# End

tests/testsuite/cargo_add/overwrite_no_default_features/out/Cargo.toml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ version = "0.0.0"
66
edition = "2015"
77

88
[dependencies]
9-
my-package1 = { version = "99999.0.0", default-features = false }
10-
my-package2 = { version = "0.4.1", default-features = false }
9+
# Before my-package1
10+
my-package1 = { version = "99999.0.0", default-features = false } # After my-package1
11+
# Before my-package2
12+
my-package2 = { version = "0.4.1", default-features = false } # After my-package2
1113
# End

tests/testsuite/cargo_add/overwrite_no_optional/out/Cargo.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,6 @@ version = "0.0.0"
66
edition = "2015"
77

88
[dependencies]
9-
my-package = "0.1.0"
9+
# Before my-package
10+
my-package = "0.1.0" # After my-package
1011
# End

tests/testsuite/cargo_add/overwrite_no_public/out/Cargo.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,6 @@ version = "0.0.0"
77
edition = "2015"
88

99
[dependencies]
10-
my-package = "0.1.0"
10+
# Before my-package
11+
my-package = "0.1.0" # After my-package
1112
# End

tests/testsuite/cargo_add/overwrite_optional/out/Cargo.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ version = "0.0.0"
66
edition = "2015"
77

88
[dependencies]
9-
my-package = { version = "0.1.0", optional = true }
9+
# Before my-package
10+
my-package = { version = "0.1.0", optional = true } # After my-package
1011

1112
[features]
1213
my-package = ["dep:my-package"]

tests/testsuite/cargo_add/overwrite_public/out/Cargo.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,6 @@ version = "0.0.0"
77
edition = "2015"
88

99
[dependencies]
10-
my-package = { version = "0.1.0", public = true }
10+
# Before my-package
11+
my-package = { version = "0.1.0", public = true } # After my-package
1112
# End

0 commit comments

Comments
 (0)