首页 > 代码库 > 在 PhpStorm 中添加代码审查工具 Code Sniffer
在 PhpStorm 中添加代码审查工具 Code Sniffer
一、前提条件
- Windows 操作系统
- 可以在本地运行的 PHP 环境，个人用的是 laragon
- PhpStorm
- Composer
二、设置步骤
（一）下载 Code Sniffer
主要使用 PHP 包管理工具 Composer 来获取 Code Sniffer。只要本地安装好了 Composer 并且已经将 Composer 执行文件加入了 PATH 目录，那么就可以在任意目录下运行 Composer 命令。这里强烈推荐 laragon，它几乎包含了现代 PHP 开发所需的大部分工具。以下所涉及到的工具都集成在 laragon 了。
操作过程：
1. Ctrl + Alt + T 打开 cmder
2. 进入项目目录：cd C:\laragon\www\basic
3. 安装 Code Sniffer：composer require spryker/code-sniffer
建议在通过 composer 安装软件包的时候，请到 https://packagist.org 查询一下这个包，然后根据提示命令安装：
在输入红线框里面的命令后，如果当前项目目录中没有 composer.json 文件，那么 composer 会自动将所有涉及到的包安装到当前项目的 vendor 目录，当然这个目录也是自动创建的。
（二）设置 PHP 本地执行环境
打开phpstorm，点击 file --> Settings --> Languages & Frameworks --> PHP 进入以下界面并设置：
PHP language level 我选择的是 PHP 7.0，目前最多选择 PHP 7.1。其次是选择 Interpreter 的文件目录，点击那“三个小点”按钮，然后选择 PHP 执行目录。
选择左上角的绿色加号按钮即可添加：
最后点击 Apply 让设置生效。
（二）设置 Code Sniffer
在 Settings 设置界面的搜索框中输入：Code Sniffer
PHP Code Sniffer (phpcs) 目录为：C:\laragon\www\basic\vendor\bin\phpcs.bat。如果点击 Validate 按钮后没有弹出校验成功的信息，那么请确认 PHP 的 PATH目录是否安装到位了。
其实有很多通过 composer 安装的软件包都可以通过这种方式来运行。比如我还想安装 Mess Detector 那么依旧通过这种安装方式来运行相应的软件包。
那么 Code Sniffer 就安装完毕了，具体操作请参考 Code Sniffer 的官方文档，或搜索其他相关教程。
在 PhpStorm 中添加代码审查工具 Code Sniffer