config: preserve definition order of table items

toml_edit uses IndexMap internally, so the order of table items is deterministic.
yuja · Dec 9, 2024 · abcea5c · abcea5c
1 parent 2ea75a8
commit abcea5c
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 15 deletions.
diff --git a/cli/src/cli_util.rs b/cli/src/cli_util.rs
@@ -2702,8 +2702,7 @@ fn load_template_aliases(
                 .into());
             }
         };
-        // TODO: remove sorting after migrating to toml_edit
-        for (decl, item) in table.iter().sorted_by_key(|&(decl, _)| decl) {
+        for (decl, item) in table.iter() {
             let r = item
                 .as_str()
                 .ok_or_else(|| format!("Expected a string, but is {}", item.type_name()))

diff --git a/cli/src/config.rs b/cli/src/config.rs
@@ -97,8 +97,7 @@ pub fn resolved_config_values(
                 // table.iter() does not implement DoubleEndedIterator as of
                 // toml_edit 0.22.22.
                 let frame = config_stack.len();
-                // TODO: Remove sorting
-                for (k, v) in table.iter().sorted_by_key(|(k, _)| *k) {
+                for (k, v) in table.iter() {
                     let mut sub_name = name.clone();
                     sub_name.push(k);
                     config_stack.push((sub_name, v));
@@ -771,7 +770,7 @@ mod tests {
                             dotted_decor: Decor { .. },
                         },
                         Key {
-                            key: "email",
+                            key: "name",
                             repr: None,
                             leaf_decor: Decor { .. },
                             dotted_decor: Decor { .. },
@@ -780,13 +779,13 @@ mod tests {
                 ),
                 value: String(
                     Formatted {
-                        value: "base@user.email",
+                        value: "base-user-name",
                         repr: "default",
                         decor: Decor { .. },
                     },
                 ),
                 source: EnvBase,
-                is_overridden: true,
+                is_overridden: false,
             },
             AnnotatedValue {
                 name: ConfigNamePathBuf(
@@ -798,7 +797,7 @@ mod tests {
                             dotted_decor: Decor { .. },
                         },
                         Key {
-                            key: "name",
+                            key: "email",
                             repr: None,
                             leaf_decor: Decor { .. },
                             dotted_decor: Decor { .. },
@@ -807,13 +806,13 @@ mod tests {
                 ),
                 value: String(
                     Formatted {
-                        value: "base-user-name",
+                        value: "base@user.email",
                         repr: "default",
                         decor: Decor { .. },
                     },
                 ),
                 source: EnvBase,
-                is_overridden: false,
+                is_overridden: true,
             },
             AnnotatedValue {
                 name: ConfigNamePathBuf(

diff --git a/cli/src/revset_util.rs b/cli/src/revset_util.rs
@@ -184,8 +184,7 @@ pub fn load_revset_aliases(
                 .into());
             }
         };
-        // TODO: remove sorting after migrating to toml_edit
-        for (decl, item) in table.iter().sorted_by_key(|&(decl, _)| decl) {
+        for (decl, item) in table.iter() {
             warn_user_redefined_builtin(ui, layer.source, decl)?;
 
             let r = item

diff --git a/cli/tests/test_config_command.rs b/cli/tests/test_config_command.rs
@@ -78,8 +78,8 @@ fn test_config_list_table() {
         stdout,
         @r###"
     test-table.x = true
-    test-table.y.bar = 123
     test-table.y.foo = "abc"
+    test-table.y.bar = 123
     test-table.z."with space"."function()" = 5
     "###);
 }
@@ -133,10 +133,10 @@ fn test_config_list_all() {
     insta::assert_snapshot!(
         find_stdout_lines(r"(test-val|test-table\b[^=]*)", &stdout),
         @r###"
+    test-val = [1, 2, 3]
     test-table.x = true
-    test-table.y.bar = 123
     test-table.y.foo = "abc"
-    test-val = [1, 2, 3]
+    test-table.y.bar = 123
     "###);
 }