Symfony.Formatting.BlankLineBeforeReturn too strict

[rarila]

Symfony.Formatting.BlankLineBeforeReturn is too strict, as it does allow simple comments, but no analyser instructions.

Here some examples with resulting tokens:

/**
 * Missing blank line before return statement
 * Token: [0 => 'T_PHPCS_IGNORE']
 */
function fails1(): string
{
    // phpcs:ignore Foobar.Whatever.Rule
    return foobar(1);
}

/**
 * Missing blank line before return statement
 * Token: [0 => 'T_PHPCS_IGNORE']
 */
function fails2(): string
{
    /* phpcs:ignore Foobar.Whatever.Rule */
    return foobar(1);
}

/**
 * Missing blank line before return statement
 * Token: [0 => 'T_PHPCS_IGNORE', 1 => 'T_DOC_COMMENT_OPEN_TAG']
 */
function fails3(): string
{
    /** phpcs:ignore Foobar.Whatever.Rule */
    return foobar(1);
}

/**
 * Missing blank line before return statement
 * Token: [0 => 'T_DOC_COMMENT_STRING', 1 => 'T_DOC_COMMENT_TAG', 2 => 'T_DOC_COMMENT_OPEN_TAG'']
 */
function fails4(): string
{
    /** @psalm-var ClassName $variable */
    return foobar(1);
}

I guess, given tokens should be added there:

Symfony-coding-standard/Symfony/Sniffs/Formatting/BlankLineBeforeReturnSniff.php

Lines 79 to 84 in 6ab870a

	$spaceTokens = [
	'T_WHITESPACE',
	'T_COMMENT',
	'T_DOC_COMMENT_CLOSE_TAG',
	'T_DOC_COMMENT_WHITESPACE',
	];