0

0

如何使用Composer管理PHP-CS-Fixer并自动修复代码风格?

尼克

尼克

发布时间:2025-12-22 15:27:27

|

267人浏览过

|

来源于php中文网

原创

推荐本地安装 PHP-CS-Fixer 为开发依赖,通过 composer require --dev friendsofphp/php-cs-fixer 添加,配置 .php-cs-fixer.php 规则集,定义 scripts 实现一键修复(cs:fix)与校验(cs:check),并结合 Git pre-commit 钩子自动处理暂存文件。

如何使用composer管理php-cs-fixer并自动修复代码风格?

直接用 Composer 安装 PHP-CS-Fixer 并配置为项目级开发依赖,再通过脚本或 IDE 集成实现自动修复,是最稳妥、可复现的方式。

安装 PHP-CS-Fixer 到项目中

推荐以 本地安装(而非全局)方式引入,避免版本冲突,也便于团队统一规范:

  • 运行 composer require --dev friendsofphp/php-cs-fixer,它会被添加到 require-dev
  • 安装后,可执行路径为 vendor/bin/php-cs-fixer(Linux/macOS)或 vendor\bin\php-cs-fixer.bat(Windows)
  • 检查是否可用:./vendor/bin/php-cs-fixer --version

配置规则集(.php-cs-fixer.php)

在项目根目录创建 .php-cs-fixer.php 文件,定义你想要的代码风格。不写配置则使用默认规则,但建议显式声明:

  • 常见写法是返回一个 PhpCsFixer\Config 实例,例如基于 PSR-12 或 Symfony 标准扩展
  • 示例最小配置:
    $config = new PhpCsFixer\Config();
    return $config->setRules([
        '@PSR12' => true,
        'array_syntax' => ['syntax' => 'short'],
        'no_unused_imports' => true,
    ])->setFinder(
        PhpCsFixer\Finder::create()
            ->in(['src', 'tests'])
            ->name('*.php')
            ->notName('index.php')
            ->ignoreDotFiles(true)
            ->ignoreVCS(true)
    );
  • 规则名可通过 ./vendor/bin/php-cs-fixer describe [rule-name] 查看说明

一键修复与校验命令

把常用操作写进 composer.jsonscripts 段,提升执行效率和一致性:

ghiblitattoo
ghiblitattoo

用AI创造独特的吉卜力纹身

下载

立即学习PHP免费学习笔记(深入)”;

  • 添加如下脚本:
    "scripts": {
        "cs:fix": "php-cs-fixer fix --verbose",
        "cs:check": "php-cs-fixer fix --dry-run --diff"
    }
  • 运行 composer cs:fix 自动修复所有匹配文件
  • 运行 composer cs:check 仅检查不修改,适合 CI 流程中做风格门禁
  • --path-mode=intersection 可限制只处理 Git 变更文件(配合 pre-commit 使用)

接入 Git 提交前自动修复(pre-commit)

用 husky-like 工具(如 Lefthook 或原生 Git hooks)触发修复,避免不合规代码入库:

  • 以 Lefthook 为例,在 lefthook.yml 中添加:
    pre-commit:
      commands:
        php-cs-fixer:
          run: composer cs:fix -- --path-mode=intersection {staged_files}
  • 这样每次 git add 后提交,只会修复本次暂存区中的 PHP 文件
  • 注意:确保 composer cs:fix 命令能正确识别并修改文件,且不中断提交流程(失败时可设 fail_fast: false

相关专题

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

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

2816

2023.09.01

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

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

1691

2023.10.11

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

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

1549

2023.10.11

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

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

1036

2023.10.23

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

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

1485

2023.10.23

html怎么上传
html怎么上传

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

1256

2023.11.03

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

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

1589

2023.11.09

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

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

1307

2023.11.13

c++空格相关教程合集
c++空格相关教程合集

本专题整合了c++空格相关教程,阅读专题下面的文章了解更多详细内容。

0

2026.01.23

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PHP课程
PHP课程

共137课时 | 9.2万人学习

JavaScript ES5基础线上课程教学
JavaScript ES5基础线上课程教学

共6课时 | 10.1万人学习

PHP新手语法线上课程教学
PHP新手语法线上课程教学

共13课时 | 0.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号