php-cs-fixer，自动修正代码风格

小李世界的个人博客 / 2331 / 12 / 创建于 2年前 / 更新于 1年前 / 1 个改进

开始

最近在看 PHP 之道，看到代码风格指南章节中的 php-cs-fixer。

php-cs-fixer：它是能够自动帮你更改代码的风格。比如，写法改为 PHP 7 以上：

array() 更改为 []
isset($var) ? $var : null 更改为 $var ?? null;
等等

如果只需要自动格式化代码的，PhpStorm 可以开启这个：

233

接下来讲：如何开启「保存时，php-cs-fixer 自动更改代码风格」。

环境

PhpStorm
PHP 8

安装 php-cs-fixer

这边使用全局安装

composer global require friendsofphp/php-cs-fixer

参见 cs.symfony.com/doc/installation.ht...

在项目根路径下，新建文件：.php-cs-fixer.php，内容如下：

<?php

use PhpCsFixer\Config;
use PhpCsFixer\Finder;

$rules = [
    '@PHP80Migration' => true,

    'ordered_imports' => [
        'sort_algorithm' => 'alpha',
    ],
    'class_attributes_separation' => [
        'elements' => [
            'const' => 'one',
            'method' => 'one',
            'property' => 'one',
        ],
    ],
];

$finder = Finder::create()
    ->in([
        __DIR__.'/app',
        __DIR__.'/config',
        __DIR__.'/database',
        __DIR__.'/resources',
        __DIR__.'/routes',
        __DIR__.'/tests',
    ])
    ->name('*.php')
    ->notName('*.blade.php')
    ->ignoreDotFiles(true)
    ->ignoreVCS(true);

return (new Config())
    ->setFinder($finder)
    ->setRules($rules)
    ->setRiskyAllowed(true)
    ->setUsingCache(true);

然后在 PhpStorm 设置

233

名称：php-cs-fixer（自己喜欢的即可）
文件类型：PHP
程序：php-cs-fixer
参数：fix $FileDir$/$FileName$ -vvv –diff –config=.php-cs-fixer.php
要刷新的输出路径：$FileDir$/$FileName$
工作目录：$ProjectFileDir$
自动保存编辑的文件以触发观察程序：去掉默认的勾选
显示控制台：改为始终

讲下可能需要讲的

参数：
- 这边使用了调试模式 -vvv，显示的东西比较多，后面觉得烦可以去掉
- –diff 能够显示修改了什么，见文章下的《开启控制台显示后》
要刷新的输出路径：这个抄来的，目前效果还要验证
自动保存编辑的文件以触发观察程序：就是说，只要我们输入什么，它自动保存，不需要 command + s 进行保存就可以触发 php-cs-fixer。个人比较习惯手动保存，请根据喜好进行设置。
显示控制台：配合 –diff，显示修改了什么东西

效果举例

233

当我们进行保存时，它就会自动修正代码，在这里是原本就是 PHP 7 风格的代码：Null coalescing operator（空合并运算符），但是更进一步了，图二为 null 合并等于运算符（null_coalesce_equal_operator）：??=。

233

在控制台就显示以下：

开启控制台显示后

/Users/dogeow/.composer/vendor/bin/php-cs-fixer fix /Users/dogeow/PhpstormProjects/antic-api/routes/console.php -vvv --diff
Cannot load Xdebug - it was already loaded
PHP CS Fixer 3.3.2 Trinacria by Fabien Potencier and Dariusz Ruminski
Runtime: PHP 8.0.8
Loaded config default from "/Users/dogeow/PhpstormProjects/antic-api/.php-cs-fixer.php".
Using cache file ".php-cs-fixer.cache".
Paths from configuration file have been overridden by paths provided as command arguments.
F                                                                   1 / 1 (100%)
Legend: ?-unknown, I-invalid file syntax (file ignored), S-skipped (cached or empty file), .-no changes, F-fixed, E-error
   1) routes/console.php (assign_null_coalescing_to_coalesce_equal)
      ---------- begin diff ----------
--- /Users/dogeow/PhpstormProjects/antic-api/routes/console.php
+++ /Users/dogeow/PhpstormProjects/antic-api/routes/console.php
@@ -90,5 +90,5 @@
 });

 Artisan::command('test', function () {
-    $taskTag['name'] = $taskTag['name'] ?? 'url';
+    $taskTag['name'] ??= 'url';
 });

      ----------- end diff -----------


Fixed all files in 0.024 seconds, 14.000 MB memory used

进程已结束，退出代码为 0