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 中添加自定义脚本。

Toolplay
Toolplay

一站式AI应用聚合生成平台

下载

修改 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 简单高效,适合团队协作和持续集成场景。只要配置一次,所有成员都能遵循统一的代码风格。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
composer是什么插件
composer是什么插件

Composer是一个PHP的依赖管理工具,它可以帮助开发者在PHP项目中管理和安装依赖的库文件。Composer通过一个中央化的存储库来管理所有的依赖库文件,这个存储库包含了各种可用的依赖库的信息和版本信息。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

154

2023.12.25

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

419

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

535

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

311

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

77

2025.09.10

require的用法
require的用法

require的用法有引入模块、导入类或方法、执行特定任务。想了解更多require的相关内容,可以阅读本专题下面的文章。

466

2023.11.27

自建git服务器
自建git服务器

git服务器是目前流行的分布式版本控制系统之一,可以让多人协同开发同一个项目。本专题为大家提供自建git服务器相关的各种文章、以及下载和课程。

724

2023.07.05

git和svn的区别
git和svn的区别

git和svn的区别:1、定义不同;2、模型类型不同;3、存储单元不同;4、是否拥有全局版本号;5、内容完整性不同;6、版本库不同;7、克隆目录速度不同;8、分支不同。php中文网为大家带来了git和svn的相关知识、以及相关文章等内容。

554

2023.07.06

俄罗斯Yandex引擎入口
俄罗斯Yandex引擎入口

2026年俄罗斯Yandex搜索引擎最新入口汇总,涵盖免登录、多语言支持、无广告视频播放及本地化服务等核心功能。阅读专题下面的文章了解更多详细内容。

391

2026.01.28

热门下载

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

精品课程

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

共86课时 | 3.4万人学习

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

共28课时 | 2.5万人学习

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

共93课时 | 6.9万人学习

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

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