IntelliJ IDEA 2025.1 Help

RuboCop

IntelliJ IDEA 支持与 RuboCop 集成,并使您能够直接在 IDE 中(例如,在代码编辑器中)修复其违规行为。

RuboCop 违规

您还可以检查整个项目,并在一份报告中显示所有 RuboCop 警告。

如果必要,您可以启用 Standard包装器并使用它来分析项目源代码。

安装 RuboCop/Standard gems

默认情况下, RuboCop 检查在 IntelliJ IDEA 中启用,并且需要在 项目的解释器 中安装 'rubocop' gem。 如果该 gem 未安装,IntelliJ IDEA 会建议这样做。

安装 Rubocop

如果您想使用 Standard 分析您的项目,请将 'standard' gem 添加到您的 Gemfile 安装它

启用/禁用 RuboCop 和 Standard 检查

启用或禁用 RuboCop标准 检查,请执行以下操作:

  1. 打开 设置 对话框 Ctrl+Alt+S

  2. 请转到 编辑器 | 检查 页面,然后在 Ruby︱Gems 和 gem 管理 下启用/禁用 RuboCop 检查。

    启用标准
  3. 要使用 Standard linter 和格式化器,请转到 工具 | Rubocop 页面并启用 请使用‘standard’ gem 选项。

    启用标准

在编辑器中修复 RuboCop 错误

当启用 RuboCop 检查时,IntelliJ IDEA 会在代码编辑器中突出显示其违规行为。 要查看警告说明并进行修复,请执行以下操作:

  1. 将文本光标放在突出显示的区域并按 Ctrl+F1

    编辑器中的 RuboCop 警告
  2. 若要修复此问题,请按 Alt+Enter。 您可以修复文件中所有建议的违规行为,或者通过 类违规 或 cop 部门仅应用特定的修复。

    修复 RuboCop 违规

运行 Rubocop 检查

IntelliJ IDEA 使您能够通过运行相应的 检查 来查找整个项目中的 RuboCop 违规。 为此,请按照以下步骤操作:

  1. Ctrl+Alt+Shift+I 或转到主菜单中的 代码 | 分析代码 | 通过名称运行检查(R)…

  2. 在弹出窗口中,找到 RuboCop 并按 Enter

  3. 运行 'RuboCop' 对话框中,指定您要分析的文件范围。 如果有必要,启用 请使用‘standard’ gem。 点击 OK

  4. 请等待 IntelliJ IDEA 分析您的项目。 在 检查结果 工具窗口中,您可以查看 RuboCop 违规,并使用 修复所有可自动更正的 RuboCop 问题 按钮修复可自动更正的违规。

    RuboCop 检查结果

    您还可以浏览单个文件,并根据类错误或警察部门应用特定修复。

    RuboCop 检查结果

在保存时运行 RuboCop

您可以配置 IntelliJ IDEA 在每次保存更改时自动启动 RuboCop 并在 安全模式下自动修复代码。

  1. 设置 对话框(Ctrl+Alt+S )中,选择 工具 | Rubocop

  2. 选择 保存时运行 `rubocop -a` 选项以启用保存时的 RuboCop 自动修正。

    在保存时运行 RuboCop
  3. 点击 OK 以应用更改。

映射 RuboCop 和 IDE 严重性级别

默认情况下,IntelliJ IDEA 按如下方式映射 RuboCop 严重性检查严重性

RuboCop 严重性

检查严重性

重构,约定

弱警告

警告

警告

错误、致命

Error

要更改默认映射,请按照以下步骤操作:

  1. 打开 设置 对话框 Ctrl+Alt+S

  2. 请前往 编辑器 | 检查 页面并选择 RuboCop 检查。

  3. 配置 RuboCop 严重性与检查严重性在 RuboCop 严重性映射 组中的映射。

    严重性映射

RuboCop 配置文件

RuboCop 允许您通过配置文件自定义其行为。 IntelliJ IDEA 会自动检测 .rubocop.yml 文件并使用它运行检查。 或者,您可以为检查指定自定义配置文件。

.rubocop.yml

IntelliJ IDEA 会考虑 .rubocop.yml 文件中指定的所有设置。 例如,如果您禁用某些检测,指定 cop 部门, 编辑器 将不会显示相应的违法行为。 此外,这些违规行为不会显示在 RuboCop 检查 报告中。

自定义 RuboCop 配置

要指定自定义 RuboCop 配置文件:

  1. 设置 对话框(Ctrl+Alt+S )中,选择 工具 | Rubocop

  2. 配置文件 字段中指定配置文件。

选择配置文件

如果未选择配置文件,检查将使用项目中存在的 .rubocop.yml 运行。 否则,IntelliJ IDEA 将使用默认设置。

如何:使用自定义选项运行 RuboCop 检查已打开的文件

有时需要使用自定义选项运行 RuboCop 以检查当前打开的文件。 例如,当 RuboCop 检查 被禁用时,或者您想为某个特定的 RuboCop 操作分配一个 快捷键

在这个示例中,我们将展示如何使用 RuboCop 作为 外部工具来纠正当前打开文件中的布局违规。

创建自定义 RuboCop 操作

  1. 设置 对话框(Ctrl+Alt+S )中,选择 工具 | 外部工具

  2. 点击 "添加"按钮 并指定以下设置:

    编辑工具对话框
    • 名称 :将在 IntelliJ IDEA 界面中显示的菜单命令(工具 菜单和上下文菜单)。

    • 分组 :该命令所属组的名称。 您可以选择一个现有组或输入一个新组名。

    • 程序 :RuboCop 可执行文件的名称。

    • 实参 :传递给可执行文件的参数,就像您在命令行中指定它们一样。 这里我们使用 -x RuboCop 选项仅检查当前文件的布局问题。

    • 工作目录 :从执行工具的当前工作目录的路径。

  3. 点击 OK 添加工具,然后应用更改。

  4. (可选)为新建的操作分配一个快捷键。 在 设置 对话框(Ctrl+Alt+S )中, 选择 按键映射, 在 RuboCop 节点下找到 外部工具 操作并指定一个快捷键。

    配置快捷键

运行自定义 RuboCop 动作

  • 要运行创建的 RuboCop 动作,请转到 工具 主菜单或使用文件的上下文菜单。

    运行自定义操作

    当命令运行时,其输出显示在 运行 工具窗口中。

    自定义操作输出
最后修改日期: 2025年 4月 24日