README

一个工具，使在命令行上运行 PHPStorm 检查变得更容易。

PHPStorm 提供了各种非常有用的检查，可以帮助你捕获代码中的错误。许多人没有意识到，你甚至可以不打开 PHPStorm IDE，就在命令行上运行这些检查。这是通过 PHPStorm 附带并在此处文档化的 inspect.sh 脚本来实现的

http://www.jetbrains.com/phpstorm/webhelp/working-with-phpstorm-features-from-command-line.html

遗憾的是，使用此脚本所需的参数有点复杂，并且很容易出错。除此之外，输出只是一堆 XML 文件，这些文件根据发现的问题类型分组，而不是发现问题的文件。

phpstorm-cli-inspector 如何帮助？

要在你的项目子目录上使用 PHPStorm 的 inspect.sh，你通常需要运行以下命令

/Applications/PhpStorm.app/bin/inspect.sh /delta/my-example-project/ /delta/my-example-project/.idea/inspectionProfiles/Project_Default.xml /tmp/output -d /delta/my-example-project/vendor/deltasystems/dewdrop/Dewdrop/Db/Dbdeploy/

运行检查后，你会查看 XML 文件以查看结果。

使用 phpstorm-inspect，这个命令就变成了

phpstorm-inspect /delta/my-example-project/vendor/deltasystems/dewdrop/Dewdrop/Db/Dbdeploy/

错误会立即在终端显示，并按文件名分组。phpstorm-inspect 命令中使用的路径可以是 PHPStorm 项目文件中的任何子目录。你不需要手动指向你的检查配置文件、.idea 文件夹等。命令完成后，XML 文件会自动清理。

以下是一些示例输出

$ ./bin/phpstorm-inspect /delta/my-example-project/vendor/deltasystems/dewdrop/Dewdrop/Db/Dbdeploy/
vendor/deltasystems/dewdrop/Dewdrop/Db/Dbdeploy/Changeset.php
=============================================================

* Line 169: PHPDoc comment doesn't contain all necessary @throws tag(s)

vendor/deltasystems/dewdrop/Dewdrop/Db/Dbdeploy/CliExec.php
===========================================================

* Line 198: PHPDoc comment doesn't contain all necessary @throws tag(s)

安装 phpstorm-inspect

你可以使用 Composer 安装 phpstorm-inspect

composer global require 'griffbrad/phpstorm-cli-inspector:>=1.0'
sudo ln -s ~/.composer/vendor/bin/phpstorm-inspect /usr/local/bin/phpstorm-inspect

请注意，上述命令假定你已经按照以下说明全局安装了 Composer

https://getcomposer.org.cn/doc/00-intro.md#globally

常见问题解答

它在 Windows 上工作吗？

不。如果有任何 Windows 用户想让它工作，我会很高兴接受拉取请求。

如果 PHPStorm 在非标准位置怎么办？

你可以在你的主目录中添加一个 .phpstorm-inspect.ini 配置文件。在该配置文件中，你可以指定两个东西：“inspectPath”，它将指向 PHPStorm 附带的 inspect.sh，以及“excludePatterns”，它应该是将排除匹配问题描述的正则表达式。