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