README

该包已被废弃，请避免使用。请使用 realodix/relax 代替。

Realodix CS Config

该包基于 PHP CS Fixer 构建，使得在所有项目中共享相同的 PHP CS Fixer 规则变得简单，无需复制粘贴配置文件。

安装

您可以使用 composer 安装此包。

composer require --dev realodix/cs-config

配置

在您的 PHP CS Fixer 配置文件中，使用以下内容：

<?php

use Realodix\CsConfig\Config;
use Realodix\CsConfig\Finder;
use Realodix\CsConfig\Rules\Realodix;

return Config::create(new Realodix);

查找器预设

• Finder::base() - 默认
• Finder::laravel()

规则集

• Realodix, RealodixPlus
• Laravel, LaravelRisky
• Spatie
• Blank - 没有预定义规则。使用此规则可以完全自定义规则。

💡 命名空间 Realodix\CsConfig\Rules\

自定义修复器

• Laravel/laravel_phpdoc_alignment
• Laravel/laravel_phpdoc_order
• Laravel/laravel_phpdoc_separation
• kubawerlos/php-cs-fixer-custom-fixers

💡 已注册，因此您无需通过 registerCustomFixers() 注册它。

高级配置

如果您只需要为特定项目做一些调整，而这些调整不值得创建自己的预设，您可以为它们添加额外的规则或覆盖它们。

<?php

use Realodix\CsConfig\Config;
use Realodix\CsConfig\Finder;
use Realodix\CsConfig\Rules\Realodix;

$localRules = [
    // Adding a rule
    'array_syntax' => true,
    // Adding a rule or override predefined rules
    'binary_operator_spaces' => [
        'operators' => ['=>' => 'align_single_space_minimal']
    ],
    // Override predefined rules
    'ternary_operator_spaces' => false,
    // Adding custom rules
    'CustomFixer/rule_1' => true,
    'CustomFixer/rule_2' => true,
];

return Config::create(new Realodix($localRules))
    ->registerCustomFixers(new PhpCsFixerCustomFixers\CustomFixer());

扩展

您可以通过扩展 AbstractRules 类轻松创建自己的预设。

<?php

use Realodix\CsConfig\Rules\AbstractRules;

final class MyRules extends AbstractRules
{
    // public string $name = 'Personal CS';

    protected function rules(): array
    {
        //
    }
}

然后使用它！

<?php

use Realodix\CsConfig\Config;
use Realodix\CsConfig\Finder;
use YourVendorName\YourPackageName\MyRules;

$finder = Finder::base(__DIR__);

return Config::create(new MyRules)
    ->setFinder($finder);

故障排除

有关一般帮助和支持，请加入我们的 GitHub Discussions。

请将错误报告提交到 GitHub 问题跟踪器。

许可证

本软件包采用 MIT 许可证。