Convert single-line raw strings into multi-line on pressing <enter> by Rekkonnect · Pull Request #75648 · dotnet/roslyn

Rekkonnect · 2024-10-27T11:01:36Z

I took the liberty to fix it myself since no progress was made on the original issue despite the assignment.

CyrusNajmabadi · 2024-10-27T14:46:43Z

src/EditorFeatures/CSharpTest/RawStringLiteral/RawStringLiteralCommandHandlerTests.cs

+                $$following text {0}
+                """;
+            """");
+    }


Add tests inside an interpolation.
Add tests before a quote that is or is not part of the end delimiter.

Add tests when caret is on the {

Added more tests and supported the above cases ptal

CyrusNajmabadi · 2024-10-27T14:48:58Z

src/EditorFeatures/CSharp/RawStringLiteral/RawStringLiteralCommandHandler_Return.cs

+        edit.Insert(closingStart, newLineAndIndentation);
+        // Add a newline at the requested position
+        edit.Insert(position, newLineAndIndentation);
+        // Also add a newline at the start of the text, only if there is text before the requested position


Why only then?

Because the user might be trying to convert the single-line into a multi-line raw string, so they'd naturally position the cursor right after the starting delimiter to press enter. That's how I've converted mine too.

But then, wouldn't they want anewline added in that case as well?

The logic is to follow as shown in the tests:

In """$$text""" if I press enter it's more likely I want to just make it a multi-line raw string than to enter a new-line before the text. If I want to add two newlines there instead of one, I'm still capable of pressing enter twice to add the second newline. The purpose of this command is to auto-format the closing delimiter to avoid the compiler error.

If I put the cursor in between text and press enter, I will definitely need to reformat my raw string literal into a multi-line one so it's absolutely necessary to insert two extra newlines, one after the opening delimiter, and one before the closing one.

I'm confused though. It says it only adds the newline at the start of there is text before. But in both your examples, you want to add a newline at the start

Oh I see the comment being confusing. With "before the requested position" I mean the caret position, I'll update it to be more clear.

Ah. I see the confusion. Thanks

Clarified comment

CyrusNajmabadi · 2024-10-27T14:50:14Z

src/EditorFeatures/CSharp/RawStringLiteral/RawStringLiteralCommandHandler_Return.cs

+    {
+        switch (currentStringLiteralToken.Kind())
+        {
+            case SyntaxKind.SingleLineRawStringLiteralToken:


When do we have the multi line case?

Those are leftovers, will remove
This command doesn't handle multi-line raw strings and they shouldn't be expected in these methods either

Multiline cases are now supported because of the underlying generalization

i don't know what that means. it looks like earlier up we bail out in the multi-line case.

Rekkonnect · 2024-11-07T11:25:42Z

@CyrusNajmabadi ptal

CyrusNajmabadi · 2024-11-07T15:41:37Z

src/EditorFeatures/CSharp/RawStringLiteral/RawStringLiteralCommandHandler_Return.cs

+
+    private bool MakeEdit(
+        ITextView textView, ITextBuffer subjectBuffer, int position, Document document,
+        ParsedDocument parsedDocument, SyntaxToken token, SyntaxToken preferredIndentationToken,


do you need document and parsedDocument?

CyrusNajmabadi · 2024-11-07T15:42:05Z

src/EditorFeatures/CSharp/RawStringLiteral/RawStringLiteralCommandHandler_Return.cs

+        var insertedLines = 1;
+        if (isEmpty)
+        {
+            edit.Insert(position, newLine + newLine + indentation);


CyrusNajmabadi · 2024-11-07T15:42:23Z

src/EditorFeatures/CSharp/RawStringLiteral/RawStringLiteralCommandHandler_Return.cs

+        else
+        {
+            var newLineAndIndentation = newLine + indentation;
+            // Add a newline at the position of the end literal


this is just stating what hte code is doing. please state why it is doing that.

CyrusNajmabadi · 2024-11-07T15:42:29Z

src/EditorFeatures/CSharp/RawStringLiteral/RawStringLiteralCommandHandler_Return.cs

+                edit.Insert(openingEnd, newLineAndIndentation);
+            }
+        }
+        var snapshot = edit.Apply();


Suggested change

var snapshot = edit.Apply();

var snapshot = edit.Apply();

CyrusNajmabadi · 2024-11-07T15:43:25Z

src/EditorFeatures/CSharp/RawStringLiteral/RawStringLiteralCommandHandler_Return.cs

+                            return tokenStart + quotes;
+                        }
+                        index++;
+                    }


this all needs explanations.

CyrusNajmabadi · 2024-11-07T15:44:06Z

src/EditorFeatures/CSharpTest/RawStringLiteral/RawStringLiteralCommandHandlerTests.cs

+            """");
+
+        testState.SendReturn(handled: false);
+    }


needs tests with multi-line literals since hte code seems to be written to handle it.

Rekkonnect · 2024-11-07T23:39:08Z

@CyrusNajmabadi ready for review again

…-multi-line-raw-string

Handle enter in single-line raw strings

8da2ec4

Rekkonnect requested a review from a team as a code owner October 27, 2024 11:01

ghost added Area-IDE untriaged Issues and PRs which have not yet been triaged by a lead labels Oct 27, 2024

dotnet-policy-service bot added the Community The pull request was submitted by a contributor who is not a Microsoft employee. label Oct 27, 2024

CyrusNajmabadi reviewed Oct 27, 2024

View reviewed changes

Rekkonnect added 4 commits October 27, 2024 19:28

Suggestions + tests

f351500

Test and handle interpolations

095c519

Add end quotes tests

85fd5f5

Generalize cases

be2bf42

Rekkonnect requested a review from CyrusNajmabadi October 27, 2024 22:25

CyrusNajmabadi reviewed Nov 7, 2024

View reviewed changes

Rekkonnect added 2 commits November 7, 2024 18:40

Docs + suggestions

7de1cd9

Add tests for multi-line raw strings

e689fd9

Rekkonnect requested a review from CyrusNajmabadi November 7, 2024 23:39

CyrusNajmabadi added 8 commits November 15, 2024 11:37

Merge remote-tracking branch 'upstream/main' into fix/59347-single-to…

e053eea

…-multi-line-raw-string

Clean up

b0aac2d

Clean up

2bd4adb

Add docs

80dd9f6

Handle empty case

9f81d7b

In progress

c66154b

delete

b7fd7e7

simplify

72fd45f

CyrusNajmabadi added 6 commits November 15, 2024 12:31

simplify

82684be

simplify

aa7a348

Add tests

1ae1170

Raw strings

dee171d

Raw strings

535ef6a

String syntax

c7b24ec

CyrusNajmabadi enabled auto-merge November 15, 2024 20:39

CyrusNajmabadi approved these changes Nov 15, 2024

View reviewed changes

CyrusNajmabadi merged commit 0c6d00d into dotnet:main Nov 15, 2024

dotnet-policy-service bot added this to the Next milestone Nov 15, 2024

Rekkonnect deleted the fix/59347-single-to-multi-line-raw-string branch November 16, 2024 00:06

This was referenced Nov 17, 2024

[Automated] PRs inserted in VS build main-35516.11 #75945

Closed

[Automated] PRs inserted in VS build feature.debugger.main-35521.198 #76034

Closed

[Automated] PRs inserted in VS build feature.debugger.shadowDebug-35522.57 #76047

Closed

jjonescz modified the milestones: Next, 17.13 P2 Nov 25, 2024

Conversation

Rekkonnect commented Oct 27, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Rekkonnect commented Nov 7, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Rekkonnect commented Nov 7, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants