Migrate merge_imports Assist to Use SyntaxFactory

[tareknaser]

This PR is part of #15710 and #18285.

Changes Made

• Followed the steps in Migrate assists to SyntaxEditor #18285 for migration.
• Removed the edits_mut vector from crates/ide-assists/src/handlers/merge_imports.rs
• Added a new SyntaxFactory method whitespace
  • There are no mappings needed as far as I am concerned
  • Currently named whitespace as it mirrors make::tokens::whitespace but tokens_whitespace might be a more fitting name.
• Replaced the edit_in_place::Removable trait with edit_in_place::EditorRemovable (Relevant conversation here)
  • This trait requires a SyntaxEditor instance in the remove method to use instead of ted.
  • Implemented for ast::Use and ast::UseTree
  • Most implementations remain the same, except that I used SyntaxEditor::delete instead of ted::remove and ted::remove_all_iter. Since SyntaxEditor::remove doesn’t exist, I assumed delete would perform the same function—though this might be causing issues.

[tareknaser]

Marking this as a draft for now since I’m running into an error.

---- handlers::merge_imports::tests::test_merge_with_synonymous_imports_1 stdout ----

thread 'handlers::merge_imports::tests::test_merge_with_synonymous_imports_1' panicked at crates/syntax/src/syntax_editor/edit_algo.rs:79:8:

some replace change ranges intersect: [Replace(Token(WHITESPACE@156..158 "\n\n"), Some(Token(WHITESPACE@0..2 "\n\n"))), Replace(Node(USE@158..172), None), Replace(Token(WHITESPACE@172..173 "\n"), None), Replace(Node(USE@173..197), Some(Node(USE@0..32)))]

  

---- handlers::merge_imports::tests::test_merge_with_synonymous_imports_2 stdout ----

thread 'handlers::merge_imports::tests::test_merge_with_synonymous_imports_2' panicked at crates/syntax/src/syntax_editor/edit_algo.rs:79:8:

some replace change ranges intersect: [Replace(Token(WHITESPACE@156..158 "\n\n"), Some(Token(WHITESPACE@0..2 "\n\n"))), Replace(Node(USE@158..172), None), Replace(Token(WHITESPACE@172..173 "\n"), None), Replace(Node(USE@173..202), Some(Node(USE@0..37)))]

  

---- tests::generated::doctest_merge_imports stdout ----

thread 'tests::generated::doctest_merge_imports' panicked at crates/syntax/src/syntax_editor/edit_algo.rs:79:8:

some replace change ranges intersect: [Replace(Node(USE@0..24), Some(Node(USE@0..30))), Replace(Token(WHITESPACE@24..25 "\n"), Some(Token(WHITESPACE@0..1 "\n"))), Replace(Node(USE@25..37), None), Replace(Token(WHITESPACE@37..38 "\n"), None)]

[ShoyuVanilla]

I'll review this tomorrow

[ShoyuVanilla]

