Skip to content

Allow more commenting in BlankLineBeforeReturnSniff #207

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Allow more commenting in BlankLineBeforeReturnSniff #207

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions Symfony/Sniffs/Formatting/BlankLineBeforeReturnSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,12 @@ public function process(File $phpcsFile, $stackPtr)
$spaceTokens = [
'T_WHITESPACE',
'T_COMMENT',
'T_DOC_COMMENT_OPEN_TAG',
'T_DOC_COMMENT_CLOSE_TAG',
'T_DOC_COMMENT_TAG',
'T_DOC_COMMENT_STRING',
'T_DOC_COMMENT_WHITESPACE',
'T_PHPCS_IGNORE',
];

while ($current >= 0 && $tokens[$current]['line'] >= $previousLine) {
Expand Down
24 changes: 24 additions & 0 deletions Symfony/Tests/Formatting/BlankLineBeforeReturnUnitTest.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,30 @@ function invalidFunctionReturnOne()
return;
}

function validFunctionReturnWithPhpcsIgnore1(): string
{
// phpcs:ignore Foobar.Whatever.Rule
return foobar(1);
}

function validFunctionReturnWithPhpcsIgnore2(): string
{
/* phpcs:ignore Foobar.Whatever.Rule */
return foobar(1);
}

function validFunctionReturnWithPhpcsIgnore3(): string
{
/** phpcs:ignore Foobar.Whatever.Rule */
return foobar(1);
}

function validFunctionReturnWithVariableDoc(): string
{
/** @psalm-var ClassName $variable */
return foobar(1);
}

switch ($condition) {
case 'foo':
return true;
Expand Down
24 changes: 24 additions & 0 deletions Symfony/Tests/Formatting/BlankLineBeforeReturnUnitTest.inc.fixed
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,30 @@ function invalidFunctionReturnOne()
return;
}

function validFunctionReturnWithPhpcsIgnore1(): string
{
// phpcs:ignore Foobar.Whatever.Rule
return foobar(1);
}

function validFunctionReturnWithPhpcsIgnore2(): string
{
/* phpcs:ignore Foobar.Whatever.Rule */
return foobar(1);
}

function validFunctionReturnWithPhpcsIgnore3(): string
{
/** phpcs:ignore Foobar.Whatever.Rule */
return foobar(1);
}

function validFunctionReturnWithVariableDoc(): string
{
/** @psalm-var ClassName $variable */
return foobar(1);
}

switch ($condition) {
case 'foo':
return true;
Expand Down