PhpStorm 配置 格式化代码工具 PHP-cs-fixer

PhpStorm 配置 php-cs-fixer
良好的代码规范可以提高代码可读性，团队沟通维护成本。最推荐大家遵守的是 php-fig（PHP Framework Interop Group） 组织定义的 PSR-1 、 PSR-2 两个。不了解的同学可以先通过连接点击过去阅读下。
这篇文章主要介绍下 php-cs-fixer 格式化代码工具，让你的代码符合规范。
php-cs-fixer (PHP Coding Standards Fixer) 目前已经有发展到 v2 版本，所以我们使用最新的版本，
官方现在有两个版本 v1 和 v2 ，其中 v1 需要 php 5.3.6 版本以上， v2 需要 php 5.6 版本以上。
安装
安装方式有很多种，可以直接下载.phar 文件，也可以通过 composer 的方式进行全局安装。更多安装方法可以参考
FriendsOfPHP/PHP-CS-Fixer
安装方式
这里我使用的是 Windos7 环境，所以我使用的是 Locally 模式，也就是直接下载了.phar 文件

将下载的 php-cs-fixer-v2.phar 文件重命名为 php-cs-fixer.phar 然后我放到了 E:\DevTools\php-cs-fixer.phar。你可以放到你的任意目录，但请记住这个地址，后面配置 phpstorm 的时候会用到。
配置
打开 phpstorm 设置项，依次 Tools→External Tools, 点击加号 (+)

Program: 填写你的 PHP 可执行文件路径
Arguments: 填写刚刚上面让你记住的 php-cs-fixer.phar 的路径地址，我的配置如下
E:\DevTools\php-cs-fixer.phar

fix

--rules=@PSR1,@PSR2

–verbose

$FileDir$$FileName$

Working directory: $ProjectFileDir$
最后你要进行格式化操作，只要设置下快捷键就可以了。具体设置如下，你可以设置你想设置的快捷键。

尽管上面这样以后，不出意外就可以按 Ctrl+Alt+Shift+L 使用了。但是如果我们想在格式化之前看看哪些代码不规范要如何操作呢？
从上面的截图也可以看到，我多配置了一个 php-cs-fixer-diff 的快捷键，这个快捷键就是执行后可以看到哪些代码将被转换。配置和上面的类似，只是在 Arguments 这个不同。如下
E:\DevTools\php-cs-fixer.phar

fix

--rules=@PSR1,@PSR2

–verbose

–dry-run

–diff

–using-cache=no

$FileDir$$FileName$

可以看出基本上相同，主要就是增加了 —dry-run 和 —diff 参数，至于 —using-cache 可加可不加。最后依然配置一个快捷键 (alt+f)。执行效果如下

可以看到，将要被转换的代码都已经标识出来了，类似于 git diff 后的效果。
配置文件方式配置 rules
上面我们把格式化规则已经写在了命令行后面，这样其实已经可以达到我们的预期了。但是 php-cs-fixer 还支持将规则等配置写入一个配置文件，默认为.php_cs。你可以使用 —config 来指定你的配置文件。
总的来说，使用配置文件的方式最大的一个好处是可以团队成员共用。如果你的团队制定了代码规范，那么把配置文件提交到版本控制大家可以共用一套代码规范，而不需要每个人都要配置一遍。但是最基本的 php-cs-fixer 的安装和 ide 集成工作还是要做的。
首先我们删除 ide 里配置的规则。将 Arguments 配置中的 —rules 选项删除，最终的结果类似如下
E:\DevTools\php-cs-fixer.phar

fix
–allow-risky=yes

–verbose

$FileDir$$FileName$

然后我们在当前项目下新建一个.php_cs 文件，这个文件其实是一段 PHP 代码。
<?php

/**

• Created by PhpStorm.

• User:

• Date:

• Time:

• /

$finder = PhpCsFixer\Finder::create()

->files()

->name('*.php')

->exclude('vendor')

->in(__DIR__)

->ignoreDotFiles(true)

->ignoreVCS(true);

$fixers = array(

'@PSR2'                                      => true,

'single_quote'                               => true, //简单字符串应该使用单引号代替双引号；

'no_unused_imports'                          => true, //删除没用到的use

'no_singleline_whitespace_before_semicolons' => true, //禁止只有单行空格和分号的写法；

'self_accessor'                              => true, //在当前类中使用 self 代替类名；

'no_empty_statement'                         => true, //多余的分号

'no_extra_consecutive_blank_lines'           => true, //多余空白行

'no_blank_lines_after_class_opening'         => true, //类开始标签后不应该有空白行；

'include'                                    => true, //include 和文件路径之间需要有一个空格，文件路径不需要用括号括起来；

'no_trailing_comma_in_list_call'             => true, //删除 list 语句中多余的逗号；

'no_leading_namespace_whitespace'            => true, //命名空间前面不应该有空格；

'standardize_not_equals'                     => true, //使用 <> 代替 !=；

'binary_operator_spaces'                     => ['default' => 'align_single_space'] //等号对齐、数字箭头符号对齐

);

return PhpCsFixer\Config::create()

->setRules($fixers)

->setFinder($finder)

->setUsingCache(false);

最后就可以执行你上面设置的快捷键来格式化代码了。
最终配置

配置选项中文说明
php-cs-fixer (PHP Coding Standards Fixer) | Scholer’s Blog

本作品采用《CC 协议》，转载必须注明作者和本文链接