@@ -36,8 +36,7 @@ You can easily create your own rule set by extending the [`Realodix\Relax\RuleSe
36
36
use Realodix\Relax\Config;
37
37
use Vendor\Package\MyRuleSet;
38
38
39
- return Config::create(new MyRuleSet)
40
- ->setFinder(/* ... */);
39
+ return Config::create(new MyRuleSet);
41
40
```
42
41
43
42
Sometimes for big dirty projects, you want to implement some local rules without implementing a ruleset, why not.
@@ -48,8 +47,7 @@ $localRules = [
48
47
];
49
48
50
49
Config::create()
51
- ->setRules($localRules)
52
- ->setFinder(/* ... */);
50
+ ->setRules($localRules);
53
51
```
54
52
55
53
For advanced configuration, see the [ docs/advanced_configuration.md] ( docs/advanced_configuration.md )
@@ -72,6 +70,20 @@ Preset defines a built-in set of rules that are ready to be used to fix code sty
72
70
Config::create('laravel')
73
71
```
74
72
73
+ #### Finder Sets
74
+
75
+ By default, Relax will inspect all ` .php ` files in your project except those in the ` vendor ` directory.
76
+
77
+ | Preset | Description |
78
+ | -------- | -------------|
79
+ | [ ` Finder::base() ` ] [ doc_f_base ] | The basic finder setup should be perfect for most PHP projects |
80
+ | [ ` Finder::laravel() ` ] [ doc_f_laravel ] | Inherits ` Finder::base() ` with some specific tweaks to Laravel |
81
+
82
+ :bulb : By default, if finder is not set Relax will use ` Finder::base() ` .
83
+
84
+ [ doc_f_base ] : docs/finders.md#finderbase
85
+ [ doc_f_laravel ] : docs/finders.md#finderlaravel
86
+
75
87
76
88
## Troubleshooting
77
89
0 commit comments