Shelve Changes dialog
Use this dialog to shelve the selected files or changelists.
Modified files pane
This section contains a list of files that have been modified since the last commit. All files in the list are selected by default. Deselect the files that you do not want to shelve.
Modified files pane toolbar
Item | Tooltip and Shortcut | Description |
|---|---|---|
| Show Differences Ctrl+D | Open the Differences dialog that highlights the differences between your local working copy of the selected file and its repository version. |
| Revert | Revert all changes made to the local working copy of the selected files. |
| Refresh Changes Ctrl+F5 | Click this button to reload the Changed files tree view so it is up-to-date. |
| Group By | Choose how you want to group the modified files - by directory or module |
| Expand or collapse all nodes Ctrl+NumPad + Ctrl+NumPad - | Click these buttons to expand or collapse all nodes in the directory tree. These buttons are not available in flat view. |
Changelist | N/A | From this list, select the changelist that contains the modified files to be shelved. The active changelist is selected by default. |
The summary under the modified files pane shows statistics on the currently selected changelist, such as the number of modified, new and deleted files. This area also shows how many files of each type are shown, and how many of them will be shelved.
Commit Message pane
In this area, enter a string that will be used as the shelf name. When you unshelve your changes, a new changelist with the same name will be created in the Changes view. If you leave this field empty, the shelf name will be generated using the following pattern: <number of files in the shelf>, <date and time when the shelf was created>:
Submit / Commit section
Use the controls in this area to define which additional actions you want WebStorm to perform before shelving the selected files.
These controls are available for the following version control systems:
Git
Subversion
Perforce
Item | Description |
|---|---|
Reformat code | Perform code formatting according to the Project Code Style settings. |
Rearrange code | Rearrange your code according to the arrangement rules preferences. |
Optimize imports | Remove redundant import statements. |
Analyze code | Analyze modified files while committing them. Click Configure to select an inspection profile from which the IDE will run inspections. |
Check TODO (<filter name>) | Review the TODO items matching the specified filter. Click Configure to choose an existing TODO filter, or open the TODO settings page and define a new filter to be applied. |
Cleanup | Automatically apply the current inspection profile to the files you are going to commit/shelve. |
After Submit / After Commit section
Use the controls in this area to define which additional actions you want WebStorm to perform after committing the selected files.
Item | Description | Available for |
|---|---|---|
Run tool | From this list, select the external tool that you want WebStorm to launch after the selected changes have been committed. You can select a tool from the list, or click the Browse button | All VCSs |
Upload files to | From this list, select the server access configuration or a server group to use for uploading the committed files to a local or remote host, a mounted disk, or a directory.
The list is only available if the FTP/SFTP/WebDAV Connectivity plugin is enabled. | All VCSs |
Always use selected server or group of servers | Select this checkbox to always upload files to the selected server or a server group. The checkbox is only available if the FTP/SFTP/WebDAV Connectivity plugin is enabled. | All VCSs |
and configure an external tool in the Diff pane
To open the Diff pane, press Ctrl+D or right-click the file you want to investigate and select Show Diff in the context menu.
In this pane you can explore the differences between the base repository version of the selected file, and the version you are about to commit.
Diff pane toolbar
Item | Tooltip and Shortcut | Description |
|---|---|---|
| Previous Difference / Next Difference Shift+F7 F7 | Jump to the next or previous difference. When the last or the first difference is reached, WebStorm suggests clicking the arrow buttons or pressing F7/Shift+F7 once more and comparing other files modified locally. This behavior depends on the Go to the next file after reaching last change option in the Diff Viewer settings. |
| Jump to Source F4 | Open the selected file in the editor. The caret is placed in the same position as in the Diff Viewer. |
| Compare Previous/Next File Alt+Left Alt+Right | Click these buttons to compare the local copy of the previous/next file with its update from the server. |
Viewers | Select a viewer mode: side-by-side or unified. The side-by-side mode has two panels, and the unified mode has one panel. You can edit code and perform the Accept, Append, Revert actions in both viewers. You can change text only in the right-hand part of the side-by-side viewer or in the lower line in the unified viewer. You can edit only local versions of your files. You cannot edit files that have read-only status. | |
Whitespace | Define how the Diff Viewer should treat whitespaces.
| |
Highlighting mode | Select the way differences granularity is highlighted. The available options are:
| |
| Collapse Unchanged Fragments | Collapse all the unchanged fragments in both files. The amount of non-collapsible unchanged lines is configurable on the Diff & Merge settings page. To open the Diff & Merge page, open settings by pressing Ctrl+Alt+S and navigate to . . |
| Synchronize scrolling | Scroll both differences panes simultaneously. If this button is released, each pane can be scrolled independently. |
| Disable editing | Enable editing of the local copy of the selected file, which is disabled by default. When editing is enabled, you can make last-minute changes to the modified file before committing it. |
| Editor settings | Open a list of available options. Select or clear these options to show or hide line numbers, indentation guides, white spaces, and soft wraps. |
| Help F1 | Open a browser and show the corresponding help page. |
/
Note that the options listed above are available for text files only. WebStorm cannot compare binary files, so most commands will be unavailable for them.