一. 简介
PHP_CodeSniffer是一个优秀的代码风格检测工具,定义了一系列的代码规范(通常使用官方的代码规范标准比如PHP的PSR2),能够检测出不符合代码规范的代码并发出警告或报错(可设置报错等级),常被用作团队开发时维护编码风格以及标准。代码现代化并对其进行优化代码样式检查, 验证你的
代码与所选编码标准的一致性, 不需要其他步骤即可启动它。文件中的每次更新都会激活即时代码检查，因此很容易消除发现的问题。由PHP_CodeSniffer即时报告的错误和警告将显示为弹出消息。当该工具以批处理模式运行时，错误和警告将显示在“ 检查结果”工具窗口中。每条消息都有
phpcs前缀，以区别于PhpStorm内部检查。与PHP CS Fixer工具集成在一起，可以修复许多检测到的问题。手工解决这些问题很繁琐，尤其是在大型项目中。这两个工具不仅可以检测到它们，还可以为你修复它们。
二. 安装
1. composer 全局安装:
- composer global require friendsofphp/php-cs-fixer
- composer global require "squizlabs/php_codesniffer=*"
2. phpstorm 配置:
- 依次打开: File->Settings->Langeuages & Frameworks->PHP->Quality Tools
为Code Sniffer 和 PHP CS Fixer 配置composer 已安装拓展路径, 一般为(依据个人路径选择, 更改Administrator用户):
C:\Users\Administrator\AppData\Roaming\Composer\vendor\bin\phpcs.bat 和
C:\Users\Administrator\AppData\Roaming\Composer\vendor\bin\php-cs-fixer.bat
完成后可点击路径后VALIDATE 验证是否成功
- 依次打开: File->Settings->Editor->Inspections->Quality tools
把PHP Code Sniffer validation 和 PHP CS Fixer validation 勾上 并把右边Ruleset 选择为 PSR2
- 依次打开: File->Settings->Tools->External Tools
点击右边 "+" 号添加工具 出现弹框 以下参数填充
Name: 任意取方便记忆即可
Program: C:\Users\Administrator\AppData\Roaming\Composer\vendor\bin\php-cs-fixer.bat
Arguments: --rules=@PSR2 --verbose fix "$FileDir$/$FileName$"
Working directory: $ProjectFileDir$
再次点击 "+" 添加第二个工具 参数同上 Arguments修改为
Arguments: --rules=@PSR2 --verbose fix "$FileDir$"
到此基本完成 可配置快捷键快速操作 File->Settings->Keymap->External Tools->External Tools
或者不配置快捷键 也可在File 同级 Tools->External Tools 里找到你的工具点击格式化代码
三. 使用
1. 对单个模块或者整个项目目录进行格式化 依据自己的设置操作
2. 模块已激活情况下 打开任意文件会自动扫描代码样式和编码标准 即时报告错误和警告 一般为各色波浪线
