GoLand
 
2023.2
Shortcuts: Windows
Get GoLand
You are viewing the documentation for an earlier version of GoLand.
  1. Write and edit source code
  2. Code refactoring
  3. Rename refactorings

Rename refactorings

Last modified: 23 August 2023

Shortcut for the action: ShiftF6

General refactoring settings: Settings | Editor | Code Editing

Use the Rename refactoring to change names of symbols, files, and all the references to them throughout code.

Renaming local variables or private methods can be done easily inline since only the limited scope is affected. Renaming types, interfaces, or public methods could potentially impact a lot of files. Preview potential changes before you refactor.

tip

When you rename methods that are declared in interfaces, you can also review and rename their implementations as well. The refactoring changes are displayed on the Refactoring Preview tab in the Find tool window.

Rename code in place

  1. In the editor start renaming a parameter, a method, or other code element. GoLand will display the Rename the usages of icon in the gutter.

  2. Click the gutter icon or press AltEnter and apply a suggestion.

    Rename inline

    GoLand renames the code element and updates its usages accordingly.

    Rename refactoring result

Rename a code element

  1. In the editor, select the element you want to rename. If you need to rename a file, select one in the Project tool window.

  2. Press ShiftF6 or from the main menu, select Refactor | Rename.

    When you invoke the rename ShiftF6 action, GoLand displays the Rename in comments and strings icon and the Rename in text occurrences icon next to the highlighted element.

    Rename variable

    You can press Tab to open the context menu and select the additional rename options.

    Additional Rename options

    If you want to see the Rename dialog with more options, click the More options link or press ShiftF6.

  3. You can perform the rename refactoring in-place or press ShiftF6 again to open the Rename dialog. Enter a new name of the element to enable the Preview and Refactor buttons.

    The Rename dialog

    You can specify additional options. For example, specify where to search for element occurrences, or what else to rename. You can also specify a scope for the refactoring.

  4. In the Refactoring Preview dialog, review potential changes and click Do Refactor.

The refactoring dialog

Next time you invoke the Rename refactoring, GoLand remembers the options you have specified inside the Rename dialog.

note

You cannot rename the .idea project directory since GoLand always reads the project files from the directory with that exact name.

tip

If you need to edit variables rather than to change them completely, go to Settings | Editor | Code Editing and clear the Preselect current symbol name for Rename refactoring checkbox located in the Refactorings section.

Rename methods in interfaces

You can rename methods that are declared in interfaces. When you rename the method, GoLand displays a context menu where you can select to rename method implementations as well.

  1. Right-click a method in an interface and select Refactor | Rename. Alternatively, position the caret at the method in the interface and press ShiftF6.

  2. In context menu select what you want to rename. To rename the method and all implementations, select Refactor method specification and all implementations. Otherwise, to refactor only selected method, select Refactor only current method.

  3. In the Change Signature dialog, change the method name in the Name field.

  4. Click Refactor.

    To preview your changes before refactoring, click Preview.

https://resources.jetbrains.com/help/img/idea/2023.2/go_rename_method_in_interface.png
Gif

Rename Go modules names

  1. Click the module name and navigate to Refactor | Rename. Alternatively, press ShiftF6.

  2. In the Rename dialog, configure the renaming options and click Refactor. Alternatively, click Preview to check all the usages of the module name in the project.

    https://resources.jetbrains.com/help/img/idea/2023.2/go_rename_go_modules_names.png
    Gif