0

0

如何通过Composer Scripts自动格式化PHP代码_集成PHP-CS-Fixer或Pint到你的开发流程

冰火之心

冰火之心

发布时间:2026-01-02 14:43:53

|

983人浏览过

|

来源于php中文网

原创

通过Composer Scripts集成PHP-CS-Fixer或Pint可自动统一代码风格,提升团队协作效率。首先将工具作为开发依赖安装,PHP-CS-Fixer需配置.php-cs-fixer.php文件定义规则,Pint则可直接使用内置preset或通过pint.json定制;接着在composer.json中添加"format"和"check-style"等脚本命令,实现代码格式化与检查;最后结合Git钩子(如pre-commit)调用composer run pre-commit,实现提交前自动修复,确保代码库风格一致,适用于CI流程与团队协作场景。

如何通过composer scripts自动格式化php代码_集成php-cs-fixer或pint到你的开发流程

在现代PHP开发中,保持代码风格一致是团队协作和项目维护的重要环节。手动格式化不仅耗时还容易出错,通过Composer Scripts集成PHP-CS-Fixer或Pint,可以在开发流程中自动完成代码规范修复,提升效率与一致性。

使用Composer Scripts自动化代码格式化

Composer不仅用于依赖管理,其Scripts功能还能绑定自定义命令,在特定事件触发时执行。你可以将代码格式化工具作为脚本注册进去,比如在提交前、测试前或本地开发时自动运行。

步骤简述:

  • 安装PHP-CS-Fixer或Pint作为开发依赖
  • 配置规则文件(如.php-cs-fixer.phppint.json
  • composer.json中添加自定义scripts
  • 按需运行或结合Git钩子自动化执行

集成PHP-CS-Fixer

PHP-CS-Fixer是广泛使用的代码风格修复工具,支持PSR标准及大量自定义规则。

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

安装方式:

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

在项目根目录创建.php-cs-fixer.php配置文件

<?php
<p>$finder = PhpCsFixer\Finder::create()
->in(<strong>DIR</strong> . '/src')
->in(<strong>DIR</strong> . '/tests');</p><p>return PhpCsFixer\Config::create()
->setRules([
'@PSR12' => true,
'array_syntax' => ['syntax' => 'short'],
'ordered_imports' => true,
])
->setFinder($finder);

然后在composer.json中添加脚本:

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

现在可以通过以下命令格式化代码:

composer format       # 修复代码
composer check-style  # 检查是否符合规范(常用于CI)

集成Pint(Laravel官方推荐)

Pint是Laravel推出的轻量级代码美化工具,基于PHP-CS-Fixer核心,但无需额外配置即可开箱使用,更适合简单项目或Laravel生态。

Giiso写作机器人
Giiso写作机器人

Giiso写作机器人,让写作更简单

下载

安装Pint:

composer require --dev laravel/pint

可选:创建pint.json进行定制:

{
    "preset": "psr12",
    "rules": {
        "array_syntax": {"syntax": "short"},
        "ordered_imports": true
    },
    "paths": [
        "src/",
        "tests/"
    ]
}

添加Composer脚本:

"scripts": {
    "format": "pint",
    "check": "pint --test"
}

使用方式:

composer format  # 格式化所有指定文件
composer check   # 检查格式问题(CI中使用)

结合Git钩子实现自动格式化

为了进一步自动化,可以利用工具如composer-scriptssimple-git-hooks在提交代码前自动格式化。

例如使用 GrumPHP 或更轻量的 spatie/composer-backup 配合钩子管理。

一个简单的方案是在composer.json中使用脚本钩子:

"scripts": {
    "pre-commit": "composer format",
    "test": [
        "composer check-style",
        "// 其他测试命令"
    ]
}

再配合git hooks工具(如lefthookhusky-php),在pre-commit阶段调用composer run pre-commit,确保每次提交的代码都经过格式化。

基本上就这些。通过Composer Scripts集成格式化工具,既能统一团队编码风格,又能减少人工干预,让开发更专注业务逻辑。选择PHP-CS-Fixer还是Pint,取决于项目复杂度和团队偏好,两者都能很好地融入现代PHP工作流。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

更多
laravel组件介绍
laravel组件介绍

laravel 提供了丰富的组件,包括身份验证、模板引擎、缓存、命令行工具、数据库交互、对象关系映射器、事件处理、文件操作、电子邮件发送、队列管理和数据验证。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

340

2024.04.09

laravel中间件介绍
laravel中间件介绍

laravel 中间件分为五种类型:全局、路由、组、终止和自定。想了解更多laravel中间件的相关内容,可以阅读本专题下面的文章。

294

2024.04.09

laravel使用的设计模式有哪些
laravel使用的设计模式有哪些

laravel使用的设计模式有:1、单例模式;2、工厂方法模式;3、建造者模式;4、适配器模式;5、装饰器模式;6、策略模式;7、观察者模式。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

774

2024.04.09

thinkphp和laravel哪个简单
thinkphp和laravel哪个简单

对于初学者来说,laravel 的入门门槛较低,更易上手,原因包括:1. 更简单的安装和配置;2. 丰富的文档和社区支持;3. 简洁易懂的语法和 api;4. 平缓的学习曲线。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

386

2024.04.10

laravel入门教程
laravel入门教程

本专题整合了laravel入门教程,想了解更多详细内容,请阅读专题下面的文章。

146

2025.08.05

laravel实战教程
laravel实战教程

本专题整合了laravel实战教程,阅读专题下面的文章了解更多详细内容。

85

2025.08.05

laravel面试题
laravel面试题

本专题整合了laravel面试题相关内容,阅读专题下面的文章了解更多详细内容。

81

2025.08.05

PHP高性能API设计与Laravel服务架构实践
PHP高性能API设计与Laravel服务架构实践

本专题围绕 PHP 在现代 Web 后端开发中的高性能实践展开,重点讲解基于 Laravel 框架构建可扩展 API 服务的核心方法。内容涵盖路由与中间件机制、服务容器与依赖注入、接口版本管理、缓存策略设计以及队列异步处理方案。同时结合高并发场景,深入分析性能瓶颈定位与优化思路,帮助开发者构建稳定、高效、易维护的 PHP 后端服务体系。

659

2026.03.04

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

49

2026.03.13

热门下载

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

精品课程

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

共137课时 | 13.6万人学习

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

共6课时 | 11.3万人学习

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

共13课时 | 1.0万人学习

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

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