From 3b62ef47d46b03780c6c22546de7f419e5f35b77 Mon Sep 17 00:00:00 2001 From: Morgan Chang Date: Mon, 16 Nov 2026 17:15:50 -0500 Subject: [PATCH] Apply module requirements during Organize Imports cleanup on save Signed-off-by: Morgan Chang --- src/extension.ts | 41 +++++++++++++++++++++++++++++++++++++++-- 1 file changed, 39 insertions(+), 2 deletions(-) diff --git a/src/extension.ts b/src/extension.ts index 0fcdb138a..67d9e0207 100644 --- a/src/extension.ts +++ b/src/extension.ts @@ -12,7 +12,7 @@ import { InputBoxOptions, Location, MarkdownString, RelativePattern, SnippetString, SnippetTextEdit, TextDocument, TextEditorRevealType, UIKind, Uri, version, ViewColumn, window, workspace, WorkspaceConfiguration } from 'vscode'; -import { CancellationToken, CodeActionParams, CodeActionRequest, CodeActionResolveRequest, Command, CompletionRequest, DidChangeConfigurationNotification, ExecuteCommandParams, ExecuteCommandRequest, LanguageClientOptions, RevealOutputChannelOn } from 'vscode-languageclient'; +import { CancellationToken, CodeActionParams, CodeActionRequest, CodeActionResolveRequest, Command, CompletionRequest, DidChangeConfigurationNotification, ExecuteCommandParams, ExecuteCommandRequest, LanguageClientOptions, RevealOutputChannelOn, TextEdit as ProtocolTextEdit } from 'vscode-languageclient'; import { Executable, LanguageClient } from 'vscode-languageclient/node'; import { apiManager } from './apiManager'; import { BuildFileSelector, cleanupWorkspaceState, PICKED_BUILD_FILES } from './buildFilesSelector'; @@ -32,6 +32,7 @@ import { OutputInfoCollector } from './outputInfoCollector'; import { pasteFile } from './pasteAction'; import { collectJavaExtensions, getBundlesToReload, getShortcuts, IJavaShortcut, isContributedPartUpdated } from './plugin'; import { Deferred } from './promiseUtil'; +import { CleanupRequest } from './protocol'; import { fixJdtSchemeHoverLinks, registerClientProviders } from './providerDispatcher'; import * as requirements from './requirements'; import { languageStatusBarProvider } from './runtimeStatusBarProvider'; @@ -40,7 +41,7 @@ import { serverStatusBarProvider, ShortcutQuickPickItem } from './serverStatusBa import { activationProgressNotification } from "./serverTaskPresenter"; import { ACTIVE_BUILD_TOOL_STATE, cleanWorkspaceFileName, getImportMode, getJavaServerMode, handleTextDocumentChanges, ImportMode, onConfigurationChange, ServerMode } from './settings'; import { snippetCompletionProvider } from './snippetCompletionProvider'; -import { StandardLanguageClient } from './standardLanguageClient'; +import { applyWorkspaceEdit, StandardLanguageClient } from './standardLanguageClient'; import { SyntaxLanguageClient } from './syntaxLanguageClient'; import { Telemetry } from './telemetry'; import { cleanJavaLSConfiguration, convertToGlob, deleteClientLog, deleteDirectory, ensureExists, getBuildFilePatterns, getExclusionGlob, getInclusionPatternsFromNegatedExclusion, getJavaConfig, getJavaConfiguration, getVersion, hasBuildToolConflicts, resolveActualCause } from './utils'; @@ -276,6 +277,42 @@ export async function activate(context: ExtensionContext): Promise triggerFiles, }, middleware: { + willSaveWaitUntil: async (event, next) => { + const javaConfig = workspace.getConfiguration('java', event.document.uri); + const cleanupActions = javaConfig.get('cleanup.actions') ?? []; + const deprecatedActions = javaConfig.get('cleanup.actionsOnSave') ?? []; + const effectiveActions = cleanupActions.length > 0 ? cleanupActions : deprecatedActions; + if (event.document.uri.scheme !== 'file' || !javaConfig.get('saveActions.cleanup', true) || !effectiveActions.includes('organizeImports')) { + return next(event); + } + try { + const client = standardClient.getClient(); + const workspaceEdit = await client.sendRequest(CleanupRequest.type, client.code2ProtocolConverter.asTextDocumentIdentifier(event.document)); + if (!workspaceEdit) { + return next(event); + } + const sourceUri = event.document.uri.toString(); + const sourceEdits: ProtocolTextEdit[] = []; + const otherChanges: Record = {}; + for (const [uri, edits] of Object.entries(workspaceEdit.changes ?? {})) { + if (Uri.parse(uri).toString() === sourceUri) { + sourceEdits.push(...edits); + } else { + otherChanges[uri] = edits; + } + } + if (Object.keys(otherChanges).length > 0) { + const applied = await applyWorkspaceEdit({ changes: otherChanges }, client); + if (!applied) { + logger.warn(`Failed to apply cleanup edits outside ${sourceUri}`); + } + } + return (await client.protocol2CodeConverter.asTextEdits(sourceEdits)) ?? []; + } catch (error) { + logger.error(`Failed to apply multi-file cleanup on save: ${getMessage(error)}`); + return next(event); + } + }, workspace: { didChangeConfiguration: async () => { await standardClient.getClient().sendNotification(DidChangeConfigurationNotification.type, {