Auto merge of rust-lang#16352 - davidsemakula:rustfmt-import-sort-algo, r=Veykril

bors · bors · commit 0a8c7841e002 · 2024-01-16T11:23:03.000Z
internal: Follow rustfmt's algorithm for ordering imports when ordering and merging use trees Updates use tree ordering and merging utilities to follow rustfmt's algorithm for ordering imports. The [rustfmt implementation](https://github.com/rust-lang/rustfmt/blob/6356fca675bd756d71f5c123cd053d17b16c573e/src/imports.rs) was used as reference.
diff --git a/crates/ide-assists/src/handlers/bool_to_enum.rs b/crates/ide-assists/src/handlers/bool_to_enum.rs
@@ -986,7 +986,7 @@ fn foo() {
 }
 
 //- /main.rs
-use foo::{Foo, Bool};
+use foo::{Bool, Foo};
 
 mod foo;
 
@@ -1662,7 +1662,7 @@ impl Foo {
 }
 
 //- /foo.rs
-use crate::{Foo, Bool};
+use crate::{Bool, Foo};
 
 fn foo() -> bool {
     Foo::BOOL == Bool::True
diff --git a/crates/ide-assists/src/handlers/merge_imports.rs b/crates/ide-assists/src/handlers/merge_imports.rs
@@ -179,7 +179,7 @@ use std::fmt::Debug;
 use std::fmt$0::Display;
 ",
             r"
-use std::fmt::{Display, Debug};
+use std::fmt::{Debug, Display};
 ",
         );
     }
@@ -206,7 +206,7 @@ use std::fmt::{self, Display};
 use std::{fmt, $0fmt::Display};
 ",
             r"
-use std::{fmt::{Display, self}};
+use std::{fmt::{self, Display}};
 ",
         );
     }
@@ -318,7 +318,7 @@ use std::{fmt::{Debug, Display}};
 use std::{fmt::Debug, fmt$0::Display};
 ",
             r"
-use std::{fmt::{Display, Debug}};
+use std::{fmt::{Debug, Display}};
 ",
         );
     }
@@ -332,7 +332,7 @@ use std$0::{fmt::{Write, Display}};
 use std::{fmt::{self, Debug}};
 ",
             r"
-use std::{fmt::{Write, Display, self, Debug}};
+use std::{fmt::{self, Debug, Display, Write}};
 ",
         );
     }
@@ -346,7 +346,7 @@ use std$0::{fmt::{self, Debug}};
 use std::{fmt::{Write, Display}};
 ",
             r"
-use std::{fmt::{self, Debug, Write, Display}};
+use std::{fmt::{self, Debug, Display, Write}};
 ",
         );
     }
@@ -359,7 +359,7 @@ use std::{fmt::{self, Debug, Write, Display}};
 use std::{fmt$0::{self, Debug}, fmt::{Write, Display}};
 ",
             r"
-use std::{fmt::{self, Debug, Write, Display}};
+use std::{fmt::{self, Debug, Display, Write}};
 ",
         );
     }
@@ -401,7 +401,7 @@ use std$0::{fmt::*};
 use std::{fmt::{self, Display}};
 ",
             r"
-use std::{fmt::{*, self, Display}};
+use std::{fmt::{self, Display, *}};
 ",
         )
     }
@@ -496,7 +496,7 @@ use foo::$0{
 ",
             r"
 use foo::{
-    FooBar, bar::baz,
+    bar::baz, FooBar
 };
 ",
         )
@@ -521,7 +521,7 @@ use foo::$0*;
 use foo::bar::Baz;
 ",
             r"
-use foo::{*, bar::Baz};
+use foo::{bar::Baz, *};
 ",
         );
     }
@@ -539,7 +539,7 @@ $0use std::fmt::Result;
 ",
             r"
 use std::fmt::Error;
-use std::fmt::{Display, Debug, Write};
+use std::fmt::{Debug, Display, Write};
 use std::fmt::Result;
 ",
         );
