From c8038fe69b9a3bbbed8832a4c67322f227c72139 Mon Sep 17 00:00:00 2001 From: Kei Date: Wed, 12 Jun 2024 23:42:46 +0700 Subject: [PATCH] Update README.md --- README.md | 31 ++++++++++++------------------- 1 file changed, 12 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 5e995ed..535bb39 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ composer require --dev realodix/relax ./vendor/bin/php-cs-fixer fix ``` -For more details, see [PHP-CS-Fixer: Usage][pcf_doc_usage] documentation. +For more details, see PHP-CS-Fixer [documentation](https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/blob/master/doc/usage.rst). ## Configuring Relax @@ -50,11 +50,11 @@ Rule set defines a set of rules that can be used to fix code style issues in you | [`@Realodix`][rs_realodix] | Inherits `@Laravel` with some tweaks | | [`@Spatie`][rs_spatie] | The rule set used by Spatie | -:bulb: If you wish, you can also add the [PHP-CS-Fixer rule sets][pcf_doc_ruleset]. +:bulb: If you wish, you can also add the [PHP-CS-Fixer rule sets](https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/blob/master/doc/ruleSets/index.rst). #### Custom Fixers -- [kubawerlos/php-cs-fixer-custom-fixers][fx_kubawerlos_custom-fixers] +- [kubawerlos/php-cs-fixer-custom-fixers](https://github.com/kubawerlos/php-cs-fixer-custom-fixers) :bulb: They're all registered, so you don't need to re-register via `registerCustomFixers()`. @@ -69,6 +69,12 @@ By default, Relax will inspect all `.php` files in your project except those in :bulb: By default, if finder is not set Relax will use `Finder::base()`. +[rs_laravel]: src/RuleSet/Sets/Laravel.php +[rs_realodix]: src/RuleSet/Sets/Realodix.php +[rs_spatie]: src/RuleSet/Sets/Spatie.php +[doc_f_base]: docs/finders.md#finderbase +[doc_f_laravel]: docs/finders.md#finderlaravel + ## Advanced Configuration In case you only need some tweaks for specific projects, which won't deserve an own rule set - you may enable or disable specific rules. @@ -107,7 +113,7 @@ return Config::create('@PSR2', $localRules) ->registerCustomFixers(new \PhpCsFixerCustomFixers\CustomFixer()); ``` -Relax is built on top of [`PHP-CS-Fixer`][php-cs-fixer]. Therefore, you may use any of its rules to fix code style issues in your project. For more details, see [PHP-CS-Fixer: Config][pcf_doc_config] documentation and [MLocati: PHP-CS-Fixer Configurator][pcf_doc_config_mlocati]. +Relax is built on top of [`PHP-CS-Fixer`][php-cs-fixer]. Therefore, you may use any of its rules to fix code style issues in your project. For more details, see [PHP-CS-Fixer: Config](https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/blob/master/doc/config.rst) documentation and [MLocati: PHP-CS-Fixer Configurator](https://mlocati.github.io/php-cs-fixer-configurator). If you wish to completely define rules locally without using existing rule sets, you can do that: @@ -127,7 +133,7 @@ return Config::create($localRules); ## Custom Rule Set -You can easily create your own rule set by extending the [`AbstractRuleSet`][rs_abstract]: class. +You can easily create your own rule set by extending the [`AbstractRuleSet`](src/RuleSet/AbstractRuleSet.php): class. ```php