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