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

工具简介

PHP-CS-Fixer 是一个强大的 PHP 代码格式化工具，能够自动修复代码风格问题，确保代码遵循统一的编码规范。它支持 PSR-1、PSR-2、PSR-12 等多种编码标准，并能自定义规则集。

系统要求

在安装 PHP-CS-Fixer 之前，请确保您的系统满足以下最低要求：

• PHP 7.4 或更高版本
• 对于某些高级功能，建议使用 PHP 8.0+

安装方法

本地安装方式

方法一：直接下载 PHAR 文件

1. 下载最新版的 PHP-CS-Fixer PHAR 文件
2. 将文件保存在您选择的目录中
3. 通过命令行运行：php php-cs-fixer.phar

方法二：使用 PHIVE 安装

PHIVE 是一个 PHAR 包管理器，可以安全地安装和管理 PHP 工具：

phive install php-cs-fixer

如需全局安装，添加 --global 参数。

全局安装方式

方法一：手动安装

1. 使用 wget 或 curl 下载最新版本：

   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
   

2. 设置可执行权限：

   chmod a+x php-cs-fixer
   

3. 移动到系统路径：

   sudo mv php-cs-fixer /usr/local/bin/php-cs-fixer
   

安装后，可直接在终端使用 php-cs-fixer 命令。

方法二：使用 Composer 安装

1. 全局安装：

   composer global require friendsofphp/php-cs-fixer
   

2. 将 Composer 全局 bin 目录添加到 PATH 环境变量：

   export PATH="$PATH:$HOME/.composer/vendor/bin"
   

方法三：使用 Homebrew 安装（macOS）

brew install php-cs-fixer

CI/CD 集成

GitHub Actions 集成

在 GitHub Actions 工作流中使用 Docker 镜像：

- name: PHP-CS-Fixer
  uses: docker://ghcr.io/php-cs-fixer/php-cs-fixer:3-php8.3
  with:
    args: check

GitLab CI 集成

在 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 php-cs-fixer.phar self-update

全局手动安装更新：

sudo php-cs-fixer self-update

Composer 安装更新：

composer global update friendsofphp/php-cs-fixer

Homebrew 安装更新：

brew upgrade php-cs-fixer

PHIVE 安装更新：

phive update php-cs-fixer

使用建议

1. 对于个人项目，推荐使用 Composer 本地安装
2. 团队项目建议将 PHP-CS-Fixer 作为开发依赖添加到项目的 composer.json 中
3. 持续集成环境中使用 Docker 镜像可获得最佳性能和一致性

安装完成后，您可以运行 php-cs-fixer fix 命令开始格式化您的代码，或使用 php-cs-fixer list 查看所有可用命令。