乐趣区

PHP代码修正之CodeSniffer

jiezi

Last-Modified: 2019 年 5 月 10 日 13:59:27

参考链接

  • PHP 开发规范之使用 phpcbf 脚本自动修正代码格式
  • 在 PhpStorm 中使用 PSR2 编码规范 phpcbf 脚本自动修正代码格式

使用 PHP-CS-Fixer 的可以看这篇文章: https://learnku.com/laravel/t…

介绍

PHP_CodeSniffer 是一个代码风格检测工具。它包含两类脚本，phpcs 和 phpcbf（GitHub 地址）

phpcs

phpcs 脚本对 PHP、JavaScript、CSS 文件定义了一系列的代码规范（通常使用官方的代码规范标准，比如 PHP 的 PSR2），能够检测出不符合代码规范的代码并发出警告或报错（可设置报错等级）。

phpcbf

phpcbf 脚本能自动修正代码格式上不符合规范的部分。比如 PSR2 规范中对每一个 PHP 文件的结尾都需要有一行空行，那么运行这个脚本后就能自动在结尾处加上一行空行。

php-cs-fixer

该工具不包含在 PHP_CodeSniffer 中, 是在另一个独立的项目 https://github.com/FriendsOfP…

php-cs-fixer 修复不规范代码 作用等同于 phpcbf 只不过规则好像稍有区别

安装

composer global require "squizlabs/php_codesniffer=*"

安装后会在全局的 Vendor目录下的 bin 中生成两个软链接：

phpcbf -> ../squizlabs/php_codesniffer/bin/phpcbf
phpcs -> ../squizlabs/php_codesniffer/bin/phpcs

查看全局 Vendor 目录位置:

composer global config bin-dir --absolute

使用

命令行模式

  1. 将 phpcs 和 phpcbf 的目录加入环境变量

  2. 设置默认代码标准

    为了避免每次手动指定标准, 直接设置默认的代码标准为 PSR-2

    phpcs --config-set default_standard PSR2
phpcbf --config-set default_standard PSR2

  3. 检测代码文件

    phpcs test.php

    此时命令行会提示发现的问题列表, 带 [x] 的表示可以被 phpcbf 修正

    若需要每次执行时指定代码格式标准, 则加上 –standard=<standard>

    phpcs --standard=PSR2 test.php

  4. 修正代码

    phpcbf test.php

    此时会修正问题列表中带 [x] 的问题

PHPStorm

让编辑器使用 PSR- 2 标准

1、打开 PhpStorm 的设置页（File->Setting），到 Editor->Code Style->PHP 页PHP中选择风格为 PSR1/2

2、到 Code Sniffer 页，路径是 Setting->Languages and Frameworks->PHP->Quality Tools->Code Sniffer，设置phpcs 的路径

Composer 全局的 vendor 目录 \bin\phpcs.bat

3、到 Inspections 页，路径Setting->Editor->Inspections，右侧的 PHP，勾选下面的两个 PHP，选择使用 PSR2

现在使用 PhpStorm 的格式化，将会自动格式化成 psr- 2 的风格

经过上面的操作，PhpStorm代码格式化的规则基本与 phpcs 的规则基本一致了，但也有一小部分不一致，所以后面还要用到 phpcs 和phpcbf

如果每次都在终端去执行花费时间可不少，为了提高工作效率，可以在 PhpStorm 集成 phpcbf、phpcs 检测规范的功能

设置路径：Tools -> External Tools

集成 phpcbf

  • Program是你的 PHP 根目录下的文件，windows 是 .bat 文件
  • Arguments是--standard=PSR2 $FileDir$/$FileName$，记得指定代码标准
  • Working directory是$ProjectFileDir$，也可以直接填

下面的 Open console for tool output 是指打印检测的信息到控制台上，phpcs检测的我们要看，phpcbf就不用了，所以不用勾选

怎么使用呢？

工具栏的 Tools->External Tools 就可以看到我们刚才添加的两个小工具，直接点击就可以用了

点击操作很麻烦, 那就加一个 快捷键 吧:

在 Settings -> Keymap -> External Tools -> phpcbf 中进行添加快捷键操作

退出移动版