RubyMine
 
2024.3
Shortcuts: Windows
Get RubyMine
  1. Analyze code
  2. RuboCop

RuboCop

Last modified: 23 October 2024

RubyMine supports integration with RuboCop and enables you to fix its offenses right inside the IDE, for example, in the code editor.

RuboCop offense

You can also check the entire project and display all RuboCop warnings in a single report.

If necessary, you can enable the Standard wrapper and use it for analyzing project sources.

Install RuboCop/Standard gems

The RuboCop inspection is enabled in RubyMine by default and requires the 'rubocop' gem to be installed in the project’s SDK. If this gem is not installed, RubyMine will suggest doing this.

Install Rubocop

If you want to use Standard to analyze your project, add the 'standard' gem to your Gemfile and install it.

Enable/Disable RuboCop and Standard inspections

To enable or disable RuboCop and Standard inspections, do the following:

Fix RuboCop offenses in the editor

When RuboCop inspections are enabled, RubyMine highlights its offenses in the code editor. To see the warning description and fix it, do the following:

Run Rubocop inspection

RubyMine enables you to find RuboCop offenses for the entire project by running a corresponding inspection. To do this, follow the steps below:

Run RuboCop on save

You can configure RubyMine to automatically launch RuboCop and autocorrect your code in safe mode every time you save your changes.

Map RuboCop and IDE severities

By default, RubyMine maps RuboCop severities and inspection severities in the following way:

RuboCop severity

Inspection severity

Refactor, Convention

Weak Warning

Warning

Warning

Error, Fatal

Error

To change the default mapping, follow the steps below:

RuboCop Configuration files

RuboCop allows you to customize its behavior through configuration files. RubyMine automatically detects .rubocop.yml file and uses it to run the inspection. Alternatively, you can specify a custom configuration file for the inspection.

.rubocop.yml

RubyMine takes into account all settings specified in the .rubocop.yml file. For example, if you disable some checks for a specified cop department, the editor will not show corresponding offenses. Moreover, these offenses won't be shown in the RuboCop inspection report.

note

Some RuboCop checks depend on the Ruby interpreter version. Make sure that the target Ruby version configured for the RuboCop is the same as the Ruby interpreter specified for a project.

Custom RuboCop configuration

To specify a custom RuboCop configuration file:

If no configuration file is selected, the inspection runs using .rubocop.yml if present in the project. Otherwise, RubyMine uses the default settings.

How to: Run RuboCop for the opened file with custom options

Sometimes it is necessary to run RuboCop for the currently opened file with custom options. For example, this can be useful when RuboCop inspections are disabled, or you want to assign a shortcut for a specific RuboCop action.

In this example, we'll show how to use RuboCop as an external tool to correct layout offenses in the currently opened file.

Create a custom RuboCop action

  1. In the Settings dialog (CtrlAlt0S) , select Tools | External Tools.

  2. Click the Add button and specify the following settings:

    The Edit Tool dialog

    • Name: The menu command that will be displayed in the RubyMine interface (the Tools menu and context menus).

    • Group: The name of the group to which the command belongs. You can select an existing group or type the name of a new group.

    • Program: The name of the RuboCop executable.

    • Arguments: The arguments passed to the executable file, as you would specify them on the command line. Here we use -x RuboCop option to run only layout cops for the current file.

    • Working directory: The path to the current working directory from which the tool is executed.

  3. Click OK to add the tool and then apply the changes.

  4. (Optional) Assign a shortcut for the created action. In the Settings dialog (CtrlAlt0S) , select Keymap, find the External Tool action under the RuboCop node and specify a shortcut.

    Configure shortcut

Run a custom RuboCop action

  • To run the created RuboCop action, go to the Tools main menu or use the context menu of a file.

    Run custom action

    When the command runs, its output is displayed in the Run tool window.

    Custom action output

See also

Procedures

External Links