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