Support multi-caret when inserting doc comments

[Youssef1313]

Fixes #54391

[CyrusNajmabadi]

I'm ok with this (esp. with how minimal the code is). but would def want a test for this :)

[CyrusNajmabadi]

Is thsi fixing some reported issue?

[Youssef1313]

Is thsi fixing some reported issue?

Yeah I forgot to add it. Will link it from PR description: #54391

[Youssef1313]

Test infrastructure doesn't seem to be working with multi-caret (or possibly I can't write a proper test?). I'll look into how to fix that.

[Youssef1313]

@CyrusNajmabadi I was unable to write a test. Can you take a look so that we can get it merged? Thanks!

[Youssef1313]

@CyrusNajmabadi Can you take a look please?

[sharwell]

@Youssef1313 should be possible to write an integration test for this in the new integration test project

[sharwell]

An integration test should be easy in the new integration test project

[Youssef1313]

@sharwell Which project? Can you point me please? Thanks!

[sharwell]

[sharwell]

The current tests have examples for how to do a bunch of different things. If you don't see a similar example for something you need, feel free to ask.

[Youssef1313]

@sharwell I couldn't find a test that does multi-caret. When I tried to do it I got System.ArgumentException : Saw multiple occurrences of $$

        [IdeFact]
        [WorkItem(54391, "https://github.com/dotnet/roslyn/issues/54391")]
        public async Task TypingCharacter_MultiCaret()
        {
            var code =
@"
//$$
class C1 { }

//$$
class C2 { }

//$$
class C3 { }
";
            await SetUpEditorAsync(code, HangMitigatingCancellationToken);
            await TestServices.Input.SendAsync('/');
            var expected =
@"
/// <summary>
/// $$
/// </summary>
class C1 { }

/// <summary>
///
/// </summary>
class C2 { }

/// <summary>
///
/// </summary>
class C3 { }
";

            await TestServices.EditorVerifier.TextContainsAsync(expected, cancellationToken: HangMitigatingCancellationToken);
        }

[Youssef1313]

Also tried:

//$$
class C1 { }

//[||]
class C2 { }

//[||]
class C3 { }

But fails with System.Runtime.InteropServices.COMException : Error HRESULT E_FAIL has been returned from a call to a COM component.

[davidwengier]

@Youssef1313 I took the liberty of updating the test. The issues were:

• The test framework didn't support multi-caret, so I added some basic support
• You didn't have a constructor in your test class, so didn't get a solution and project automatically created, so when calling SetupEditorAsync the COM exception occurred, because there wasn't an editor to setup.
• You weren't asserting the caret position, so the test was expecting to see $$ in the actual editor
• You missed a couple of bits of whitespace

All in all though, you did a great job (unsurprisingly 😁)

[Youssef1313]

@davidwengier Thanks a lot!!

[MartyIX]

@Youssef1313 Do you have more up-to-date gif? Just curious. ;-)

[Youssef1313]

@MartyIX Oh looks like the software I used produced a bad GIF 😄

Will build the branch and update it soon.