Documentation for custom rules and closure rules

[MissaelAnda]

Document Custom Rule Classes and Closure Rules

Add a description to Closure rule with a DocComent:

$request->validate([
    'complex_rule' => [
        /** This is a very specific validation therefore it needs a better description */
        function ($attribute, $value, $fail) { $fail('error'); }
    ],
]);

Add more info to a Custom Validation Rule:

class CustomRule implements Rule
{
    // ...

    public static function docs(): array
    {
        return [
            'description' => 'This rule makes something very specific',
            'example' => '52KB',
        ];
    }
}

This is a followup for #551

I'm missing the tests and documentation changes, if you could point me where and how should I do them it'd be nice.

[shalvah]

The class that tests this is the ValidationRuleParsingTest. You should probably add two new test methods, something like can_parse_custom_closure_rules and can_parse_custom_rule_classes. You can follow the existing examples.

[shalvah]

It feels a bit iffy to me to have an example defined on a rule. I guess it can work, but I'm uncertain if we want to go that path. For example, what happens if one parameter has this rule and others defined? The example will either be overwritten or hardcoded to this, which may or may not be unexpected behaviour. Maybe we should leave that out for now (after all, you can already specify examples for parameters in a FormRequest).

[MissaelAnda]

The idea with the example is to define a default example in case none given like the string rules "setter"s, the problem maybe is that the example is always assigned. I'll change it to only set the example with the "setter" field and add the tests.

[shalvah]

Can you send in a docs PR as well?

[MissaelAnda]

I just relized that I'm missing InvokableRule, it only needs to change ParsesValidationRules to import it and change line 194 to:

if ($rule instanceof Rule || $rule instanceof InvokableRule) {

[shalvah]

Added.