README

AzuyaLabs项目的PHP CS Fixer配置

安装

运行

composer require --dev azuyalabs/php-cs-fixer-config

用法

配置

如果不存在，请在项目的根目录中创建一个配置文件 .php-cs-fixer.php，内容如下：

<?php

declare(strict_types=1);

$config = new AzuyaLabs\PhpCsFixerConfig\Config();
$config->getFinder()->in(__DIR__);

return $config;

如果已存在，请确保更新它，如上所述。

如果您愿意，也可以像这样覆盖任何默认规则

<?php

declare(strict_types = 1);

$config = new AzuyaLabs\PhpCsFixerConfig\Config();
$config->getFinder()->in(__DIR__);

$defaults = $config->getRules();

$config->setRules(array_merge($defaults, [
    '@Symfony' => false,
]));

return $config;

将两个辅助脚本来到Composer配置文件中

  ...
"scripts": {
"cs": "vendor/bin/php-cs-fixer fix -v --diff --dry-run",
"cs-fix": "vendor/bin/php-cs-fixer fix -v",
}
...

Git

将.php-cs-fixer.cache（这是由php-cs-fixer创建的缓存文件）添加到.gitignore

.php-cs-fixer.cache
vendor/

GitLab CI/CD

如果您已在composer.json文件中包含了这两个辅助脚本，您可以在项目的GitLab CI配置中使用它们。

要在测试阶段将检查代码风格设置作为作业添加，请将以下内容包含到您的.gitlab-ci.yml文件中

cs-check:
    stage: test
    script:
        - composer cs

如果您不想使用或没有辅助Composer脚本，请将上面的composer cs脚本替换为vendor/bin/php-cs-fixer fix -v --diff --dry-run

修复代码风格问题

手动

如果您需要在本地修复代码风格问题，只需运行

composer cs-fix

使用composer cs进行试运行。

自动

对于喜欢自动修复代码风格问题的用户，您可以选择创建一个Git预提交钩子，或者配置您的IDE以利用PHPCS Fixer二进制文件或配置的Composer脚本。

代码风格

此自定义配置基于@PER-CS和@Symfony规则集，并启用了一些额外的规则（例如有关空格等）。