如何配置PHP-CS-Fixer规则移除多行数组末尾的尾随逗号？

可以直接实现该需求，不需要修改内置规则的校验逻辑，PHP-CS-Fixer 已经提供了对应能力。

配置逻辑说明 #

你提到的trailing_comma_in_multiline规则作用是强制要求多行结构（包含数组、参数列表等）添加尾随逗号，和你的需求正好相反，不需要反转它的逻辑，只需要：

1. 关闭trailing_comma_in_multiline规则，避免规则冲突
2. 开启内置的no_trailing_comma_in_multiline规则，该规则的校验逻辑完全匹配你的要求：
   • 无尾随逗号的多行数组判定为合规
   • 存在尾随逗号的多行数组会在检查时报错，执行fix命令时会自动移除多余的尾随逗号

具体配置示例 #

在你的PHP-CS-Fixer配置文件（一般是项目根目录的.php-cs-fixer.dist.php）中调整rules配置即可：

<?php

$finder = PhpCsFixer\Finder::create()
    ->in(__DIR__.'/src') // 替换成你需要校验的目录
;

return (new PhpCsFixer\Config())
    ->setRules([
        // 关闭强制添加尾随逗号的规则
        'trailing_comma_in_multiline' => false,
        // 开启禁止多行结构尾随逗号的规则
        'no_trailing_comma_in_multiline' => true,
        // 其余你需要的规范规则按原有配置保留即可
    ])
    ->setFinder($finder)
;

校验效果说明 #

• 以下代码会判定为合规，检查通过：

$data = [
    'First item',
    'Second item'
];

• 以下代码会判定为不合规，检查时抛出错误，执行修复后会自动删除最后一个元素后的逗号：

$data = [
    'First item',
    'Second item',
];

注意：no_trailing_comma_in_multiline为PHP-CS-Fixer 3.2及以上版本内置规则，如果你的项目使用的版本低于该版本，先升级到3.2+即可直接使用，无需自定义开发规则。

内容的提问来源于stack exchange，提问作者trckster