Skip to content

Commit 68044a5

Browse files
shin19991207datho7561
authored andcommitted
Handle confirmation support for Inline refactorings
Signed-off-by: Morgan Chang <shin19991207@gmail.com>
1 parent aea353a commit 68044a5

5 files changed

Lines changed: 52 additions & 28 deletions

File tree

‎src/extension.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -256,6 +256,7 @@ export async function activate(context: ExtensionContext): Promise<ExtensionAPI>
256256
inferSelectionSupport: ["extractMethod", "extractVariable", "extractField"],
257257
moveRefactoringSupport: true,
258258
moveRefactoringConfirmationSupport: true,
259+
inlineRefactoringConfirmationSupport: true,
259260
clientHoverProvider: true,
260261
clientDocumentSymbolProvider: true,
261262
gradleChecksumWrapperPromptSupport: true,

‎src/protocol.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -361,6 +361,7 @@ export interface GetRefactorEditParams {
361361
context: CodeActionParams;
362362
options: FormattingOptions;
363363
commandArguments: any[];
364+
confirmationToken?: string;
364365
}
365366

366367
export namespace GetRefactorEditRequest {

‎src/refactorAction.ts‎

Lines changed: 12 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ import { commands, ExtensionContext, Position, QuickPickItem, TextDocument, Uri,
66
import { FormattingOptions, WorkspaceEdit, RenameFile, DeleteFile, TextDocumentEdit, CodeActionParams, SymbolInformation } from 'vscode-languageclient';
77
import { LanguageClient } from 'vscode-languageclient/node';
88
import { Commands as javaCommands } from './commands';
9-
import { GetRefactorEditRequest, MoveRequest, RefactorWorkspaceEdit, RenamePosition, GetMoveDestinationsRequest, SearchSymbols, SelectionInfo, InferSelectionRequest, GetChangeSignatureInfoRequest, ChangeSignatureInfo, MoveParams } from './protocol';
9+
import { GetRefactorEditRequest, MoveRequest, RefactorWorkspaceEdit, RenamePosition, GetMoveDestinationsRequest, SearchSymbols, SelectionInfo, InferSelectionRequest, GetChangeSignatureInfoRequest, ChangeSignatureInfo, MoveParams, GetRefactorEditParams } from './protocol';
10+
import { requestWithConfirmation } from './refactoring/confirmation';
1011
import { ChangeSignaturePanel } from './refactoring/changeSignaturePanel';
1112
import { getExtractInterfaceArguments, revealExtractedInterface } from './refactoring/extractInterface';
1213

@@ -46,6 +47,9 @@ function registerApplyRefactorCommand(languageClient: LanguageClient, context: E
4647
|| command === 'convertVariableToField'
4748
|| command === 'invertVariable'
4849
|| command === 'introduceParameter'
50+
|| command === 'inlineMethod'
51+
|| command === 'inlineConstant'
52+
|| command === 'inlineLocalVariable'
4953
|| command === 'convertAnonymousClassToNestedCommand') {
5054
const currentEditor = window.activeTextEditor;
5155
if (!currentEditor || !currentEditor.options) {
@@ -121,16 +125,18 @@ function registerApplyRefactorCommand(languageClient: LanguageClient, context: E
121125
return;
122126
}
123127

124-
const result: RefactorWorkspaceEdit = await languageClient.sendRequest(GetRefactorEditRequest.type, {
128+
const refactorParams: GetRefactorEditParams = {
125129
command,
126130
context: params,
127131
options: formattingOptions,
128132
commandArguments,
129-
});
133+
};
134+
const result = await requestWithConfirmation(refactorParams,
135+
requestParams => languageClient.sendRequest(GetRefactorEditRequest.type, requestParams));
130136

131137
await applyRefactorEdit(languageClient, result);
132138

133-
if (command === 'extractInterface') {
139+
if (command === 'extractInterface' && result) {
134140
await revealExtractedInterface(result);
135141
}
136142
} else if (command === 'moveFile') {
@@ -253,27 +259,8 @@ async function applyRefactorEdit(languageClient: LanguageClient, refactorEdit: R
253259
}
254260

255261
async function requestMoveWithConfirmation(languageClient: LanguageClient, moveParams: MoveParams): Promise<RefactorWorkspaceEdit | undefined> {
256-
let refactorEdit: RefactorWorkspaceEdit = await languageClient.sendRequest(MoveRequest.type, moveParams);
257-
if (!refactorEdit?.confirmationToken) {
258-
await applyRefactorEdit(languageClient, refactorEdit);
259-
return refactorEdit;
260-
}
261-
262-
const continueAction = 'Continue';
263-
const detail = 'Review the details below before continuing:\n\n' + refactorEdit.errorMessage;
264-
const selection = await window.showWarningMessage(
265-
'This refactoring may change program behavior. Continue anyway?',
266-
{ modal: true, detail },
267-
continueAction,
268-
);
269-
if (selection !== continueAction) {
270-
return undefined;
271-
}
272-
273-
refactorEdit = await languageClient.sendRequest(MoveRequest.type, {
274-
...moveParams,
275-
confirmationToken: refactorEdit.confirmationToken,
276-
});
262+
const refactorEdit = await requestWithConfirmation(moveParams,
263+
requestParams => languageClient.sendRequest(MoveRequest.type, requestParams));
277264
await applyRefactorEdit(languageClient, refactorEdit);
278265
return refactorEdit;
279266
}

‎src/refactoring/changeSignaturePanel.ts‎

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
import * as path from "path";
22
import { Disposable, Webview, WebviewPanel, window, Uri, ViewColumn, workspace, WorkspaceEdit } from "vscode";
33
import { LanguageClient } from "vscode-languageclient/node";
4-
import { GetRefactorEditRequest, RefactorWorkspaceEdit } from "../protocol";
4+
import { GetRefactorEditParams, GetRefactorEditRequest } from "../protocol";
5+
import { requestWithConfirmation } from "./confirmation";
56
import { getNonce, getUri } from "../webviewUtils";
67

78
interface MethodParameter {
@@ -173,12 +174,18 @@ export class ChangeSignaturePanel {
173174
* @returns true if the refactoring is successful, false otherwise.
174175
*/
175176
private async doRefactor(methodIdentifier: string, isDelegate: boolean, methodName: string, accessType: string, returnType: string, parameters: MethodParameter[], exceptions: MethodException[], preview: boolean): Promise<boolean> {
176-
const clientWorkspaceEdit: RefactorWorkspaceEdit = await this.languageClient.sendRequest(GetRefactorEditRequest.type, {
177+
const refactorParams: GetRefactorEditParams = {
177178
command: this.command,
178179
context: this.params,
179180
options: this.formattingOptions,
180181
commandArguments: [methodIdentifier, isDelegate, methodName, accessType, returnType, parameters, exceptions, preview]
181-
});
182+
};
183+
const clientWorkspaceEdit = await requestWithConfirmation(refactorParams,
184+
params => this.languageClient.sendRequest(GetRefactorEditRequest.type, params));
185+
if (clientWorkspaceEdit?.errorMessage) {
186+
window.showErrorMessage(clientWorkspaceEdit.errorMessage);
187+
return false;
188+
}
182189
if (clientWorkspaceEdit?.edit) {
183190
const codeEdit: WorkspaceEdit = await this.languageClient.protocol2CodeConverter.asWorkspaceEdit(clientWorkspaceEdit.edit);
184191
if (codeEdit) {

‎src/refactoring/confirmation.ts‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
import { window } from 'vscode';
2+
import { RefactorWorkspaceEdit } from '../protocol';
3+
4+
export async function requestWithConfirmation<T extends { confirmationToken?: string }>(
5+
params: T,
6+
request: (params: T) => Promise<RefactorWorkspaceEdit>,
7+
): Promise<RefactorWorkspaceEdit | undefined> {
8+
const refactorEdit = await request(params);
9+
if (!refactorEdit?.confirmationToken) {
10+
return refactorEdit;
11+
}
12+
13+
const continueAction = 'Continue';
14+
const detail = `Review the details below before continuing:\n\n${refactorEdit.errorMessage}`;
15+
const selection = await window.showWarningMessage(
16+
'This refactoring may change program behavior. Continue anyway?',
17+
{ modal: true, detail },
18+
continueAction,
19+
);
20+
if (selection !== continueAction) {
21+
return undefined;
22+
}
23+
24+
return request({
25+
...params,
26+
confirmationToken: refactorEdit.confirmationToken,
27+
});
28+
}

0 commit comments

Comments
 (0)