Skip to content

Add 'renameFile' command to services#23573

Merged
3 commits merged intomasterfrom
renameFile
Apr 20, 2018
Merged

Add 'renameFile' command to services#23573
3 commits merged intomasterfrom
renameFile

Conversation

@ghost
Copy link

@ghost ghost commented Apr 20, 2018 •
edited by ghost
Loading

Here's how I think it would work:

  • First, the user renames a file normally using the file explorer in their editor.
  • Tsserver will pick up on this change and update the project (which will break a lot of imports to the old location).
  • After the rename, the editor will offer the user to update references to the file.
  • If the user says yes, it will then ask tsserver to get code edits, passing in the old and new paths to the file.
  • Tsserver will walk all imports, see which ones are unresolved now and could have resolved to the old path (but don't since that's been moved now), and update them to the new path instead, and send these edits to the editor.
  • The editor will apply the edits to all files. (Hopefully with undo functionality if the user decides against renaming the file.)

This is a bit tricky on the tsserver side since we need to be able to figure out what unresolved imports could have resolved to. This meant I had to leave moduleResolutionCache around so we could look at the failed lookup locations for failed imports.

Fully expecting to need a lot of revision on this. CC @mjbvz for protocol review.

@ghost ghost requested review from amcasey, mhegazy and sheetalkamat April 20, 2018 17:15
@mhegazy
Copy link
Contributor

mhegazy commented Apr 20, 2018

//cc @mjbvz

@mhegazy
Copy link
Contributor

mhegazy commented Apr 20, 2018

We also need to consider /// <reference path="..." /> comments. bonus point for tsconfig.json "files" entries.

@ghost ghost force-pushed the renameFile branch from 95525be to 505189f Compare April 20, 2018 17:37
@mjbvz
Copy link
Contributor

mjbvz commented Apr 20, 2018

Ok, I think this flow makes sense and the api looks good.

We may also need an api to check if any renames are necessary so we can avoid prompting the user in cases with loose files

mhegazy
mhegazy reviewed Apr 20, 2018
View reviewed changes
src/services/tsconfig.json Outdated
"navigateTo.ts",
"navigationBar.ts",
"organizeImports.ts",
"../services/renameFile.ts",
Copy link
Contributor

@mhegazy mhegazy Apr 20, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

jsut renameFile.ts

mhegazy
mhegazy reviewed Apr 20, 2018
View reviewed changes
src/services/services.ts Outdated
return OrganizeImports.organizeImports(sourceFile, formatContext, host, program, preferences);
}

function renameFile(oldFilePath: string, newFilePath: string, formatOptions: FormatCodeSettings): ReadonlyArray<FileTextChanges> {
Copy link
Contributor

@mhegazy mhegazy Apr 20, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the name makes me think there is will rename the file as well.. how about getEditsForFileRename

@ghost
Copy link
Author

ghost commented Apr 20, 2018

@sheetalkamat What's a good way to get access to the tsconfig.json source file given a Program object, so that we can make edits for it?

@ghost ghost mentioned this pull request Apr 20, 2018
Closed
@ghost ghost merged commit 5c94bef into master Apr 20, 2018
@ghost ghost deleted the renameFile branch April 20, 2018 20:43
@mhegazy
Copy link
Contributor

mhegazy commented Apr 20, 2018 •
edited
Loading

@Andy-MS the soruceFile for the tsconfig.json is stored in options.configFile, assuming one exists.

@mhegazy mhegazy mentioned this pull request May 3, 2018
Closed
@rauschma
Copy link

rauschma commented May 3, 2018

FWIW: most IDEs I’ve used, asked me – before the file was actually moved: “Do you also want to update references?”
Naively, it seems like that could simplify the algorithm.

@mjbvz mjbvz mentioned this pull request May 4, 2018
Closed
@OliverJAsh OliverJAsh mentioned this pull request Jun 11, 2018
Closed
@MgSam
Copy link

MgSam commented Jun 12, 2018

Is this supposed to work for renaming folders as well? It doesn't seem to in VS Code 1.24 / TypeScript 2.9.1.

@mhegazy
Copy link
Contributor

mhegazy commented Jun 12, 2018

Folder rename should be working in typescript@2.9.2 and next VSCode release.

@mhegazy
Copy link
Contributor

mhegazy commented Jun 12, 2018

Filed #24904 to track folder renames.

@williamboman williamboman mentioned this pull request May 6, 2019
Closed
3 tasks
atscott added a commit to atscott/vscode-ng-language-service that referenced this pull request May 18, 2021
@atscott
poc file rename participation
da306f9 
microsoft/TypeScript#23573
microsoft/vscode#43768
atscott added a commit to atscott/vscode-ng-language-service that referenced this pull request May 18, 2021
@atscott
poc file rename participation
c89de5c 
microsoft/TypeScript#23573
microsoft/vscode#43768
@jespertheend jespertheend mentioned this pull request Feb 20, 2023
Closed
@microsoft microsoft locked as resolved and limited conversation to collaborators Oct 21, 2025
This pull request was closed.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@sheetalkamat sheetalkamat Awaiting requested review from sheetalkamat

@amcasey amcasey Awaiting requested review from amcasey

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@mhegazy @mjbvz @rauschma @MgSam