oskarstark/php-cs-fixer-ga

oskarstark/php-cs-fixer-ga 镜像文档

镜像概述和主要用途

oskarstark/php-cs-fixer-ga 是一个专为GitHub Action设计的Docker镜像，集成了PHP-CS-Fixer工具，用于在GitHub工作流中自动化执行PHP代码风格检查与修复。通过该镜像，开发者可在代码提交(push)或拉取请求(pull_request)等事件触发时，自动检测并维护PHP代码风格的一致性。

注意：使用前需确保项目中已创建 .php-cs-fixer.dist.php 配置文件。PHP-CS-Fixer官方示例配置文件可参考 https://github.com/FriendsOfPHP/PHP-CS-Fixer/blob/master/.php-cs-fixer.dist.php%E3%80%82

核心功能和特性

• GitHub Action集成：无缝接入GitHub工作流，响应push、pull_request等事件
• 自定义配置支持：通过命令行参数(args)指定自定义配置文件、检查模式等
• 缓存机制：支持生成并缓存检查结果，提升重复运行效率
• 独立运行能力：可作为Docker镜像在本地或其他环境独立执行代码风格检查

使用场景和适用范围

适用于所有使用PHP开发并托管在GitHub上的项目，尤其适合需要在CI/CD流程中自动化维护代码风格一致性的团队，可有效减少人工代码审查中的风格问题争议，提升开发效率。

使用方法和配置说明

基本用法

在GitHub项目中创建工作流文件（如 .github/workflows/lint.yml），配置如下：

yaml
# .github/workflows/lint.yml

on: [push, pull_request]
name: Main
jobs:
  php-cs-fixer:
    name: PHP-CS-Fixer
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v3
    - name: PHP-CS-Fixer
      uses: docker://oskarstark/php-cs-fixer-ga

自定义配置

通过 with.args 参数可添加自定义配置选项，如指定配置文件、启用差异比较（--diff）、模拟运行（--dry-run）等：

diff
# .github/workflows/lint.yml

on: [push, pull_request]
name: Main
jobs:
  php-cs-fixer:
    name: PHP-CS-Fixer
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v3
    - name: PHP-CS-Fixer
      uses: docker://oskarstark/php-cs-fixer-ga
+     with:
+       args: --config=.project.php_cs --diff --dry-run

使用缓存

为提升重复运行效率，可配置缓存功能：

1. 首先将 .php-cs-fixer.cache 添加到项目的 .gitignore 文件中
2. 在工作流中添加缓存步骤：

yaml
on: [push, pull_request]
name: Main
jobs:
  php-cs-fixer:
    name: PHP-CS-Fixer
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: actions/cache@v3
        with:
          path: .php-cs-fixer.cache
          key: ${{ runner.OS }}-${{ github.repository }}-phpcsfixer-${{ github.sha }}
          restore-keys: |
            ${{ runner.OS }}-${{ github.repository }}-phpcsfixer-

      - name: PHP-CS-Fixer
        uses: docker://oskarstark/php-cs-fixer-ga

提示：可直接复制示例中的 .github/ 文件夹到项目中快速启用。

Docker独立运行

该镜像也可作为独立Docker容器运行，适用于本地开发或非GitHub CI环境：

bash
docker run --rm -it -w=/app -v ${PWD}:/app oskarstark/php-cs-fixer-ga:latest

示例项目

可参考以下测试项目的PR示例，了解实际运行效果：
https://github.com/OskarStark/test-php-cs-fixer-ga/pulls