Skip to content

Change Extract to Function to name earlier. #11568

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sean-mcmanus merged 4 commits into from
Oct 31, 2023
Merged

Change Extract to Function to name earlier. #11568

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
979fd7f
Change Extract to Function to name earlier.
sean-mcmanus Oct 23, 2023
f9cc3c8
Merge branch 'main' into seanmcm/nameFunctionBefore
sean-mcmanus Oct 27, 2023
e6ab615
Put back selection update.
sean-mcmanus Oct 27, 2023
3459bef
Fix bug, and change wording.
sean-mcmanus Oct 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 0 additions & 10 deletions Extension/src/LanguageServer/Providers/renameProvider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,16 +24,6 @@ export class RenameProvider implements vscode.RenameProvider {
}

public async provideRenameEdits(document: vscode.TextDocument, position: vscode.Position, newName: string, _token: vscode.CancellationToken): Promise<vscode.WorkspaceEdit | undefined> {
// Bypass the normal rename processing during Extract to function,
// since we already know the locations of the required edits.
if (this.client.renameDataForExtractToFunction.length > 0) {
const workspaceEditResult: vscode.WorkspaceEdit = new vscode.WorkspaceEdit();
for (const renameData of this.client.renameDataForExtractToFunction) {
workspaceEditResult.replace(renameData.uri, renameData.range, newName);
}
this.client.renameDataForExtractToFunction = [];
return workspaceEditResult;
}
await this.client.ready;
workspaceReferences.cancelCurrentReferenceRequest(CancellationSender.NewRequest);

Expand Down
75 changes: 37 additions & 38 deletions Extension/src/LanguageServer/client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -342,6 +342,7 @@ export interface CreateDeclarationOrDefinitionResult extends WorkspaceEditResult

export interface ExtractToFunctionParams extends SelectionParams {
extractAsGlobal: boolean;
name: string;
}

interface ShowMessageWindowParams {
Expand Down Expand Up @@ -3452,10 +3453,14 @@ export class DefaultClient implements Client {
return;
}

// TODO: Show a quick pick to get the name before generating the code.
// That would allow the formatting to be done without waiting for the rename.
// Also, it's less error prone and eliminates a class of bugs in which the
// rename position can be incorrect.
let functionName: string | undefined = await vscode.window.showInputBox({
title: localize('handle.extract.name', 'Name the extracted function'),
placeHolder: localize('handle.extract.new.function', 'NewFunction')
});

if (functionName === undefined || functionName === "") {
functionName = "NewFunction";
}

const params: ExtractToFunctionParams = {
uri: editor.document.uri.toString(),
Expand All @@ -3469,7 +3474,8 @@ export class DefaultClient implements Client {
line: editor.selection.end.line
}
},
extractAsGlobal
extractAsGlobal,
name: functionName
};

const result: WorkspaceEditResult = await this.languageClient.sendRequest(ExtractToFunctionRequest, params);
Expand All @@ -3482,15 +3488,15 @@ export class DefaultClient implements Client {

// Handle error messaging
if (result.errorText) {
void vscode.window.showErrorMessage(result.errorText);
void vscode.window.showErrorMessage(`${localize("handle.extract.error",
"Extract to function failed: {0}", result.errorText)}`);
return;
}

let workspaceEdits: vscode.WorkspaceEdit = new vscode.WorkspaceEdit();
let replaceEditRange: vscode.Range | undefined;
let hasProcessedReplace: boolean = false;
const formatUriAndRanges: VsCodeUriAndRange[] = [];
this.renameDataForExtractToFunction = [];
let lineOffset: number = 0;
let headerFileLineOffset: number = 0;
let isSourceFile: boolean = true;
Expand All @@ -3515,7 +3521,7 @@ export class DefaultClient implements Client {
range = new vscode.Range(new vscode.Position(range.start.line + headerFileLineOffset, range.start.character),
new vscode.Position(range.end.line + headerFileLineOffset, range.end.character));
}
const isReplace: boolean = !range.isEmpty;
const isReplace: boolean = !range.isEmpty && isSourceFile;
lineOffset += nextLineOffset;
nextLineOffset = (edit.newText.match(/\n/g) ?? []).length;
let rangeStartLine: number = range.start.line + lineOffset;
Expand Down Expand Up @@ -3559,36 +3565,32 @@ export class DefaultClient implements Client {
new vscode.Position(rangeStartLine + (nextLineOffset < 0 ? 0 : nextLineOffset),
isReplace ? range.end.character :
range.end.character + edit.newText.length - rangeStartCharacter))});
const newFunctionString: string = "NewFunction";

