`cargo add` reformats the features lists

[lopopolo]

Problem

cargo add does not preserve formatting of TOML lists unrelated to the [dependencies] table

Steps

With the following Cargo.toml:

[package]
name = "xxx"
version = "0.1.0"
edition = "2021"

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

[dependencies]

[features]
default = [
  "a",
  "b",
  "c",
]
a = []
b = []
c = []

Run:

$ cargo add directories
    Updating crates.io index
      Adding directories v4.0.1 to dependencies.

observe that the [features] table is reformatted:

diff --git i/Cargo.toml w/Cargo.toml
index ccae1b6..61c1383 100644
--- i/Cargo.toml
+++ w/Cargo.toml
@@ -6,13 +6,10 @@ edition = "2021"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

 [dependencies]
+directories = "4.0.1"

 [features]
-default = [
-  "a",
-  "b",
-  "c",
-]
+default = ["a", "b", "c"]
 a = []
 b = []
 c = []

Possible Solution(s)

Preserve formatting of all TOML contents outside of the newly added dependency.

Notes

No response

Version

cargo 1.67.1 (8ecd4f20a 2023-01-10)
release: 1.67.1
commit-hash: 8ecd4f20a9efb626975ac18a016d480dc7183d9b
commit-date: 2023-01-10
host: x86_64-apple-darwin
libgit2: 1.5.0 (sys:0.16.0 vendored)
libcurl: 7.86.0 (sys:0.4.59+curl-7.86.0 system ssl:(SecureTransport) LibreSSL/3.3.6)
os: Mac OS 13.2.1 [64-bit]

[lopopolo]

Although in this case, the reformatting is ok-ish, in a large workspace I have, I have a cargo workspace with 20+ members. To enable easy diffing, I keep this list manually formatted with one workspace member per line.

cargo add reformats this entire list into a single line.

[lopopolo]

On an unrelated note, cargo add appends the new dependency to the end of the [dependencies] table and does not attempt to respect existing alphabetization as npm install does.

[weihanglo]

Just did a simple bisect. This regression started from 1.66.

On an unrelated note, cargo add appends the new dependency to the end of the [dependencies] table and does not attempt to respect existing alphabetization as npm install does.

This might be a bug as well 🥲. If you have a reproducible example, please file an issue. Thank you!

[epage]

Yes, maintaining sorting is expected behavior. We did have #11584 which was fixed in #11612 which is not yet in a stable version

[epage]

I think this was broken in #11099, specifically 7c218b1. When cargo rm removes a feature, it needs to fix up the whitespace but the existing fix instead removes user formatting

[lopopolo]

Thanks @weihanglo and @epage. I added another ticket with a reproducer for the sorting bug at #11744.

[lopopolo]

specifically 7c218b1.

@epage the reproducer I added does not show this, but I also observed the [workspace] table being reformatted, specifically workspace.members.

[epage]

specifically 7c218b1.

@epage the reproducer I added does not show this, but I also observed the [workspace] table being reformatted, specifically workspace.members.

That deserves another issue. We should not even be touching workspace.members at the moment.

[lopopolo]

That deserves another issue. We should not even be touching workspace.members at the moment.

doh! I was confident but confidently wrong. Sorry, I did not look too closely at the big diff in my real project. It was indeed the features table that was reformatted. I forgot I had so many features.

To be clear, I do not have a reproducer for workspace.members being reformatted and I did not observe that behavior.

Sorry!

This was the diff that confused me (the features are similarly named to the crates in the workspace):

diff --git i/Cargo.toml w/Cargo.toml
index 11e5119e02..6d965711e6 100644
--- i/Cargo.toml
+++ w/Cargo.toml
@@ -35,6 +35,7 @@ scolapasta-path = { version = "0.5.0", path = "scolapasta-path" }
 scolapasta-string-escape = { version = "0.3.0", path = "scolapasta-string-escape", default-features = false }
 rustyline = { version = "10.0.0", optional = true, default-features = false }
 termcolor = { version = "1.1.0", optional = true }
+directories = "4.0.1"

 [dependencies.artichoke-backend]
 version = "0.20.0"
@@ -91,35 +92,17 @@ lto = true
 strip = true

 [features]
-default = [
-  "backtrace",
-  "cli",
-  "kitchen-sink",
-]
+default = ["backtrace", "cli", "kitchen-sink"]
 # Enable a CLI frontend for Artichoke, including a `ruby`-equivalent CLI and
 # REPL.
 cli = ["backtrace", "dep:clap", "dep:log", "dep:rustyline"]
 # Enable a module for formtting backtraces from Ruby exceptions.
 backtrace = ["dep:termcolor"]
 # Enable all features of Ruby Core, Standard Library, and the underlying VM.
-kitchen-sink = [
-  "core-full",
-  "load-path-native-file-system-loader",
-  "load-path-rubylib-native-file-system-loader",
-  "stdlib-full",
-]
+kitchen-sink = ["core-full", "load-path-native-file-system-loader", "load-path-rubylib-native-file-system-loader", "stdlib-full"]

 # Enable every API in Ruby Core
-core-full = [
-  "core-env",
-  "core-env-system",
-  "core-math",
-  "core-math-full",
-  "core-random",
-  "core-regexp",
-  "core-regexp-oniguruma",
-  "core-time",
-]
+core-full = ["core-env", "core-env-system", "core-math", "core-math-full", "core-random", "core-regexp", "core-regexp-oniguruma",
 "core-time"]
 # Enable resolving environment variables with the `ENV` core object.
 core-env = ["artichoke-backend/core-env"]
 # Enable resolving environment variables with the `ENV` core object using native
@@ -162,22 +145,7 @@ output-strategy-capture = ["artichoke-backend/output-strategy-capture"]
 output-strategy-null = ["output-strategy-capture", "artichoke-backend/output-strategy-null"]

 # Enable every integrated standard library package.
-stdlib-full = [
-  "stdlib-abbrev",
-  "stdlib-base64",
-  "stdlib-cmath",
-  "stdlib-delegate",
-  "stdlib-forwardable",
-  "stdlib-json",
-  "stdlib-monitor",
-  "stdlib-ostruct",
-  "stdlib-securerandom",
-  "stdlib-set",
-  "stdlib-shellwords",
-  "stdlib-strscan",
-  "stdlib-time",
-  "stdlib-uri",
-]
+stdlib-full = ["stdlib-abbrev", "stdlib-base64", "stdlib-cmath", "stdlib-delegate", "stdlib-forwardable", "stdlib-json", "stdlib-
monitor", "stdlib-ostruct", "stdlib-securerandom", "stdlib-set", "stdlib-shellwords", "stdlib-strscan", "stdlib-time", "stdlib-uri
"]
 stdlib-abbrev = ["artichoke-backend/stdlib-abbrev"]
 stdlib-base64 = ["artichoke-backend/stdlib-base64"]
 stdlib-cmath = ["artichoke-backend/stdlib-cmath"]

[SummerGram]

Hi,

cargo add <a> should only append a to the dependencies only. Is it correct?

I would like to contribute this.