@@ -560,15 +560,15 @@ use std::{
             r"
 use std::{
     fmt::Error,
-    fmt::{Display, Debug, Write},
+    fmt::{Debug, Display, Write},
     fmt::Result,
 };",
         );
         // FIXME: Remove redundant braces. See also unnecessary-braces diagnostic.
         check_assist(
             merge_imports,
             r"use std::$0{fmt::Display, fmt::Debug}$0;",
-            r"use std::{fmt::{Display, Debug}};",
+            r"use std::{fmt::{Debug, Display}};",
         );
     }
 }
diff --git a/crates/ide-assists/src/handlers/replace_qualified_name_with_use.rs b/crates/ide-assists/src/handlers/replace_qualified_name_with_use.rs
@@ -313,7 +313,7 @@ fn main() {
     ",
             r"
 mod std { pub mod fmt { pub trait Display {} } }
-use std::fmt::{Display, self};
+use std::fmt::{self, Display};
 
 fn main() {
     fmt;
diff --git a/crates/ide-db/src/imports/insert_use.rs b/crates/ide-db/src/imports/insert_use.rs
@@ -16,7 +16,7 @@ use syntax::{
 
 use crate::{
     imports::merge_imports::{
-        common_prefix, eq_attrs, eq_visibility, try_merge_imports, use_tree_path_cmp, MergeBehavior,
+        common_prefix, eq_attrs, eq_visibility, try_merge_imports, use_tree_cmp, MergeBehavior,
     },
     RootDatabase,
 };
@@ -357,15 +357,16 @@ fn insert_use_(
     use_item: ast::Use,
 ) {
     let scope_syntax = scope.as_syntax_node();
+    let insert_use_tree =
+        use_item.use_tree().expect("`use_item` should have a use tree for `insert_path`");
     let group = ImportGroup::new(insert_path);
     let path_node_iter = scope_syntax
         .children()
         .filter_map(|node| ast::Use::cast(node.clone()).zip(Some(node)))
         .flat_map(|(use_, node)| {
             let tree = use_.use_tree()?;
             let path = tree.path()?;
-            let has_tl = tree.use_tree_list().is_some();
-            Some((path, has_tl, node))
+            Some((path, tree, node))
         });
 
     if group_imports {
@@ -381,9 +382,7 @@ fn insert_use_(
         // find the element that would come directly after our new import
         let post_insert: Option<(_, _, SyntaxNode)> = group_iter
             .inspect(|(.., node)| last = Some(node.clone()))
-            .find(|&(ref path, has_tl, _)| {
-                use_tree_path_cmp(insert_path, false, path, has_tl) != Ordering::Greater
-            });
+            .find(|(_, use_tree, _)| use_tree_cmp(&insert_use_tree, use_tree) != Ordering::Greater);
 
         if let Some((.., node)) = post_insert {
             cov_mark::hit!(insert_group);
diff --git a/crates/ide-db/src/imports/insert_use/tests.rs b/crates/ide-db/src/imports/insert_use/tests.rs
@@ -596,15 +596,15 @@ fn merge_groups_full() {
 
 #[test]
 fn merge_groups_long_full() {
-    check_crate("std::foo::bar::Baz", r"use std::foo::bar::Qux;", r"use std::foo::bar::{Qux, Baz};")
+    check_crate("std::foo::bar::Baz", r"use std::foo::bar::Qux;", r"use std::foo::bar::{Baz, Qux};")
 }
 
 #[test]
 fn merge_groups_long_last() {
     check_module(
         "std::foo::bar::Baz",
         r"use std::foo::bar::Qux;",
-        r"use std::foo::bar::{Qux, Baz};",
+        r"use std::foo::bar::{Baz, Qux};",
     )
 }
 
@@ -613,7 +613,7 @@ fn merge_groups_long_full_list() {
     check_crate(
         "std::foo::bar::Baz",
         r"use std::foo::bar::{Qux, Quux};",
-        r"use std::foo::bar::{Qux, Quux, Baz};",
+        r"use std::foo::bar::{Baz, Quux, Qux};",
     )
 }
 
@@ -622,7 +622,7 @@ fn merge_groups_long_last_list() {
     check_module(
         "std::foo::bar::Baz",
         r"use std::foo::bar::{Qux, Quux};",
-        r"use std::foo::bar::{Qux, Quux, Baz};",
+        r"use std::foo::bar::{Baz, Quux, Qux};",
     )
 }
 
@@ -631,7 +631,7 @@ fn merge_groups_long_full_nested() {
     check_crate(
         "std::foo::bar::Baz",
         r"use std::foo::bar::{Qux, quux::{Fez, Fizz}};",
-        r"use std::foo::bar::{Qux, quux::{Fez, Fizz}, Baz};",
+        r"use std::foo::bar::{quux::{Fez, Fizz}, Baz, Qux};",
     )
 }
 
@@ -650,7 +650,7 @@ fn merge_groups_full_nested_deep() {
     check_crate(
         "std::foo::bar::quux::Baz",
         r"use std::foo::bar::{Qux, quux::{Fez, Fizz}};",
-        r"use std::foo::bar::{Qux, quux::{Fez, Fizz, Baz}};",
+        r"use std::foo::bar::{Qux, quux::{Baz, Fez, Fizz}};",
     )
 }
 
@@ -659,7 +659,7 @@ fn merge_groups_full_nested_long() {
     check_crate(
         "std::foo::bar::Baz",
         r"use std::{foo::bar::Qux};",
-        r"use std::{foo::bar::{Qux, Baz}};",
+        r"use std::{foo::bar::{Baz, Qux}};",
     );
 }
 
@@ -668,7 +668,7 @@ fn merge_groups_last_nested_long() {
     check_crate(
         "std::foo::bar::Baz",
         r"use std::{foo::bar::Qux};",
-        r"use std::{foo::bar::{Qux, Baz}};",
+        r"use std::{foo::bar::{Baz, Qux}};",
     );
 }
 
@@ -733,7 +733,7 @@ fn merge_mod_into_glob() {
     check_with_config(
         "token::TokenKind",
         r"use token::TokenKind::*;",
-        r"use token::TokenKind::{*, self};",
+        r"use token::TokenKind::{self, *};",
         &InsertUseConfig {
             granularity: ImportGranularity::Crate,
             enforce_granularity: true,
@@ -742,15 +742,14 @@ fn merge_mod_into_glob() {
             skip_glob_imports: false,
         },
     )
-    // FIXME: have it emit `use token::TokenKind::{self, *}`?
 }
 
 #[test]
 fn merge_self_glob() {
     check_with_config(
         "self",
         r"use self::*;",
-        r"use self::{*, self};",
+        r"use self::{self, *};",
         &InsertUseConfig {
             granularity: ImportGranularity::Crate,
             enforce_granularity: true,
@@ -759,7 +758,6 @@ fn merge_self_glob() {
             skip_glob_imports: false,
         },
     )
-    // FIXME: have it emit `use {self, *}`?
 }
 
 #[test]
@@ -769,7 +767,7 @@ fn merge_glob() {
         r"
 use syntax::{SyntaxKind::*};",
         r"
-use syntax::{SyntaxKind::{*, self}};",
+use syntax::{SyntaxKind::{self, *}};",
     )
 }
 
@@ -778,7 +776,7 @@ fn merge_glob_nested() {
     check_crate(
         "foo::bar::quux::Fez",
         r"use foo::bar::{Baz, quux::*};",
-        r"use foo::bar::{Baz, quux::{*, Fez}};",
+        r"use foo::bar::{Baz, quux::{Fez, *}};",
     )
 }
 
@@ -787,7 +785,7 @@ fn merge_nested_considers_first_segments() {
     check_crate(
         "hir_ty::display::write_bounds_like_dyn_trait",
         r"use hir_ty::{autoderef, display::{HirDisplayError, HirFormatter}, method_resolution};",
-        r"use hir_ty::{autoderef, display::{HirDisplayError, HirFormatter, write_bounds_like_dyn_trait}, method_resolution};",
+        r"use hir_ty::{autoderef, display::{write_bounds_like_dyn_trait, HirDisplayError, HirFormatter}, method_resolution};",
     );
 }
 
diff --git a/crates/ide-db/src/imports/merge_imports.rs b/crates/ide-db/src/imports/merge_imports.rs
diff --git a/crates/stdx/src/lib.rs b/crates/stdx/src/lib.rs

Original file line number	Diff line number	Diff line change
`@@ -986,7 +986,7 @@ fn foo() {`
`986`	`986`	`}`
`987`	`987`
`988`	`988`	`//- /main.rs`
`989`		`-use foo::{Foo, Bool};`
	`989`	`+use foo::{Bool, Foo};`
`990`	`990`
`991`	`991`	`mod foo;`
`992`	`992`
`@@ -1662,7 +1662,7 @@ impl Foo {`
`1662`	`1662`	`}`
`1663`	`1663`
`1664`	`1664`	`//- /foo.rs`
`1665`		`-use crate::{Foo, Bool};`
	`1665`	`+use crate::{Bool, Foo};`
`1666`	`1666`
`1667`	`1667`	`fn foo() -> bool {`
`1668`	`1668`	`Foo::BOOL == Bool::True`
Original file line number	Diff line number	Diff line change
`@@ -596,15 +596,15 @@ fn merge_groups_full() {`
`596`	`596`
`597`	`597`	`#[test]`
`598`	`598`	`fn merge_groups_long_full() {`
`599`		`- check_crate("std::foo::bar::Baz", r"use std::foo::bar::Qux;", r"use std::foo::bar::{Qux, Baz};")`
	`599`	`+ check_crate("std::foo::bar::Baz", r"use std::foo::bar::Qux;", r"use std::foo::bar::{Baz, Qux};")`
`600`	`600`	`}`
`601`	`601`
`602`	`602`	`#[test]`
`603`	`603`	`fn merge_groups_long_last() {`
`604`	`604`	`check_module(`
`605`	`605`	`"std::foo::bar::Baz",`
`606`	`606`	`r"use std::foo::bar::Qux;",`
`607`		`- r"use std::foo::bar::{Qux, Baz};",`
	`607`	`+ r"use std::foo::bar::{Baz, Qux};",`
`608`	`608`	`)`
`609`	`609`	`}`
`610`	`610`
`@@ -613,7 +613,7 @@ fn merge_groups_long_full_list() {`
`613`	`613`	`check_crate(`
`614`	`614`	`"std::foo::bar::Baz",`
`615`	`615`	`r"use std::foo::bar::{Qux, Quux};",`
`616`		`- r"use std::foo::bar::{Qux, Quux, Baz};",`
	`616`	`+ r"use std::foo::bar::{Baz, Quux, Qux};",`
`617`	`617`	`)`
`618`	`618`	`}`
`619`	`619`
`@@ -622,7 +622,7 @@ fn merge_groups_long_last_list() {`
`622`	`622`	`check_module(`
`623`	`623`	`"std::foo::bar::Baz",`
`624`	`624`	`r"use std::foo::bar::{Qux, Quux};",`
`625`		`- r"use std::foo::bar::{Qux, Quux, Baz};",`
	`625`	`+ r"use std::foo::bar::{Baz, Quux, Qux};",`
`626`	`626`	`)`
`627`	`627`	`}`
`628`	`628`
`@@ -631,7 +631,7 @@ fn merge_groups_long_full_nested() {`
`631`	`631`	`check_crate(`
`632`	`632`	`"std::foo::bar::Baz",`
`633`	`633`	`r"use std::foo::bar::{Qux, quux::{Fez, Fizz}};",`
`634`		`- r"use std::foo::bar::{Qux, quux::{Fez, Fizz}, Baz};",`
	`634`	`+ r"use std::foo::bar::{quux::{Fez, Fizz}, Baz, Qux};",`
`635`	`635`	`)`
`636`	`636`	`}`
`637`	`637`
`@@ -650,7 +650,7 @@ fn merge_groups_full_nested_deep() {`
`650`	`650`	`check_crate(`
`651`	`651`	`"std::foo::bar::quux::Baz",`
`652`	`652`	`r"use std::foo::bar::{Qux, quux::{Fez, Fizz}};",`
`653`		`- r"use std::foo::bar::{Qux, quux::{Fez, Fizz, Baz}};",`
	`653`	`+ r"use std::foo::bar::{Qux, quux::{Baz, Fez, Fizz}};",`
`654`	`654`	`)`
`655`	`655`	`}`
`656`	`656`
`@@ -659,7 +659,7 @@ fn merge_groups_full_nested_long() {`
`659`	`659`	`check_crate(`
`660`	`660`	`"std::foo::bar::Baz",`
`661`	`661`	`r"use std::{foo::bar::Qux};",`
`662`		`- r"use std::{foo::bar::{Qux, Baz}};",`
	`662`	`+ r"use std::{foo::bar::{Baz, Qux}};",`
`663`	`663`	`);`
`664`	`664`	`}`
`665`	`665`
`@@ -668,7 +668,7 @@ fn merge_groups_last_nested_long() {`
`668`	`668`	`check_crate(`
`669`	`669`	`"std::foo::bar::Baz",`
`670`	`670`	`r"use std::{foo::bar::Qux};",`
`671`		`- r"use std::{foo::bar::{Qux, Baz}};",`
	`671`	`+ r"use std::{foo::bar::{Baz, Qux}};",`
`672`	`672`	`);`
`673`	`673`	`}`
`674`	`674`
`@@ -733,7 +733,7 @@ fn merge_mod_into_glob() {`
`733`	`733`	`check_with_config(`
`734`	`734`	`"token::TokenKind",`
`735`	`735`	`r"use token::TokenKind::*;",`
`736`		`- r"use token::TokenKind::{*, self};",`
	`736`	`+ r"use token::TokenKind::{self, *};",`
`737`	`737`	`&InsertUseConfig {`
`738`	`738`	`granularity: ImportGranularity::Crate,`
`739`	`739`	`enforce_granularity: true,`
`@@ -742,15 +742,14 @@ fn merge_mod_into_glob() {`
`742`	`742`	`skip_glob_imports: false,`
`743`	`743`	`},`
`744`	`744`	`)`
`745`		- // FIXME: have it emit `use token::TokenKind::{self, *}`?
`746`	`745`	`}`
`747`	`746`
`748`	`747`	`#[test]`
`749`	`748`	`fn merge_self_glob() {`
`750`	`749`	`check_with_config(`
`751`	`750`	`"self",`
`752`	`751`	`r"use self::*;",`
`753`		`- r"use self::{*, self};",`
	`752`	`+ r"use self::{self, *};",`
`754`	`753`	`&InsertUseConfig {`
`755`	`754`	`granularity: ImportGranularity::Crate,`
`756`	`755`	`enforce_granularity: true,`
`@@ -759,7 +758,6 @@ fn merge_self_glob() {`
`759`	`758`	`skip_glob_imports: false,`
`760`	`759`	`},`
`761`	`760`	`)`
`762`		- // FIXME: have it emit `use {self, *}`?
`763`	`761`	`}`
`764`	`762`
`765`	`763`	`#[test]`
`@@ -769,7 +767,7 @@ fn merge_glob() {`
`769`	`767`	`r"`
`770`	`768`	`use syntax::{SyntaxKind::*};",`
`771`	`769`	`r"`
`772`		`-use syntax::{SyntaxKind::{*, self}};",`
	`770`	`+use syntax::{SyntaxKind::{self, *}};",`
`773`	`771`	`)`
`774`	`772`	`}`
`775`	`773`
`@@ -778,7 +776,7 @@ fn merge_glob_nested() {`
`778`	`776`	`check_crate(`
`779`	`777`	`"foo::bar::quux::Fez",`
`780`	`778`	`r"use foo::bar::{Baz, quux::*};",`
`781`		`- r"use foo::bar::{Baz, quux::{*, Fez}};",`
	`779`	`+ r"use foo::bar::{Baz, quux::{Fez, *}};",`
`782`	`780`	`)`
`783`	`781`	`}`
`784`	`782`
`@@ -787,7 +785,7 @@ fn merge_nested_considers_first_segments() {`
`787`	`785`	`check_crate(`
`788`	`786`	`"hir_ty::display::write_bounds_like_dyn_trait",`
`789`	`787`	`r"use hir_ty::{autoderef, display::{HirDisplayError, HirFormatter}, method_resolution};",`
`790`		`- r"use hir_ty::{autoderef, display::{HirDisplayError, HirFormatter, write_bounds_like_dyn_trait}, method_resolution};",`
	`788`	`+ r"use hir_ty::{autoderef, display::{write_bounds_like_dyn_trait, HirDisplayError, HirFormatter}, method_resolution};",`
`791`	`789`	`);`
`792`	`790`	`}`
`793`	`791`