PHP7.3php-cs-fixer v3 自定义规则,忽略指定目录文件格式化配置

落芳大大_2837

落芳大大_2837

2026-10-09

449人浏览

原创

php cs fixer v3 不支持按代码块或单行跳过规则,仅可通过配置文件中的 finder 设置 exclude 或 notpath 精确排除目录或文件;exclude 用于忽略整个目录(如 legacy、generated),notpath 用于忽略特定文件(如 bitwisehelper.php),路径均相对于 in() 指定的根目录,且在 --dry-run 模式下同样生效。

php7.3php-cs-fixer v3 自定义规则,忽略指定目录文件格式化配置

PHP CS Fixer v3 在 PHP 7.3 环境下支持通过配置文件灵活排除指定目录或文件,但不支持按代码块或某几行临时跳过规则——所有匹配的文件内容都会被统一处理。唯一可靠的方式是在 `.php-cs-fixer.php`(或 `.php-cs-fixer.dist.php`)中,用 Finder 配置精确控制作用范围。

配置 exclude 排除整个目录

适用于长期不需要格式化的遗留模块、第三方适配层或生成代码目录(如 vendor、Legacy、public/assets):

  • 在 setFinder() 中调用 exclude(),传入相对路径字符串或字符串数组
  • 路径是相对于 in() 指定根目录的,不是项目根目录
  • 排除后,该目录及其子目录下的所有 PHP 文件完全不参与扫描和修复

示例配置:

btpanel phpsite 宝塔面板PHP网站
btpanel phpsite 宝塔面板PHP网站

宝塔面板 PHP 网站管理:站点创建、删除、启停、PHP 版本切换、域名管理、SSL证书管理、伪静态管理、数据库管理

下载
use PhpCsFixer\Config;
use PhpCsFixer\Finder;

return (new Config())
  ->setRules(['@PSR12' => true, 'array_syntax' => ['syntax' => 'short']])
  ->setFinder(
    (new Finder())
      ->in(__DIR__ . '/src')
      ->exclude(['Legacy', 'Generated']) // ← 忽略 src/Legacy 和 src/Generated
  );

使用 notPath 精确忽略单个文件

适合个别因特殊语法(如 DSL、协议解析、多行数学表达式)难以自动格式化、又不便重构的文件:

  • notPath() 接收文件路径(相对于 in() 根目录),支持通配符 *
  • 可链式多次调用,排除多个文件
  • 比 exclude() 更细粒度,不影响同目录其他文件

示例:

->setFinder(
  (new Finder())
    ->in(__DIR__ . '/src')
    ->notPath('Utils/BitwiseHelper.php')
    ->notPath('Contracts/*Interface.php')
)

注意事项与常见问题

这些排除方式在 --dry-run 或 --diff 模式下同样生效;但要注意:

  • exclude() 和 notPath() 是路径过滤,不是规则开关——被排除的文件不会触发任何规则检查
  • PHP 7.3 支持 v3.x 全系列(v3.0–v3.54+),但需确保安装时未启用 --ignore-platform-reqs 导致依赖不全
  • 若排除后仍报错,检查 Finder 的 in() 路径是否拼写正确、是否存在符号链接未被识别等情况
  • 不要尝试用注释(如 // @phpcs:ignore)绕过——PHP CS Fixer 完全忽略此类标记

php免费学习视频:立即使用
踏上前端学习之旅,开启通往精通之路!从前端基础到项目实战,循序渐进,一步一个脚印,迈向巅峰!

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2023.09.01

10304

6

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

6081

5

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

2095

5

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

2023.10.23

3828

4

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

2023.10.23

4534

6

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.03

3551

9

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.09

5057

8

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.13

3962

8

sprintf函数用法详解
sprintf函数用法详解

sprintf函数的用法:1、格式化字符串;2、指定输出宽度和精度;3、返回值。更多关于sprintf函数用法详解的内容,大家可以阅读下面的文章。

2023.11.27

11922

4

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
墨刀帮助中心
墨刀帮助中心

共0课时 | 0人学习

MyEclipse学习中心
MyEclipse学习中心

共0课时 | 0人学习

Apache Subversion 官方手册
Apache Subversion 官方手册

共0课时 | 0人学习