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

通过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钩子实现提交前自动检查，确保代码规范一致性。

在项目中保持代码风格统一非常重要，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免费学习笔记（深入）”；

示例配置：

<?php

return PhpCsFixer\Config::create()
    ->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 中添加自定义脚本。

集简云

软件集成平台，快速建立企业自动化与智能化

22

查看详情

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

以上就是composer怎么集成php-cs-fixer进行代码格式化_教你在composer中集成php-cs-fixer的详细内容，更多请关注php中文网其它相关文章！