Skip to content

Squiz/FunctionComment: support DNF types #944

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

Merged
merged 2 commits into from
Apr 13, 2025
Merged

Squiz/FunctionComment: support DNF types #944

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5f4e5d5
Squiz/FunctionComment: support intersection types
devfrey Apr 8, 2025
1b82ce8
Preserve existing behaviour
devfrey Apr 9, 2025
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
10 changes: 5 additions & 5 deletions src/Standards/Squiz/Sniffs/Commenting/FunctionCommentSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -311,7 +311,7 @@ protected function processParams(File $phpcsFile, $stackPtr, $commentStart)
$commentLines = [];
if ($tokens[($tag + 2)]['code'] === T_DOC_COMMENT_STRING) {
$matches = [];
preg_match('/([^$&.]+)(?:((?:\.\.\.)?(?:\$|&)[^\s]+)(?:(\s+)(.*))?)?/', $tokens[($tag + 2)]['content'], $matches);
preg_match('/((?:(?![$.]|&(?=\$)).)*)(?:((?:\.\.\.)?(?:\$|&)[^\s]+)(?:(\s+)(.*))?)?/', $tokens[($tag + 2)]['content'], $matches);

if (empty($matches) === false) {
$typeLen = strlen($matches[1]);
Expand All @@ -323,7 +323,10 @@ protected function processParams(File $phpcsFile, $stackPtr, $commentStart)
}
}

if (isset($matches[2]) === true) {
if ($tokens[($tag + 2)]['content'][0] === '$') {
$error = 'Missing parameter type';
$phpcsFile->addError($error, $tag, 'MissingParamType');
} else if (isset($matches[2]) === true) {
$var = $matches[2];
$varLen = strlen($var);
if ($varLen > $maxVar) {
Expand Down Expand Up @@ -366,9 +369,6 @@ protected function processParams(File $phpcsFile, $stackPtr, $commentStart)
$phpcsFile->addError($error, $tag, 'MissingParamComment');
$commentLines[] = ['comment' => ''];
}//end if
} else if ($tokens[($tag + 2)]['content'][0] === '$') {
$error = 'Missing parameter type';
$phpcsFile->addError($error, $tag, 'MissingParamType');
} else {
$error = 'Missing parameter name';
$phpcsFile->addError($error, $tag, 'MissingParamName');
Expand Down
9 changes: 9 additions & 0 deletions src/Standards/Squiz/Tests/Commenting/FunctionCommentUnitTest.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1158,3 +1158,12 @@ function paramVariation3($hasTypeNoComment): void {}
* @return void
*/
function paramVariation4($hasTypehasComment): void {}

/**
* @param (Foo&Bar)|null $a Comment.
* @return void
*/
public function setTranslator($a): void
{
$this->translator = $translator;
}
9 changes: 9 additions & 0 deletions src/Standards/Squiz/Tests/Commenting/FunctionCommentUnitTest.inc.fixed
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1158,3 +1158,12 @@ function paramVariation3($hasTypeNoComment): void {}
* @return void
*/
function paramVariation4($hasTypehasComment): void {}

/**
* @param (Foo&Bar)|null $a Comment.
* @return void
*/
public function setTranslator($a): void
{
$this->translator = $translator;
}
Loading