I think that we can get node for SyntaxEditor inside the above if-else blocks; like let (node, target, edits) = if ctx.has_empty_selection() { ..

[ShoyuVanilla]

I think that to avoid the intersection assertion failure, we should use SyntaxEditor::replace_all for consecutive text ranges instead of individual insert or delete calls

[tareknaser]

So the edits are generated in a vector by calling either use_item.try_merge_from() or use_tree.try_merge_from(). How can we combine all of these edits into a single replace_all() call?

[bors]

☔ The latest upstream changes (presumably #18483) made this pull request unmergeable. Please resolve the merge conflicts.

[bors]

☔ The latest upstream changes (presumably #18657) made this pull request unmergeable. Please resolve the merge conflicts.

[tareknaser]

I've rebased this on top of master.
Right now, only a couple of tests are failing. one due to an extra parenthesis and the other because of replace intersection. Here’s the full error I’m getting:

Full error

failures:

---- handlers::merge_imports::tests::merge_selection_use_trees stdout ----
Left:
use std::fmt::{Debug, Display};

Right:
use std::{fmt::{Debug, Display}};

Diff:
use std::{fmt::{Debug, Display}};


thread 'handlers::merge_imports::tests::merge_selection_use_trees' panicked at crates/ide-assists/src/handlers/merge_imports.rs:741:9:
text differs
stack backtrace:
   0: rust_begin_unwind
             at /rustc/f6e511eec7342f59a25f7c0534f1dbea00d01b14/library/std/src/panicking.rs:662:5
   1: core::panicking::panic_fmt
             at /rustc/f6e511eec7342f59a25f7c0534f1dbea00d01b14/library/core/src/panicking.rs:74:14
   2: ide_assists::tests::check_with_config
             at ./src/tests.rs:308:13
   3: ide_assists::tests::check
             at ./src/tests.rs:231:5
   4: ide_assists::tests::check_assist
             at ./src/tests.rs:82:5
   5: ide_assists::handlers::merge_imports::tests::merge_selection_use_trees
             at ./src/handlers/merge_imports.rs:741:9
   6: ide_assists::handlers::merge_imports::tests::merge_selection_use_trees::{{closure}}
             at ./src/handlers/merge_imports.rs:712:35
   7: core::ops::function::FnOnce::call_once
             at /rustc/f6e511eec7342f59a25f7c0534f1dbea00d01b14/library/core/src/ops/function.rs:250:5
   8: core::ops::function::FnOnce::call_once
             at /rustc/f6e511eec7342f59a25f7c0534f1dbea00d01b14/library/core/src/ops/function.rs:250:5
note: Some details are omitted, run with `RUST_BACKTRACE=full` for a verbose backtrace.

---- handlers::merge_imports::tests::merge_selection_uses stdout ----
thread 'handlers::merge_imports::tests::merge_selection_uses' panicked at crates/syntax/src/syntax_editor/edit_algo.rs:79:8:
some replace change ranges intersect: [Replace(Node(USE@21..43), Some(Node(USE@0..38))), Replace(Token(WHITESPACE@43..44 "\n"), Some(Token(WHITESPACE@0..1 "\n"))), Replace(Node(USE@44..64), None), Replace(Token(WHITESPACE@64..65 "\n"), None), Replace(Token(WHITESPACE@64..65 "\n"), Some(Token(WHITESPACE@0..1 "\n"))), Replace(Node(USE@65..85), None), Replace(Token(WHITESPACE@85..86 "\n"), None)]
stack backtrace:
   0: rust_begin_unwind
             at /rustc/f6e511eec7342f59a25f7c0534f1dbea00d01b14/library/std/src/panicking.rs:662:5
   1: core::panicking::panic_fmt
             at /rustc/f6e511eec7342f59a25f7c0534f1dbea00d01b14/library/core/src/panicking.rs:74:14
   2: syntax::syntax_editor::edit_algo::apply_edits
             at /Users/tareknasser/Documents/workspace/mlh/rust-analyzer/crates/syntax/src/syntax_editor/edit_algo.rs:79:8
   3: syntax::syntax_editor::SyntaxEditor::finish
             at /Users/tareknasser/Documents/workspace/mlh/rust-analyzer/crates/syntax/src/syntax_editor.rs:102:9
   4: ide_db::source_change::SourceChangeBuilder::commit
             at /Users/tareknasser/Documents/workspace/mlh/rust-analyzer/crates/ide-db/src/source_change.rs:288:31
   5: ide_db::source_change::SourceChangeBuilder::finish
             at /Users/tareknasser/Documents/workspace/mlh/rust-analyzer/crates/ide-db/src/source_change.rs:457:9
   6: ide_assists::assist_context::Assists::add_impl
             at ./src/assist_context.rs:201:18
   7: ide_assists::assist_context::Assists::add
             at ./src/assist_context.rs:169:9
   8: ide_assists::handlers::merge_imports::merge_imports
             at ./src/handlers/merge_imports.rs:79:5
   9: ide_assists::tests::check_with_config
             at ./src/tests.rs:255:5
  10: ide_assists::tests::check
             at ./src/tests.rs:231:5
  11: ide_assists::tests::check_assist
             at ./src/tests.rs:82:5
  12: ide_assists::handlers::merge_imports::tests::merge_selection_uses
             at ./src/handlers/merge_imports.rs:677:9
  13: ide_assists::handlers::merge_imports::tests::merge_selection_uses::{{closure}}
             at ./src/handlers/merge_imports.rs:675:30
  14: core::ops::function::FnOnce::call_once
             at /rustc/f6e511eec7342f59a25f7c0534f1dbea00d01b14/library/core/src/ops/function.rs:250:5
  15: core::ops::function::FnOnce::call_once
             at /rustc/f6e511eec7342f59a25f7c0534f1dbea00d01b14/library/core/src/ops/function.rs:250:5
note: Some details are omitted, run with `RUST_BACKTRACE=full` for a verbose backtrace.


failures:
    handlers::merge_imports::tests::merge_selection_use_trees
    handlers::merge_imports::tests::merge_selection_uses