Refactoring Source Code

Refactoring source code: main steps

Despite the differences in the goals and the workflow, all the WebStorm refactorings require some mandatory steps. Below is an overview of these main steps you will perform when refactoring your code.

Selecting the item to refactor

Do one of the following:

• In the Project tool window, select the file or folder to move, copy, or rename.
• In the editor, select the expression or symbol to refactor.

Invoking a refactoring

Do one of the following:

• On the main menu or on the context menu of the selection, choose Refactor | <required refactoring>.
• Press the dedicated shortcut (see the table of available refactorings below).
• Open the Refactor This pop-up list (choose Refactor | Refactor This or press Ctrl+Shift+Alt+T), and then choose the required refactoring.

Previewing, adjusting, and applying the suggested changes

For some refactorings WebStorm provides an option to preview the changes before applying them. To preview the potential changes and make the necessary adjustments, click Preview in the refactoring-specific dialog. WebStorm opens a dedicated tab in the Find tool window and shows the changes that are going to be made.

If necessary, some changes can be excluded during refactoring. If any conflicts are expected after the refactoring, WebStorm displays a dialog with a brief description of the encountered problems.

To exclude an entry from refactoring
Select it in the list and press Delete.

To avoid potential conflicts

• Ignore the conflicts by clicking the Continue button. As a result, the refactoring will be performed, however, this may lead to erroneous results.
• Preview the conflicts by clicking the Show in View button. WebStorm shows all conflicting entries on the Conflicts tab in the Find tool window, enabling you to navigate to the problematic lines of code and to make the necessary fixes.
• Cancel the refactoring and return to the editor.

To apply the changes
When you are happy with the proposed results, click Do Refactor.

Copying, renaming, and moving files and folders

With these refactorings you can make copies of files and folders with the same names or with new ones, store them in the same parent folders or in new ones, as well as move files and folders to other locations.

To copy a file or a folder

1. Select the file or folder to copy in the Project tool window or open it in the editor and press F5 or choose Refactor | Copy on the main menu or on the context menu of the selection.
2. In the dialog box that opens, specify the new name of the file or the folder and the new parent folder, if applicable.

To rename a file or a folder

1. In the Project tool window, select the file or folder to rename and choose Refactor | Rename on the context menu or press Shift+F6.
2. In the dialog that opens, type the new name of the file or folder.
3. To update the references to the file or folder in comments, strings, and text (for files), select the corresponding checkboxes.
4. Click Refactor and examine the suggested changes in the dedicated tab of the Find tool window, as described in Previewing, adjusting, and applying the suggested changes above. Click Do Refactor when you are happy with the expected results.

To move a file or a folder

1. In the Project tool window, select the file or folder to move and choose Refactor | Move on the context menu or press F6.
2. In the dialog that opens, specify the new parent folder. Choose an existing folder or type the name of a new one to be created.
3. Select the Search for references checkbox to update the references to the moved file or folder.

Deleting a file safely (Safe Delete)

Unlike simple deletion of a file (Delete or Delete on the context menu), this refactoring makes sure that you do not delete files that are referenced in your source code. WebStorm looks for the usages of the file to be deleted and shows them in the Usages Detected dialog.

To apply Safe Delete to a file

1. In the Project tool window, select the file to remove and choose Refactor | Safe Delete on the context menu or press Alt+Delete.
2. In the Safe Delete dialog that opens, select the corresponding checkboxes to look for usages of the file in comments and strings and for occurrences of the file in text.
3. If any usages are detected, WebStorm lists them in the Usages Detected dialog.
   • To delete the file without viewing the found usages, click Delete Anyway.
   • To stop the refactoring, click Cancel.
   • To examine the potential conflicts, click View Usages. WebStorm opens a dedicated tab of the Find tool window where the usages are listed. Explore them, analyze the potential conflicts, and update your code as described in Previewing, adjusting, and applying the suggested changes above.

Refactorings supported in WebStorm