README

此仓库包含基于 PER-2 的针对 PHP CS Fixer 的规则集。

安装和配置

通过 composer 安装此包

composer require --dev spiral/code-style

在项目的根目录下创建配置文件 .php-cs-fixer.dist.php

<?php declare(strict_types=1);

require_once 'vendor/autoload.php';

return \Spiral\CodeStyle\Builder::create()
    ->include(__DIR__ . '/src')
    ->include(__FILE__)
    ->build();

您可以自由调整路径以包含/排除文件和目录。

使用方法

为了更方便的使用，您可以将以下命令添加到 composer.json 文件的 scripts 部分

{
    "scripts": {
        "cs:diff": "php-cs-fixer fix --dry-run -v --diff",
        "cs:fix": "php-cs-fixer fix -v"
    }
}

现在您可以运行以下命令

composer cs:diff
composer cs:fix

持续集成（CI）集成

如果您想将代码风格检查集成到 CI 中，请将以下步骤添加到您的 GitHub Actions 配置文件中

on:
  push:
    branches:
      - '*'

name: Check Code Style

jobs:
  cs-check:
    uses: spiral/gh-actions/.github/workflows/cs.yml@master

如果您想让 GitHub Actions 自动修复找到的错误，请添加以下步骤

on:
  push:
    branches:
      - '*'

name: Fix Code Style

jobs:
  cs-fix:
    permissions:
      contents: write
    uses: spiral/gh-actions/.github/workflows/cs-fix.yml@master

spiral / code-style

维护者

详细信息

README

安装和配置

使用方法

持续集成（CI）集成