PHP-CS-Fixer 代码格式化工具安装指南

PHP-CS-Fixer 代码格式化工具安装指南

PHP-CS-Fixer A tool to automatically fix PHP Coding Standards issues 项目地址: https://gitcode.com/gh_mirrors/ph/PHP-CS-Fixer

前言

PHP-CS-Fixer 是一个强大的 PHP 代码格式化工具，能够自动修复代码风格问题，确保团队协作时保持一致的代码风格。本文将详细介绍 PHP-CS-Fixer 的各种安装方式，帮助开发者选择最适合自己项目环境的安装方法。

系统要求

PHP-CS-Fixer 需要 PHP 7.4 或更高版本才能运行。建议在开发环境中使用与生产环境相同的 PHP 版本，以避免潜在的兼容性问题。

推荐安装方式

作为项目依赖安装（推荐）

最佳实践是将 PHP-CS-Fixer 作为开发依赖安装到每个项目中，而不是全局安装。这样做有以下优势：

1. 确保团队成员使用项目指定的版本
2. 避免不同项目间的版本冲突
3. 便于版本控制和持续集成

使用 Composer 安装

Composer 是 PHP 生态中最常用的依赖管理工具，也是安装 PHP-CS-Fixer 的首选方式。

全新安装：

composer require --dev friendsofphp/php-cs-fixer
# 或者当遇到依赖冲突时
composer require --dev php-cs-fixer/shim

升级版本：

composer upgrade friendsofphp/php-cs-fixer
# 或者
composer upgrade php-cs-fixer/shim

容器化安装

Docker 方式

对于使用 Docker 的开发环境，可以直接使用预构建的 Docker 镜像：

docker run -it --rm -v $(pwd):/code ghcr.io/php-cs-fixer/php-cs-fixer:${FIXER_VERSION:-3-php8.3} fix src

镜像标签说明：

• 3.66.1-php7.4：指定 PHP-CS-Fixer 3.66.1 和 PHP 7.4
• 3.66-php8.0：指定 PHP-CS-Fixer 3.66.x 系列和 PHP 8.0
• 3-php8.3：指定 PHP-CS-Fixer 3.x 系列和 PHP 8.3

持续集成配置

GitHub Actions 集成

- name: PHP-CS-Fixer
  uses: docker://ghcr.io/php-cs-fixer/php-cs-fixer:3-php8.3
    with:
      args: check
      # 如果仓库没有在.php-cs-fixer[.dist].php中配置路径，使用`check .`

Gitlab-CI 集成

php-cs-fixer:
  image: ghcr.io/php-cs-fixer/php-cs-fixer:${FIXER_VERSION:-3-php8.3}
  script:
    php-cs-fixer check # --format gitlab ## 如果不使用PHP_CS_FIXER_FUTURE_MODE或v4+，指定格式
    # 如果仓库没有在.php-cs-fixer[.dist].php中配置路径，使用`check .`

其他安装方式

PHIVE 安装

PHIVE 是 PHP 应用程序的包管理器，也可以用来安装 PHP-CS-Fixer。

全新安装：

phive install php-cs-fixer

升级：

phive update php-cs-fixer

Homebrew 全局安装（不推荐）

虽然不推荐全局安装，但 macOS 用户可以通过 Homebrew 安装：

全新安装：

brew install php-cs-fixer

升级：

brew upgrade php-cs-fixer

手动下载二进制文件

可以直接下载 PHP-CS-Fixer 的 PHAR 文件：

全新安装：

wget https://cs.symfony.com/download/php-cs-fixer-v3.phar -O php-cs-fixer
# 或者
curl -L https://cs.symfony.com/download/php-cs-fixer-v3.phar -o php-cs-fixer

指定版本下载：

wget https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/releases/download/v3.66.0/php-cs-fixer.phar -O php-cs-fixer
# 或者
curl -L https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/releases/download/v3.66.0/php-cs-fixer.phar -o php-cs-fixer

设置可执行权限并移动：

sudo chmod a+x php-cs-fixer
sudo mv php-cs-fixer /usr/local/bin/php-cs-fixer

升级：

sudo php-cs-fixer self-update

安装建议

1. 团队项目：强烈推荐使用 Composer 作为项目依赖安装
2. CI/CD 环境：使用 Docker 镜像最为方便
3. 个人开发：如果只是临时使用，可以考虑手动下载 PHAR 文件
4. macOS 用户：Homebrew 安装简单但不推荐用于正式项目

后续步骤

安装完成后，建议：

1. 在项目根目录创建 .php-cs-fixer.dist.php 配置文件
2. 将代码格式化步骤加入开发工作流
3. 在提交前或 CI 流程中加入代码风格检查

通过以上安装方式，你可以轻松将 PHP-CS-Fixer 集成到开发流程中，确保代码风格的一致性。

PHP-CS-Fixer A tool to automatically fix PHP Coding Standards issues 项目地址: https://gitcode.com/gh_mirrors/ph/PHP-CS-Fixer