Should the document generator complain of use of CodeSamples with ConfigurableRectorInterface?

[peterfox]

Currently if you have a rule that implements ConfigurableRectorInterface the assumption is that you must use the rule with configuration options. So when documenting the rule, if you do the following it will fail when trying to generate documentation.

    public function getRuleDefinition(): RuleDefinition
    {
        return new RuleDefinition(
            'Apply default instead of null coalesce',
            [
                    new CodeSample(
                                        <<<'CODE_SAMPLE'
config('app.name') ?? 'Laravel';
CODE_SAMPLE,
                                        <<<'CODE_SAMPLE'
config('app.name', 'Laravel');
CODE_SAMPLE
                ),
                new ConfiguredCodeSample(
                    <<<'CODE_SAMPLE'
custom_helper('app.name') ?? 'Laravel';
CODE_SAMPLE,
                    <<<'CODE_SAMPLE'
custom_helper('app.name', 'Laravel');
CODE_SAMPLE
                    ,
                    [
                        new ApplyDefaultInsteadOfNullCoalesce('custom_helper'),
                    ],
                ),
            ]
        );
    }

Equally if you try to document a rule with an empty array it fails.

    public function getRuleDefinition(): RuleDefinition
    {
        return new RuleDefinition(
            'Apply default instead of null coalesce',
            [
                new ConfiguredCodeSample(
                    <<<'CODE_SAMPLE'
custom_helper('app.name') ?? 'Laravel';
CODE_SAMPLE,
                    <<<'CODE_SAMPLE'
custom_helper('app.name', 'Laravel');
CODE_SAMPLE
                    ,
                    [],
                ),
            ]
        );
    }

This isn't reflective of the fact you can use a configurable rule without specific configuration applied via the config, relying on no configuration or provide an empty array as the configuration. This also generates an error.

Solution

To fix this, I propose that the validation for configurable rules must have at least one ConfiguredCodeSample provided but does not block the use of additional CodeSample being provided when a rule implements ConfigurableRectorInterface.