Skip to content

Do not remove true/false phpdoc if type hint is bool #1778

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

Do not remove true/false phpdoc if type hint is bool #1778

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
2 changes: 1 addition & 1 deletion SlevomatCodingStandard/Helpers/AnnotationHelper.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -286,7 +286,7 @@ public static function isAnnotationUseless(
['true', 'false', 'null'],
true,
)) {
return $enableStandaloneNullTrueFalseTypeHints;
return $typeHint->getTypeHint() === strtolower($annotationType->name) ? $enableStandaloneNullTrueFalseTypeHints : false;
}

if (TypeHintHelper::isSimpleUnofficialTypeHints(
Expand Down
25 changes: 25 additions & 0 deletions SlevomatCodingStandard/Sniffs/TypeHints/ReturnTypeHintSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,31 @@ private function checkFunctionTypeHint(
}
}

if (
$this->enableStandaloneNullTrueFalseTypeHints
&& $returnTypeHint->getTypeHint() === 'bool'
&& $returnTypeNode instanceof IdentifierTypeNode
&& in_array(strtolower($returnTypeNode->name), ['true', 'false'], true)
) {
$fix = $phpcsFile->addFixableError(
sprintf(
'%s %s() has return type hint "bool" but it should be possible to use "%s" based on @return annotation "%s".',
FunctionHelper::getTypeLabel($phpcsFile, $functionPointer),
FunctionHelper::getFullyQualifiedName($phpcsFile, $functionPointer),
strtolower($returnTypeNode->name),
AnnotationTypeHelper::print($returnTypeNode),
),
$functionPointer,
self::CODE_LESS_SPECIFIC_NATIVE_TYPE_HINT,
);

if ($fix) {
$phpcsFile->fixer->beginChangeset();
FixerHelper::replace($phpcsFile, $returnTypeHint->getStartPointer(), strtolower($returnTypeNode->name));
$phpcsFile->fixer->endChangeset();
}
}

return;
}

Expand Down
Loading