Pasting code into empty file will trigger organize imports

Issue #1075

New preference: java.paste.organizeImportsOnPaste

Signed-off-by: Nikolas Komonen <nikolaskomonen@gmail.com>

Author: NikolasKomonen

README.md

@@ -116,6 +116,7 @@ The following settings are supported:
 * `java.codeGeneration.toString.listArrayContents`: List contents of arrays instead of using native toString(). Defaults to `true`.
 * `java.codeGeneration.toString.limitElements`: Limit number of items in arrays/collections/maps to list, if 0 then list all. Defaults to `0`.
 * `java.selectionRange.enabled`: Enable/disable Smart Selection support for Java. Disabling this option will not affect the VS Code built-in word-based and bracket-based smart selection.
+* `java.actionsOnPaste.organizeImports`: Triggers "Organize imports" when java code is pasted into an empty file.
 
 Troubleshooting
 ===============

package.json

@@ -388,6 +388,12 @@
           "default": true,
           "description": "Enable/disable Smart Selection support for Java. Disabling this option will not affect the VS Code built-in word-based and bracket-based smart selection.",
           "scope": "window"
+        },
+        "java.actionsOnPaste.organizeImports": {
+          "type": "boolean",
+          "description": "Triggers 'Organize imports' when java code is pasted into an empty file.",
+          "default": true,
+          "scope": "window"
         }
       }
     },

src/extension.ts

@@ -20,7 +20,7 @@ import * as sourceAction from './sourceAction';
 import * as refactorAction from './refactorAction';
 import * as net from 'net';
 import { getJavaConfiguration } from './utils';
-import { onConfigurationChange, excludeProjectSettingsFiles } from './settings';
+import { onConfigurationChange, excludeProjectSettingsFiles, initializeSettings } from './settings';
 import { logger, initializeLogFile } from './log';
 import glob = require('glob');
 
