从命令行运行代码检查
RubyMine 运行代码检查以查找和突出显示语法错误、无用代码、可能的错误、不良编码风格和其他问题。 您还可以从命令行运行为特定项目配置的所有检测,并将结果存储为报告的 XML、JSON 或纯文本文件。
命令行检查器将在后台启动 RubyMine 实例,并在其中运行检查。 如果另一个 RubyMine 实例已经在运行,则无法工作。 在这种情况下,您可以在运行实例中使用检查。 使用命令行检查器对有众多贡献者的大型项目进行自动化常规代码分析。
您可以在安装目录下找到运行 RubyMine 的可执行文件 bin 。 要将此可执行文件用作命令行启动器,请将其添加到您的系统 PATH ,如 命令行界面 中所述。
- 语法
- rubymine64.exe rinspect <project> <inspection-profile> <output> [<options>]
- 示例
检查 C:\MyProject\src 目录中 C:\MyProject 项目,使用 C:\MyProject\.idea\inspectionProfiles\MyProfile.xml 配置文件进行最大详细输出,并将结果保存到 C:\MyProject\InspectionResults 下的 XML 文件中:
rubymine64.exe rinspect C:\MyProject C:\MyProject\.idea\inspectionProfiles\MyProfile.xml C:\MyProject\InspectionResults -v2 -d C:\MyProject\src
RubyMine 包含一个用于运行命令行代码检查器的脚本。 默认情况下,它位于应用程序包中: RubyMine.app/Contents/bin/inspect.sh
- 语法
- rinspect.sh <project> <inspection-profile> <output> [<options>]
- 示例
检查 ~/MyProject/src 目录中 ~/MyProject 项目,使用 ~/MyProject/.idea/inspectionProfiles/MyProfile.xml 配置文件进行最大详细输出,并将结果保存到 ~/MyProject/InspectionResults 下的 XML 文件中:
rinspect.sh ~/MyProject ~/MyProject/.idea/inspectionProfiles/MyProfile.xml ~/MyProject/InspectionResults -v2 -d ~/MyProject/src
您可以在安装目录下找到运行 RubyMine 的脚本 bin 。 要将此脚本用作命令行启动器,请按照 PATH 中描述的步骤将其添加到您的系统 命令行界面 中。
- 语法
- rubymine.sh rinspect <project> <inspection-profile> <output> [<options>]
- 示例
检查 ~/MyProject/src 目录中 ~/MyProject 项目,使用 ~/MyProject/.idea/inspectionProfiles/MyProfile.xml 配置文件进行最大详细输出,并将结果保存到 ~/MyProject/InspectionResults 下的 XML 文件中:
rubymine.sh rinspect ~/MyProject ~/MyProject/.idea/inspectionProfiles/MyProfile.xml ~/MyProject/InspectionResults -v2 -d ~/MyProject/src
选项
选项 | 描述 |
|---|---|
| 仅运行在本地未提交更改上的检查。 |
| 如果您不想检查整个项目,请指定子目录的完整路径。 |
| 指定输出文件的检查结果格式: |
| 设置输出的详细程度:
|
检查配置文件
一个 检查配置文件是一个 .xml 文件,用于指定启用的检查及其选项。
默认情况下, 项目检查配置文件 存储在项目目录: .idea/inspectionProfiles 。
全局 IDE 检查配置文件存储在 IDE 配置目录下 inspection 。
检查结果
您可以在 RubyMine 或任何文本编辑器中将生成的 XML 文件作为常规文件打开。 然而,使用 离线查看 “问题”工具窗口 进行分析更为方便:
查看检查结果
打开您运行检查的项目。
在主菜单中,进入
请选择包含检查结果的目录,然后点击 确定。