// Handle additional declaration lines added before the new function call.
let currentText: string = edit.newText.substring(rangeStartCharacter);
let currentTextNextLineStart: number = currentText.indexOf("\n");
let currentTextNewFunctionStart: number = currentText.indexOf(newFunctionString);
let currentTextNextLineStartUpdated: boolean = false;
while (currentTextNextLineStart !== -1 && currentTextNextLineStart < currentTextNewFunctionStart) {
++rangeStartLine;
currentText = currentText.substring(currentTextNextLineStart + 1);
currentTextNextLineStart = currentText.indexOf("\n");
currentTextNewFunctionStart = currentText.indexOf(newFunctionString);
currentTextNextLineStartUpdated = true;
}
rangeStartCharacter = (rangeStartCharacter === 0 && !currentTextNextLineStartUpdated ? range.start.character : 0) +
currentTextNewFunctionStart;
if (rangeStartCharacter < 0) {
// newFunctionString is missing -- unexpected error.
void vscode.window.showErrorMessage(`${localize("invalid.edit",
"Extract to function failed. An invalid edit was generated: '{0}'", edit.newText)}`);
continue;
}
const currentEditRange: vscode.Range = new vscode.Range(
new vscode.Position(rangeStartLine, rangeStartCharacter),
new vscode.Position(rangeStartLine, rangeStartCharacter + newFunctionString.length));
if (isReplace) {
replaceEditRange = currentEditRange;
// Handle additional declaration lines added before the new function call.
let currentText: string = edit.newText.substring(rangeStartCharacter);
let currentTextNextLineStart: number = currentText.indexOf("\n");
let currentTextNewFunctionStart: number = currentText.indexOf(functionName);
let currentTextNextLineStartUpdated: boolean = false;
while (currentTextNextLineStart !== -1 && currentTextNextLineStart < currentTextNewFunctionStart) {
++rangeStartLine;
currentText = currentText.substring(currentTextNextLineStart + 1);
currentTextNextLineStart = currentText.indexOf("\n");
currentTextNewFunctionStart = currentText.indexOf(functionName);
currentTextNextLineStartUpdated = true;
}
rangeStartCharacter = (rangeStartCharacter === 0 && !currentTextNextLineStartUpdated ? range.start.character : 0) +
currentTextNewFunctionStart;
if (rangeStartCharacter < 0) {
// functionName is missing -- unexpected error.
void vscode.window.showErrorMessage(`${localize("invalid.edit",
"Extract to function failed. An invalid edit was generated: '{0}'", edit.newText)}`);
continue;
}
replaceEditRange = new vscode.Range(
new vscode.Position(rangeStartLine, rangeStartCharacter),
new vscode.Position(rangeStartLine, rangeStartCharacter + functionName.length));
nextLineOffset -= range.end.line - range.start.line;
}
this.renameDataForExtractToFunction.push({ uri, range: currentEditRange });
}
}

Expand All @@ -3601,7 +3603,6 @@ export class DefaultClient implements Client {

const firstUri: vscode.Uri = formatUriAndRanges[0].uri;
await vscode.window.showTextDocument(firstUri, { selection: replaceEditRange });
await vscode.commands.executeCommand("editor.action.rename", firstUri, replaceEditRange.start);

// Format the new text edits.
const formatEdits: vscode.WorkspaceEdit = new vscode.WorkspaceEdit();
Expand Down Expand Up @@ -3645,8 +3646,6 @@ export class DefaultClient implements Client {
}
}

public renameDataForExtractToFunction: VsCodeUriAndRange[] = [];

public onInterval(): void {
// These events can be discarded until the language client is ready.
// Don't queue them up with this.notifyWhenLanguageClientReady calls.
Expand Down