realodix/relax

共享 php-cs-fixer 规则和查找器预设

v1.18.0 2024-08-07 18:29 UTC

README

PHPVersion Packagist Version (custom server) Build Status

Relax 基于 PHP-CS-Fixer 构建,提供了一种标准化的方式来在多个项目中应用编码标准,确保一致性和最佳实践。

通过使用预定义的规则集,它简化了设置过程,并允许团队快速将 PHP-CS-Fixer 集成到其开发工作流程中。

安装

您可以使用 composer 安装此包

composer require --dev realodix/relax

运行 Relax

./vendor/bin/php-cs-fixer fix

有关更多详细信息,请参阅 PHP-CS-Fixer 文档

配置 Relax

您可以通过扩展 Realodix\Relax\RuleSet\AbstractRuleSet 类并使用它来轻松创建自己的规则集!请参阅 docs/example_ruleset.md 了解如何创建自己的规则集的示例。

<?php

use Realodix\Relax\Config;
use Vendor\Package\MyRuleSet;

return Config::create(new MyRuleSet);

有时对于大型脏项目,您可能想在不实现规则集的情况下实现一些本地规则,为什么不呢。

$localRules = [
    // ...
];

Config::create()
    ->setRules($localRules);

有关高级配置,请参阅 docs/advanced_configuration.md

预设

预设定义了一组内置规则,可用于修复代码风格问题。

Config::create('laravel')

查找器集

默认情况下,Relax 将检查项目中除 vendor 目录外的所有 .php 文件。

💡 默认情况下,如果没有设置查找器,Relax 将使用 Finder::base()

故障排除

要获取一般帮助和支持,请加入我们的 GitHub 讨论区

请向 GitHub 问题跟踪器 报告错误。

许可证

此软件包根据 MIT 许可证 授权。