Format content pasted into string literals #2703

datho7561 · 2022-09-27T15:42:39Z

Testing this PR requires using vscode-insiders (until VS Code 1.74.0 is released).

Uses the proposed API to modify pasted strings. It invokes jdt.ls's java.edit.handlePasteEvent command when vscode-java receives a paste event. When pasting into a string literal, jdt.ls modifies the content that's inserted so that the string content reflects the original value of the copied text. It uses string concatenation instead of the newer Java multiline string feature to represent multiline text.

Requires eclipse-jdtls/eclipse.jdt.ls#2349
Closes #1249

datho7561 · 2022-10-13T13:51:06Z

In order to use this PR:

Make sure you are using VS Code Insiders
Run npx vscode-dts main before launching. This will prompt to replace the current vscode type definitions with the proposed API changes
Set "editor.experimental.pasteActions.enabled": true, in settings.json

datho7561 · 2022-10-13T14:58:35Z

Here is a demo:

rgrunber · 2022-10-19T13:33:43Z

Please make sure this doesn't affect text blocks (eg. """ ... """ )

rgrunber · 2022-11-09T18:27:46Z

src/pasteEventHandler.ts

+ * @param context the extension context
+ */
+export function registerPasteEventHandlers(context: ExtensionContext) {
+	if (languages["registerDocumentPasteEditProvider"]){


@datho7561 @fbricon Looking at https://github.com/eclipse-theia/theia/blob/7abca9d57c966d621f2acc26008cf1a9e454949b/packages/plugin-ext/src/plugin/plugin-context.ts#L674 , I don't see registerDocumentPasteEditProvider, so doesn't that imply this check would safely handle the case in such clients ?

@datho7561 , can you confirm the extension installs just fine on Theia with enableProposedApi set the way we do here. If so I would think it should be fine.

Update : Nearly forgot, to truly test this, we can't use VS Code Insiders, because that's not what Theia would use. Just the released VS Code. While it seems it does contain the proposed API, David mentioned he couldn't actually get it working there, while in VS Code Insiders it works just fine. So it would be difficult to test this thoroughly, which is why I suggested just checking if it can install without issue.

languages["registerDocumentPasteEditProvider"] is probably correct, but yeah the concern is what's the behavior of theia when enableProposedApi is on

From my testing in Theia, no warnings appear and the language server starts as normal, but none of the features I introduced are present (paste works exactly as it did before my change).

src/pasteEventHandler.ts

vscode.d.ts

datho7561 · 2022-11-29T18:38:52Z

Thanks for the review @CsCherrYY !

CsCherrYY · 2022-12-02T07:43:10Z

I just checked the behaviours in different VS Code versions:

1.65.2 (the olderest version matches engine):
The extension work well without paste handler, and there is an error about the missing proposed API:

1.73.1 (newest stable):
The extension work well without paste handler, and there is an error about the proposed API is not permitted (since redhat.java is not present at the whitelist in this release):

in the next stable release (suppose 1.74.0) our extension will work with the paste handler and there should not be any error. I'm considering if it's possible to update the engine in the extension, to restrict the new version is only available to new engine users. Is there any consideration from Theia side? @rgrunber

CsCherrYY · 2022-12-12T02:39:25Z

looks like the newest VS Code release (1.74.0) includes the allowance of the proposed API of redhat.java, @datho7561 could you please help verify if this PR works as expected?

datho7561 · 2022-12-12T17:01:10Z

As is, paste events don't seem to work with this PR in VS Code 1.74.0. I don't get any error pop ups or logs to the extension host complaining, but the pasted content doesn't get modified. I've rebased my PRs to make it easier to test out. I'll try a few things like changing the engine version to see if that makes a difference.

datho7561 · 2022-12-12T17:16:29Z

I tried updating the engine version, but that didn't help. I also confirmed that the product.json contains the change to allow vscode-java to use the proposed api.

datho7561 · 2022-12-12T21:27:25Z

It looks like the Markdown paste feature (where when you paste an image, it creates the image file in the workspace folder and adds a markdown image tag that references the file) also only works on Insiders.

CsCherrYY · 2022-12-13T01:54:32Z

Did you set editor.experimental.pasteActions.enabled to true?

datho7561 · 2022-12-13T12:58:23Z

Did you set editor.experimental.pasteActions.enabled to true?

Nope, I forgot. Thanks for your help, it's working!

CsCherrYY

LGTM!

rgrunber · 2022-12-22T00:36:19Z

src/pasteEventHandler.ts

+			}
+		};
+
+		const pasteResponse: PDocumentPasteEdit = await commands.executeCommand(Commands.EXECUTE_WORKSPACE_COMMAND, Commands.HANDLE_PASTE_EVENT, pasteEventParams);


