0

0

composer怎么集成php-cs-fixer进行代码格式化_教你在composer中集成php-cs-fixer

裘德小鎮的故事

裘德小鎮的故事

发布时间:2025-10-31 21:01:02

|

344人浏览过

|

来源于php中文网

原创

通过Composer集成php-cs-fixer可统一PHP代码风格。1. 使用composer require --dev friendsofphp/php-cs-fixer安装工具;2. 创建.php-cs-fixer.php配置文件,设置PSR-12等规则;3. 在composer.json中添加cs:fix和cs:check快捷命令;4. 可选配置Git pre-commit钩子实现提交前自动检查,确保代码规范一致性。

composer怎么集成php-cs-fixer进行代码格式化_教你在composer中集成php-cs-fixer

在项目中保持代码风格统一非常重要,php-cs-fixer 是 PHP 社区广泛使用的代码格式化工具。通过 Composer 集成 php-cs-fixer,可以方便地在本地或 CI 环境中自动修复代码风格问题。下面教你如何在项目中通过 Composer 快速集成并使用 php-cs-fixer。

安装 php-cs-fixer 作为开发依赖

推荐将 php-cs-fixer 安装为项目的开发依赖,避免全局安装带来的版本冲突问题。

打开终端,进入项目根目录,运行以下命令:

composer require --dev friendsofphp/php-cs-fixer

这会将 php-cs-fixer 添加到 require-dev 中,并下载到 vendor/bin 目录下。

配置 php-cs-fixer 规则

在项目根目录创建一个配置文件 .php-cs-fixer.php,用于定义代码规范规则。

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

示例配置:

setRules([
        '@PSR12' => true,
        'array_syntax' => ['syntax' => 'short'],
        'ordered_imports' => true,
        'no_unused_imports' => true,
        'not_operator_with_successor_space' => true,
        'trailing_comma_in_multiline' => true,
    ])
    ->setFinder(
        PhpCsFixer\Finder::create()
            ->in(__DIR__ . '/src')
            ->in(__DIR__ . '/tests')
    );

这个配置启用了 PSR-12 标准,并设置了数组语法、导入排序等常用规则。你可以根据团队规范调整 rules 内容。

添加快捷命令到 composer.json

为了更方便地调用 php-cs-fixer,可以在 composer.json 中添加自定义脚本。

阿里云-虚拟数字人
阿里云-虚拟数字人

阿里云-虚拟数字人是什么? ...

下载

修改 composer.json 的 scripts 部分:

"scripts": {
    "cs:fix": "php-cs-fixer fix",
    "cs:check": "php-cs-fixer fix --dry-run --diff"
}

这样就可以使用以下命令:

  • composer cs:fix:自动修复代码格式
  • composer cs:check:检查但不修改,常用于 CI 流程

在 Git 提交前自动格式化(可选)

可以结合 Git hooks 实现提交前自动格式化。使用 composer install 后,配合 cppl 或手动设置 hook。

例如,在 .git/hooks/pre-commit 中添加:

#!/bin/sh
vendor/bin/php-cs-fixer fix --dry-run --quiet
if [ $? -ne 0 ]; then
  echo "代码格式不符合规范,请先运行 composer cs:fix"
  exit 1
fi

记得给 hook 文件添加执行权限:chmod +x .git/hooks/pre-commit

基本上就这些。通过 Composer 集成 php-cs-fixer 简单高效,适合团队协作和持续集成场景。只要配置一次,所有成员都能遵循统一的代码风格。

相关专题

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

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

2036

2023.09.01

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

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

1369

2023.10.11

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

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

1280

2023.10.11

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

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

949

2023.10.23

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

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

1406

2023.10.23

html怎么上传
html怎么上传

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

1231

2023.11.03

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

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

1440

2023.11.09

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

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

1303

2023.11.13

php源码安装教程大全
php源码安装教程大全

本专题整合了php源码安装教程,阅读专题下面的文章了解更多详细内容。

74

2025.12.31

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
第二十四期_PHP8编程
第二十四期_PHP8编程

共86课时 | 3.4万人学习

成为PHP架构师-自制PHP框架
成为PHP架构师-自制PHP框架

共28课时 | 2.4万人学习

第二十三期_PHP编程
第二十三期_PHP编程

共93课时 | 6.6万人学习

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

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