README

这是Imbo项目及其相关工具的PHP编码规范。该规则集通过使用 PHP Coding Standards Fixer 工具强制执行。

如何设置

首先，将此包作为开发依赖项添加

composer require --dev imbo/imbo-coding-standard ^2.0

然后，创建一个名为 .php-cs-fixer.php 的PHP-CS-Fixer配置文件，该文件位于您的仓库中，并包含以下内容

<?php declare(strict_types=1);
require 'vendor/autoload.php';

$finder = (new Symfony\Component\Finder\Finder())
    ->files()
    ->name('*.php')
    ->in(__DIR__)
    ->exclude('vendor');

return (new Imbo\CodingStandard\Config())
    ->setFinder($finder);

如有必要，调整路径。现在您可以通过运行以下命令来检查项目中的编码规范

php-cs-fixer fix --dry-run --diff

如果您愿意，可以使用Composer全局安装 php-cs-fixer 工具

composer global require friendsofphp/php-cs-fixer

有关其他安装选项，请参阅文档

在GitHub工作流程中添加步骤

所有与Imbo相关的项目都使用GitHub工作流程，检查编码规范应该是该工作流程的一部分。

name: CI workflow
on: push
jobs:
  php-cs-fixer:
    runs-on: ubuntu-20.04
    name: Check coding standard
    steps:
      - name: Checkout code
        uses: actions/checkout@v2

      - name: Setup PHP
        uses: shivammathur/setup-php@v2
        with:
          tools: php-cs-fixer

      - name: Install dependencies
        run: composer install --prefer-dist

      - name: Check coding standard
        run: php-cs-fixer fix --dry-run --diff

imbo / imbo-phpcs-standard

维护者

详情

README

如何设置

在GitHub工作流程中添加步骤