RubyMine 2021.2 Help

Code Style

Scheme

In this area, choose the code style scheme and change it as required. Code style scheme settings are automatically applied every time RubyMine generates, refactors, or reformats your code.

Code styles are defined at the project level and at the IDE level (global).

  • At the project level, settings are grouped under the Project scheme, which is predefined and is marked in bold. The Project style scheme is applied to the current project only.

    You can copy the Project scheme to the IDE level, using the Copy to IDE command.

  • At the IDE level, settings are grouped under the predefined Default scheme (marked in bold), and any other scheme created by the user by the Duplicate command (marked as plain text). Global settings are used when the user doesn't want to keep code style settings with the project and share them.

    You can copy the IDE scheme to the current project, using the Copy to Project command.

ItemDescription
Scheme

From this list, select the scheme to be used. The predefined schemes are shown bold. The custom schemes, ones created as copies of the predefined schemes, are in plain text. The location where the scheme is stored is written next to each scheme, for example, the Default scheme is stored in the IDE, the Project scheme is stored in the project.

Show Scheme Actions

Click this button to invoke the list of commands to manage the schemes:

  • Copy to IDE: select this option to copy the scheme settings to RubyMine.

  • Export: select this option to export the selected scheme to an .xml file or an .editorconfig file in the selected location.

    Learn more from Manage code style on a directory level with EditorConfig.

  • Import Scheme: select this option to import the scheme of the selected type from the specified location.

  • Copy to Project: select this option to overwrite your current project code style settings with the settings from the selected IDE code style scheme.

  • Duplicate: select this option to create a copy of the selected scheme.

  • Reset: select this option to reset the default or bundled color scheme to the initial defaults shipped with RubyMine. This command becomes available only if some changes have been done.

  • Rename: select this option to change the name of the selected custom scheme. Press Enter to save changes, or Escape to cancel.

Line Separators

RubyMine lets you configure line separator and indentation options for various languages. When reformatting source code, RubyMine will apply the specified indentation behavior and skip the sections denoted with the special formatting off/on markers.

ItemDescription
Line Separator

Use this list to specify which line separator is to be used in files created by RubyMine. The available options are:

  • System-Dependent: select this option to use the default selection.

  • Unix and macOS (\n): select this option to use the Unix and macOS line separator.

  • Windows (\r\n): select this option to use the Windows line separator.

  • Classic Mac OS (\r): select this option to use the \r line separator, which was used in Classic Mac OS (up to Mac OS 9).

Hard wrap atIn this field, specify the number of columns to be used to display pages in the editor.
Wrap on typingSelect this checkbox to ensure that edited text always fits in the specified right margin.
Visual guidesIn this field, specify multiple right margins. You can leave a default value or enter the number of spaces for your margin. If you want to specify several margins, enter numbers separated by comma.

Indents detection

Select the Detect and use existing file indents for editing checkbox for RubyMine to detect the indentation style in the current file and use this style instead of the indents specified in the Code Style settings for the specific language.

RubyMine displays the indentation information in the status bar of the editor. You can click the indentation information to see the available actions, such as enable or disable this option, and change the current indentation to the ones specified in the Code Style settings for the specific language.

EditorConfig

In this area enable the support of the EditorConfig plugin.

ItemDescription
Enable EditorConfig supportSelect this checkbox to enable the EditorConfig plugin support. In this case you can specify your own code style settings that override the IDE settings. However, if you decide to use IDE settings after creating the EditorConfig settings file then you need clear the Enable EditConfig support checkbox.
ExportClick this button if you want to export the current IDE code style settings into the .editconfig file.

Formatter

In this area, specify the markers to limit code fragments that you want to exclude from reformatting. In the source code, formatting markers are written inside line comments.

ItemDescription
Do not formatIn this field, specify a glob pattern with the names of files and directories that you want to exclude from reformatting, code arrangement, and import optimization.
Markers
Turn formatter on/off with markers in code comments
  • If this option is enabled, fragments of code between line comments with the formatting markers will not be reformatted and will preserve the original formatting. After you select this checkbox, the fields below become available and you can specify the character strings to be treated as formatting markers.

  • If this option is disabled, the formatting markers will be ignored and the code between the line comments with markers will be reformatted.

Off:In this field, specify the character string that will indicate the beginning of a code fragment which you want to exclude from reformatting. Type a character string with the @ symbol in preposition or leave the predefined value @formatter:off.
On:

In this field, specify the character string that will indicate the end of a code fragment which you want to exclude from reformatting. Type a character string with the @ symbol in preposition or leave the predefined value @formatter:on.

Enable regular expressions in formatter markersSelect this checkbox to use regular expressions instead of specifying the formatting markers explicitly. RubyMine matches formatter on/off markers using the regular expression specified instead of the exact string.
Last modified: 31 August 2021