RubyMine 8.0 Help

Code Style

File | Settings | Editor | Code Style


Use this page to choose the code style scheme and change it as required. Settings of a code style scheme are automatically applied every time RubyMine generates, refactors, or reformats your code.

On this page:

Scheme

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

The code styles are defined at the project level and at the global level.

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

    The default scheme cannot be changed! When any modifications are made, RubyMine automatically creates a copy of the default scheme. If you want to use a different project level scheme, choose the desired scheme and copy its settings to project.

  • At the Global level, settings are grouped under the predefined Default scheme, and any other scheme created by the user. The global settings are used when the user doesn't want to keep code style settings with the project, and share them.

ItemDescription
SchemeFrom this drop-down list, select the scheme to be used. The predefined schemes are shown in bold. The custom schemes, ones created as copies of the predefined schemes, are in plain text.
ManageClick this button to open the dialog that lets you manage the schemes.
ResetThis link appears in the upper-right corner of the dialog when the current style or scheme are modified. Click this button to discard changes.

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 (for new files)Use this drop-down list to specify which line separator is to be used in files created by RubyMine. The available options are:
  • System dependent - choose this option to use the default selection.
  • Unix and OS X (\n) - choose this option to use the Unix and OS X line separator.
  • Windows (\r\n) - choose this option to use the Windows line separator.
  • Classic Mac (\r) - choose this option to use the Classic Mac line separator.

Refer to the section Configuring Line Separators.

Right Margin (columns)In this text box, specify the number of columns to be used to display pages in the editor.
Wrap when typing reaches right marginSelect this check box to ensure that edited text always fits in the specified right margin.

Indents Detection

Use this area to specify default options for indentation.

ItemDescription
Detect and use existing file indents for editingSelect this check box for RubyMine to detect the existing indents in the file and use them for editing instead of the indents specified in the Code Style settings for the specific language.
Show notifications about detected indentsSelect this check box to show a notification if RubyMine detects indents that are different from the ones specified in the Code Style settings for the specific language.

Formatter Control

In this area, specify the markers to limit code fragments that you want to exclude from reformatting, see more in Reformatting Source Code. In the source code, formatting markers are written inside line comments, see Commenting and Uncommenting Blocks of Code.

ItemDescription
Enable formatter markers in comments
  • If this check box is selected, the fragments of code between the line comments with the formatting markers will not be reformatted but will preserve the original formatting. After you select the check box, the fields below become available and you can specify the character strings to be treated as formatting markers.
  • If the check box is cleared, the formatting markers will be ignored and the code between the line comments with markers will be reformatted.
Markers
Formatter off: In this text box, 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.
Formatter on: In this text box, 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.
Regular expressionsSelect this check box 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.

Example of using formatting markers

The original source code The code after reformatting
js_formatting_markers_original
When the formatting markers are disabled, the original formatting is broken:
js_formatting_markers_off

When the formatting markers are enabled, the original formatting is preserved:

js_formatting_markers_original

EditorConfig

In this area enable the support of the EditorConfig plugin.

ItemDescription
Enable EditorConfig supportSelect this check box 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 check box. See also Configuring Code Style procedure.

See Also

Last modified: 12 January 2016