Re-validate current document if the focus is switched to a Java file (#3053)

* Re-validate current document if the focus is switched to a Java file

Signed-off-by: Jinbo Wang <[email protected]>

Author: testforstephen

README.md

@@ -228,6 +228,9 @@ The following settings are supported:
 * `java.configuration.maven.defaultMojoExecutionAction` : Specifies default mojo execution action when no associated metadata can be detected. Defaults to `ignore`.
 * `java.completion.lazyResolveTextEdit.enabled`: [Experimental] Enable/disable lazily resolving text edits for code completion. Defaults to `true`.
 
+New in 1.19.0
+* `java.edit.validateAllOpenBuffersOnChanges`: Specifies whether to recheck all open Java files for diagnostics when editing a Java file. Defaults to `false`.
+
 Semantic Highlighting
 ===============
 [Semantic Highlighting](https://github.com/redhat-developer/vscode-java/wiki/Semantic-Highlighting) fixes numerous syntax highlighting issues with the default Java Textmate grammar. However, you might experience a few minor issues, particularly a delay when it kicks in, as it needs to be computed by the Java Language server, when opening a new file or when typing. Semantic highlighting can be disabled for all languages using the `editor.semanticHighlighting.enabled` setting, or for Java only using [language-specific editor settings](https://code.visualstudio.com/docs/getstarted/settings#_languagespecific-editor-settings).

package.json

@@ -1108,6 +1108,12 @@
             "usesOnlineServices",
             "telemetry"
           ]
+        },
+        "java.edit.validateAllOpenBuffersOnChanges": {
+          "type": "boolean",
+          "default": false,
+          "markdownDescription": "Specifies whether to recheck all open Java files for diagnostics when editing a Java file.",
+          "scope": "window"
         }
       }
     },

src/diagnostic.ts

@@ -0,0 +1,19 @@
+import { ExtensionContext, window } from "vscode";
+import { ValidateDocumentNotification } from "./protocol";
+import { LanguageClient } from "vscode-languageclient/node";
+import { validateAllOpenBuffersOnChanges } from "./settings";
+
+export function registerDocumentValidationListener(context: ExtensionContext, languageClient: LanguageClient) {
+	context.subscriptions.push(window.onDidChangeActiveTextEditor(textEditor => {
+		// Refresh the diagnostics when the focus is switched to a Java file.
+		if (textEditor?.document.uri?.scheme === "file" && textEditor?.document.languageId === "java") {
+			if (!validateAllOpenBuffersOnChanges()) {
+				languageClient.sendNotification(ValidateDocumentNotification.type, {
+					textDocument: {
+						uri: textEditor.document.uri.toString(),
+					},
+				});
+			}
+		}
+	}));
+}

src/protocol.ts

@@ -464,3 +464,11 @@ export interface CheckExtractInterfaceStatusResponse {
 export namespace CheckExtractInterfaceStatusRequest {
     export const type = new RequestType<CodeActionParams, CheckExtractInterfaceStatusResponse, void>('java/checkExtractInterfaceStatus');
 }
+
+export interface ValidateDocumentParams {
+    textDocument: TextDocumentIdentifier;
+}
+
+export namespace ValidateDocumentNotification {
+	export const type = new NotificationType<ValidateDocumentParams>('java/validateDocument');
+}

src/settings.ts

@@ -274,6 +274,10 @@ export function getJavaServerMode(): ServerMode {
 		|| ServerMode.hybrid;
 }
 
+export function validateAllOpenBuffersOnChanges(): boolean {
+	return workspace.getConfiguration().get('java.edit.validateAllOpenBuffersOnChanges');
+}
+
 export function setGradleWrapperChecksum(wrapper: string, sha256?: string) {
 	const opened = gradleWrapperPromptDialogs.filter(v => (v === sha256));
 	if (opened !== null && opened.length > 0) {

src/standardLanguageClient.ts

@@ -39,6 +39,7 @@ import { typeHierarchyTree } from "./typeHierarchy/typeHierarchyTree";
 import { getAllJavaProjects, getJavaConfig, getJavaConfiguration } from "./utils";
 import { Telemetry } from "./telemetry";
 import { TelemetryEvent } from "@redhat-developer/vscode-redhat-telemetry/lib";
+import { registerDocumentValidationListener } from './diagnostic';
 
 const extensionName = 'Language Support for Java';
 const GRADLE_CHECKSUM = "gradle/checksum/prompt";
@@ -146,6 +147,7 @@ export class StandardLanguageClient {
 					});
 					// Disable the client-side snippet provider since LS is ready.
 					snippetCompletionProvider.dispose();
+					registerDocumentValidationListener(context, this.languageClient);
 					break;
 				case 'Started':
 					this.status = ClientStatus.started;