0

0

如何在 Composer 项目中使用 php-cs-fixer 并在提交前自动格式化代码?

裘德小鎮的故事

裘德小鎮的故事

发布时间:2025-12-14 15:32:54

|

306人浏览过

|

来源于php中文网

原创

Composer 项目集成 php-cs-fixer 并实现提交前自动格式化需三步:本地安装为 dev 依赖、配置 .php-cs-fixer.php 规则文件、绑定 Git 钩子;推荐本地安装确保团队一致性,禁用全局安装以防版本冲突。

如何在 composer 项目中使用 php-cs-fixer 并在提交前自动格式化代码?

在 Composer 项目中集成 php-cs-fixer 并实现提交前自动格式化,核心是三步:安装工具、配置规则、绑定 Git 钩子。重点不是“能不能做”,而是让流程稳定、可复现、不干扰日常开发。

安装 php-cs-fixer 到项目本地

推荐作为 dev 依赖安装,避免全局环境差异影响团队一致性:

  • 运行 composer require --dev friendsofphp/php-cs-fixer
  • 安装后命令路径为 vendor/bin/php-cs-fixer(Linux/macOS)或 vendor\bin\php-cs-fixer.bat(Windows)
  • 不要用全局安装(如 composer global require),否则不同项目可能因版本冲突导致格式结果不一致

定义项目专属的 .php-cs-fixer.php 配置文件

在项目根目录新建 .php-cs-fixer.php,明确指定规则和作用范围:

  • 基础示例(适配 PSR-12 + PHP 8+):
setRules([
        '@PSR12' => true,
        'array_syntax' => ['syntax' => 'short'],
        'declare_strict_types' => true,
        'no_unused_imports' => true,
        'ordered_imports' => true,
    ])
    ->setFinder(PhpCsFixer\Finder::create()
        ->in(['src', 'tests'])
        ->name('*.php')
        ->notName('*.blade.php')
        ->ignoreDotFiles(true)
        ->ignoreVCS(true)
    )
    ->setCacheFile('.php-cs-fixer.cache');
  • 务必设置 setCacheFile:加速后续运行,尤其对大项目明显
  • ->in([...]) 明确限定目录,避免误处理 vendor 或生成文件
  • 首次运行可加 --dry-run --diff 参数预览改动,确认无意外变更

用 Composer 脚本 + Git pre-commit 钩子自动执行

不依赖第三方钩子管理器(如 Husky),用最简方式落地:

CPWEB企业网站管理系统2.2 Beta
CPWEB企业网站管理系统2.2 Beta

CPWEB企业网站管理系统(以下称CPWEB)是一个基于PHP+Mysql架构的企业网站管理系统。CPWEB 采用模块化方式开发,功能强大灵活易于扩展,并且完全开放源代码,面向大中型站点提供重量级企业网站建设解决方案。CPWEB企业网站管理系统 2.2 Beta 测试版本,仅供测试,不建议使用在正式项目中,否则发生任何的后果自负。

下载

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

  • composer.json"scripts" 中添加:
"scripts": {
  "cs-fix": "php-cs-fixer fix --verbose",
  "cs-check": "php-cs-fixer fix --dry-run --using-cache=no"
}
  • 然后在项目根目录创建 .git/hooks/pre-commit 文件(Linux/macOS):
#!/bin/sh
echo "Running PHP code style check..."
if ! composer cs-check; then
  echo "❌ Code style violations found. Run 'composer cs-fix' to fix them."
  exit 1
fi
  • 给钩子加执行权限:chmod +x .git/hooks/pre-commit
  • Windows 用户可用 pre-commit.bat(内容类似,用 call composer cs-check
  • 这个钩子只做检查(--dry-run),失败则中断提交——更安全,避免自动修改引入意外

补充建议:CI 和团队协同

本地钩子只是第一道防线,还需配套保障:

  • 在 GitHub Actions / GitLab CI 中加入 composer cs-check 步骤,防止绕过本地钩子
  • .php-cs-fixer.phpcomposer.json 中的脚本纳入版本管理,确保所有人用同一套规则
  • 编辑器(如 VS Code)可装 PHP CS Fixer 插件并设为“保存时格式化”,但仅作辅助——以 pre-commit 钩子为准

基本上就这些。不复杂但容易忽略的是缓存文件路径和 Finder 范围,设错会导致慢或漏检。跑通一次,之后每次提交都默默守着代码风格。

热门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

github中文官网入口 github中文版官网网页进入
github中文官网入口 github中文版官网网页进入

github中文官网入口https://docs.github.com/zh/get-started,GitHub 是一种基于云的平台,可在其中存储、共享并与他人一起编写代码。 通过将代码存储在GitHub 上的“存储库”中,你可以: “展示或共享”你的工作。 持续“跟踪和管理”对代码的更改。

882

2026.01.21

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

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

724

2023.07.05

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

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

158

2026.01.28

热门下载

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

精品课程

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

共21课时 | 3.1万人学习

Go语言实战之 GraphQL
Go语言实战之 GraphQL

共10课时 | 0.8万人学习

Bootstrap4.x---十天精品课堂
Bootstrap4.x---十天精品课堂

共22课时 | 1.7万人学习

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

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