@@ -388,6 +388,7 @@ export function activate(context: ExtensionContext): Promise<ExtensionAPI> {
 					buildpath.registerCommands(context);
 					sourceAction.registerCommands(languageClient, context);
 					refactorAction.registerCommands(languageClient, context);
+					initializeSettings(languageClient, context); // may need to move in the future
 
 					context.subscriptions.push(window.onDidChangeActiveTextEditor((editor) => {
 						toggleItem(editor, item);
@@ -435,7 +436,7 @@ export function activate(context: ExtensionContext): Promise<ExtensionAPI> {
 
 				context.subscriptions.push(commands.registerCommand(Commands.CLEAN_WORKSPACE, () => cleanWorkspace(workspacePath)));
 
-				context.subscriptions.push(onConfigurationChange());
+				context.subscriptions.push(onConfigurationChange(languageClient, context));
 				toggleItem(window.activeTextEditor, item);
 			});
 		});

src/settings.ts

@@ -1,6 +1,6 @@
 'use strict';
 
-import { window, Uri, workspace, WorkspaceConfiguration, commands, ConfigurationTarget, env } from 'vscode';
+import { window, Uri, workspace, WorkspaceConfiguration, commands, ConfigurationTarget, env, ExtensionContext, TextEditor, Range, Disposable } from 'vscode';
 import { LanguageClient } from 'vscode-languageclient';
 import { Commands } from './commands';
 import { getJavaConfiguration } from './utils';
@@ -14,10 +14,13 @@ const changeItem = {
 };
 
 const EXCLUDE_FILE_CONFIG = 'configuration.checkProjectSettingsExclusions';
+export const ORGANIZE_IMPORTS_ON_PASTE = 'actionsOnPaste.organizeImports'; // java.actionsOnPaste.organizeImports
+// index of the paste disposable in the subscriptions array
+let pasteSubscriptionIndex;
 
 let oldConfig: WorkspaceConfiguration = getJavaConfiguration();
 
-export function onConfigurationChange() {
+export function onConfigurationChange(languageClient: LanguageClient, context: ExtensionContext) {
 	return workspace.onDidChangeConfiguration(params => {
 		if (!params.affectsConfiguration('java')) {
 			return;
@@ -30,16 +33,27 @@ export function onConfigurationChange() {
 			const msg = `Java Language Server configuration changed, please restart ${env.appName}.`;
 			const action = 'Restart Now';
 			const restartId = Commands.RELOAD_WINDOW;
-			oldConfig = newConfig;
 			window.showWarningMessage(msg, action).then((selection) => {
 				if (action === selection) {
 					commands.executeCommand(restartId);
 				}
 			});
 		}
+		handleJavaPasteConfigurationChange(languageClient, context, newConfig);
+		// update old config
+		oldConfig = newConfig;
 	});
 }
 
+/**
+ * Starting point for any settings that need to be handled when the server starts
+ * @param languageClient
+ * @param context
+ */
+export function initializeSettings(languageClient: LanguageClient, context: ExtensionContext) {
+	handleInitialConfigurations(languageClient, context, getJavaConfiguration());
+}
+
 export function excludeProjectSettingsFiles() {
 	if (workspace.workspaceFolders && workspace.workspaceFolders.length) {
 		workspace.workspaceFolders.forEach((folder) => {
@@ -114,3 +128,71 @@ export function getJavaEncoding(): string {
 	}
 	return javaEncoding;
 }
+
+export function handleInitialConfigurations(languageClient: LanguageClient, context: ExtensionContext, newConfig: WorkspaceConfiguration) {
+	// organize imports on paste registration
+	if (newConfig.get(ORGANIZE_IMPORTS_ON_PASTE)) {
+		registerOverridePasteCommand(languageClient, context);
+	}
+}
+
+export function handleJavaPasteConfigurationChange(languageClient: LanguageClient, context: ExtensionContext, newConfig: WorkspaceConfiguration) {
+	const oldOrganizeImportsOnPaste = oldConfig.get(ORGANIZE_IMPORTS_ON_PASTE);
+	const newOrganizeImportsOnPaste = newConfig.get(ORGANIZE_IMPORTS_ON_PASTE);
+	if (oldOrganizeImportsOnPaste !== newOrganizeImportsOnPaste) {
+		if (newOrganizeImportsOnPaste === true) {
+			registerOverridePasteCommand(languageClient, context);
+		}
+		else {
+			unregisterOverridePasteCommand(languageClient, context);
+		}
+	}
+}
+
+export function registerOverridePasteCommand(languageClient: LanguageClient, context: ExtensionContext): void {
+    // referencing https://github.com/gazugafan/vscode-indent-on-paste/blob/master/src/extension.ts
+    const length = context.subscriptions.push(commands.registerCommand('editor.action.clipboardPasteAction', async () => {
+
+        const clipboardText: string = await env.clipboard.readText();
+        const editor: TextEditor = window.activeTextEditor;
+
+        const documentText: string = editor.document.getText();
+
+        const isCursorOnly = editor.selection.isEmpty;
+        let action: Thenable<boolean>;
+        if (isCursorOnly) {
+            action = editor.edit(textInserter => {
+                textInserter.insert(editor.selection.start, clipboardText);
+            });
+        }
+        else {
+            const start = editor.selection.start;
+            const end = editor.selection.end;
+            action = editor.edit(textInserter => {
+                textInserter.replace(new Range(start, end), clipboardText);
+            });
+        }
+
+        action.then((wasApplied) => {
+            const hasText: boolean = documentText !== null && /\S/.test(documentText);
+            const fileURI = editor.document.uri.toString();
+            if (wasApplied && !hasText && fileURI.endsWith(".java")) { // only organizing imports if document is blank
+                // Organize imports only requires uri from CodeActionParams
+                const codeActionParams = { textDocument: { uri: fileURI } };
+                commands.executeCommand(Commands.ORGANIZE_IMPORTS, codeActionParams);
+            }
+        });
+	}));
+
+	pasteSubscriptionIndex = length - 1;
+	languageClient.info(`Registered 'java.${ORGANIZE_IMPORTS_ON_PASTE}' command.`);
+}
+
+export function unregisterOverridePasteCommand(languageClient: LanguageClient, context: ExtensionContext) {
+	if (pasteSubscriptionIndex !== null) {
+		const pasteDisposable: Disposable = context.subscriptions[pasteSubscriptionIndex];
+		pasteDisposable.dispose();
+		pasteSubscriptionIndex = null;
+		languageClient.info(`Unregistered 'java.${ORGANIZE_IMPORTS_ON_PASTE}' command.`);
+	}
+}

src/sourceAction.ts

@@ -1,6 +1,6 @@
 'use strict';
 
-import { commands, window, ExtensionContext, Range, ViewColumn, Uri, Disposable } from 'vscode';
+import { commands, window, ExtensionContext, ViewColumn, Uri, Disposable } from 'vscode';
 import { CodeActionParams, LanguageClient } from 'vscode-languageclient';
 import { Commands } from './commands';
 import { applyWorkspaceEdit } from './extension';