Calling JSON.stringify(pasteEventParams) will save some code on the language server side deserialization. If you look around the codebase, you'll see we use this in many places. I can make the change.

- Invoke jdt.ls's `java.edit.handlePasteEvent` command when vscode-java receives a paste event Requires eclipse-jdtls/eclipse.jdt.ls#2349 Closes redhat-developer#1249 Signed-off-by: David Thompson <davthomp@redhat.com>

openshift-ci bot added the do-not-merge/work-in-progress label Sep 27, 2022

akaroml mentioned this pull request Oct 20, 2022

Add events for copy/paste to allow language extensions to bring using/import statements along microsoft/vscode#30066

Closed

rgrunber reviewed Nov 9, 2022

View reviewed changes

CsCherrYY mentioned this pull request Nov 11, 2022

Add missing import on paste #2795

Closed

datho7561 force-pushed the 1249-paste-into-string branch 4 times, most recently from 436e114 to df3fa47 Compare November 28, 2022 19:20

datho7561 changed the title ~~POC of formatting content pasted into strings~~ Format content pasted into string literals Nov 28, 2022

datho7561 marked this pull request as ready for review November 28, 2022 20:50

openshift-ci bot removed the do-not-merge/work-in-progress label Nov 28, 2022

CsCherrYY reviewed Nov 29, 2022

View reviewed changes

src/pasteEventHandler.ts Show resolved Hide resolved

src/pasteEventHandler.ts Show resolved Hide resolved

vscode.d.ts Outdated Show resolved Hide resolved

datho7561 force-pushed the 1249-paste-into-string branch from df3fa47 to 70b6930 Compare November 29, 2022 18:05

github-actions bot added the has conflicts label Nov 30, 2022

datho7561 force-pushed the 1249-paste-into-string branch 2 times, most recently from e418663 to 79c724f Compare December 1, 2022 13:19

datho7561 removed the has conflicts label Dec 1, 2022

github-actions bot added the has conflicts label Dec 5, 2022

datho7561 mentioned this pull request Dec 6, 2022

Wrap selection in XML element redhat-developer/vscode-xml#813

Merged

datho7561 force-pushed the 1249-paste-into-string branch from 79c724f to 7a9cc40 Compare December 12, 2022 16:58

datho7561 force-pushed the 1249-paste-into-string branch from 7a9cc40 to 58d9fbb Compare December 12, 2022 19:26

github-actions bot removed the has conflicts label Dec 12, 2022

CsCherrYY approved these changes Dec 20, 2022

View reviewed changes

rgrunber reviewed Dec 22, 2022

View reviewed changes

Delegate paste event handling to jdt.ls

5575d68

- Invoke jdt.ls's `java.edit.handlePasteEvent` command when vscode-java receives a paste event Requires eclipse-jdtls/eclipse.jdt.ls#2349 Closes redhat-developer#1249 Signed-off-by: David Thompson <davthomp@redhat.com>

rgrunber force-pushed the 1249-paste-into-string branch from 58d9fbb to 5575d68 Compare December 22, 2022 01:08

rgrunber merged commit f93cc8b into redhat-developer:master Dec 22, 2022

datho7561 deleted the 1249-paste-into-string branch January 3, 2023 13:32

CsCherrYY mentioned this pull request Feb 17, 2023

update vscode engine to 1.74.0 #2951

Merged

CsCherrYY mentioned this pull request Mar 20, 2023

Provide better copy paste experience for multi-line String microsoft/vscode-java-pack#917

Closed

Format content pasted into string literals #2703

Format content pasted into string literals #2703

Uh oh!

Conversation

datho7561 commented Sep 27, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

datho7561 commented Oct 13, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

datho7561 commented Oct 13, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rgrunber commented Oct 19, 2022

Uh oh!

rgrunber Nov 9, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fbricon Nov 9, 2022

Choose a reason for hiding this comment

Uh oh!

datho7561 Nov 14, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

datho7561 commented Nov 29, 2022

Uh oh!

CsCherrYY commented Dec 2, 2022

Uh oh!

CsCherrYY commented Dec 12, 2022

Uh oh!

datho7561 commented Dec 12, 2022

Uh oh!

datho7561 commented Dec 12, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

datho7561 commented Dec 12, 2022

Uh oh!

CsCherrYY commented Dec 13, 2022

Uh oh!

datho7561 commented Dec 13, 2022

Uh oh!

CsCherrYY left a comment

Choose a reason for hiding this comment

Uh oh!

rgrunber Dec 22, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

datho7561 commented Sep 27, 2022 •

edited

Loading

datho7561 commented Oct 13, 2022 •

edited

Loading

datho7561 commented Oct 13, 2022 •

edited

Loading

rgrunber Nov 9, 2022 •

edited

Loading

datho7561 commented Dec 12, 2022 •

edited

Loading