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 段,提升执行效率和一致性:

知识画家
知识画家

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

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

通义千问
通义千问

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

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

更多
PHP Symfony框架
PHP Symfony框架

本专题专注于PHP主流框架Symfony的学习与应用,系统讲解路由与控制器、依赖注入、ORM数据操作、模板引擎、表单与验证、安全认证及API开发等核心内容。通过企业管理系统、内容管理平台与电商后台等实战案例,帮助学员全面掌握Symfony在企业级应用开发中的实践技能。

78

2025.09.11

composer是什么插件
composer是什么插件

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

154

2023.12.25

json数据格式
json数据格式

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

420

2023.08.07

json是什么
json是什么

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

536

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

C++ 设计模式与软件架构
C++ 设计模式与软件架构

本专题深入讲解 C++ 中的常见设计模式与架构优化,包括单例模式、工厂模式、观察者模式、策略模式、命令模式等,结合实际案例展示如何在 C++ 项目中应用这些模式提升代码可维护性与扩展性。通过案例分析,帮助开发者掌握 如何运用设计模式构建高质量的软件架构,提升系统的灵活性与可扩展性。

8

2026.01.30

热门下载

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

精品课程

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

共137课时 | 10.3万人学习

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

共6课时 | 11.2万人学习

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

共13课时 | 0.9万人学习

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

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