Skip to content
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

Jump to bottom

Added support for array multi line function comments #3687

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

Added support for array multi line function comments #3687

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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
73 changes: 66 additions & 7 deletions src/Standards/Squiz/Sniffs/Commenting/FunctionCommentSniff.php
View file
Open in desktop
Expand Up @@ -306,24 +306,55 @@ protected function processParams(File $phpcsFile, $stackPtr, $commentStart)
$varSpace = 0;
$comment = '';
$commentLines = [];
$isMultiLine = false;
if ($tokens[($tag + 2)]['code'] === T_DOC_COMMENT_STRING) {
$content = $tokens[($tag + 2)]['content'];

$multiLineExtra = 0;

if ($this->parenthesisClosed($content, '{', '}') === false
|| $this->parenthesisClosed($content, '<', '>') === false
) {
$isMultiLine = true;
$content = '';

$i = ($tag + 2);

while (true) {
if ($tokens[$i]['content'] === '@param') {
break;
}

$content .= $tokens[$i]['content'];

if ($this->parenthesisClosed($content, '{', '}') === true
&& $this->parenthesisClosed($content, '<', '>') === true
) {
break;
}

$multiLineExtra++;
$i++;
}
}//end if

$matches = [];
preg_match('/([^$&.]+)(?:((?:\.\.\.)?(?:\$|&)[^\s]+)(?:(\s+)(.*))?)?/', $tokens[($tag + 2)]['content'], $matches);
preg_match('/([^$&.]+)(?:((?:\.\.\.)?(?:\$|&)[^\s]+)(?:(\s+)(.*))?)?/', $content, $matches);

if (empty($matches) === false) {
$typeLen = strlen($matches[1]);
$type = trim($matches[1]);
$typeSpace = ($typeLen - strlen($type));
$typeLen = strlen($type);
if ($typeLen > $maxType) {
if ($typeLen > $maxType && $isMultiLine === false) {
$maxType = $typeLen;
}
}

if (isset($matches[2]) === true) {
$var = $matches[2];
$varLen = strlen($var);
if ($varLen > $maxVar) {
if ($varLen > $maxVar && $isMultiLine === false) {
$maxVar = $varLen;
}

Expand All @@ -332,7 +363,7 @@ protected function processParams(File $phpcsFile, $stackPtr, $commentStart)
$comment = $matches[4];
$commentLines[] = [
'comment' => $comment,
'token' => ($tag + 2),
'token' => ($tag + 2 + $multiLineExtra),
'indent' => $varSpace,
];

Expand All @@ -343,7 +374,7 @@ protected function processParams(File $phpcsFile, $stackPtr, $commentStart)
$end = $tokens[$commentStart]['comment_closer'];
}

for ($i = ($tag + 3); $i < $end; $i++) {
for ($i = ($tag + 3 + $multiLineExtra); $i < $end; $i++) {
if ($tokens[$i]['code'] === T_DOC_COMMENT_STRING) {
$indent = 0;
if ($tokens[($i - 1)]['code'] === T_DOC_COMMENT_WHITESPACE) {
Expand Down Expand Up @@ -380,6 +411,7 @@ protected function processParams(File $phpcsFile, $stackPtr, $commentStart)
'commentLines' => $commentLines,
'type_space' => $typeSpace,
'var_space' => $varSpace,
'multi_line' => $isMultiLine,
];
}//end foreach

Expand Down Expand Up @@ -547,7 +579,9 @@ protected function processParams(File $phpcsFile, $stackPtr, $commentStart)
$foundParams[] = $param['var'];

// Check number of spaces after the type.
$this->checkSpacingAfterParamType($phpcsFile, $param, $maxType);
if ($param['multi_line'] === false) {
$this->checkSpacingAfterParamType($phpcsFile, $param, $maxType);
}

// Make sure the param name is correct.
if (isset($realParams[$pos]) === true) {
Expand Down Expand Up @@ -580,7 +614,9 @@ protected function processParams(File $phpcsFile, $stackPtr, $commentStart)
}

// Check number of spaces after the var name.
$this->checkSpacingAfterParamName($phpcsFile, $param, $maxVar);
if ($param['multi_line'] === false) {
$this->checkSpacingAfterParamName($phpcsFile, $param, $maxVar);
}

// Param comments must start with a capital letter and end with a full stop.
if (preg_match('/^(\p{Ll}|\P{L})/u', $param['comment']) === 1) {
Expand Down Expand Up @@ -765,4 +801,27 @@ protected function checkInheritdoc(File $phpcsFile, $stackPtr, $commentStart)
}//end checkInheritdoc()


/**
* Determines wether string has the same number of open and close parenthesis.
*
* @param string $string String to check
* @param string $openChar Opening character.
* @param string $closeChar Closing character.
*
* @return bool
*/
private function parenthesisClosed($string, $openChar, $closeChar)
{
if (stripos($string, $openChar) === false) {
return true;
}

$open = substr_count($string, $openChar);
$close = substr_count($string, $closeChar);

return $open === $close;

}//end parenthesisClosed()


}//end class
17 changes: 17 additions & 0 deletions src/Standards/Squiz/Tests/Commenting/FunctionCommentUnitTest.inc
View file
Open in desktop
Expand Up @@ -1046,3 +1046,20 @@ public function ignored() {
* @return void
* @throws Exception If any other error occurs. */
function throwCommentOneLine() {}


/**
* @param array{foo: int} $a A.
* @param array{x: int} $ccc C.
* @param array{xxxx: int} $dddd D.
* @param array<array{
* foo: array{foo: int},
* bar: int
* }> $bb B.
*
* @return integer
*/
public function multiLineArray(array $a, array $ccc, array $dddd, array $bb)
{
return 1;
}//end multiLineArray()
17 changes: 17 additions & 0 deletions src/Standards/Squiz/Tests/Commenting/FunctionCommentUnitTest.inc.fixed
View file
Open in desktop
Expand Up @@ -1046,3 +1046,20 @@ public function ignored() {
* @return void
* @throws Exception If any other error occurs. */
function throwCommentOneLine() {}


/**
* @param array{foo: int} $a A.
* @param array{x: int} $ccc C.
* @param array{xxxx: int} $dddd D.
* @param array<array{
* foo: array{foo: int},
* bar: int
* }> $bb B.
*
* @return integer
*/
public function multiLineArray(array $a, array $ccc, array $dddd, array $bb)
{
return 1;
}//end multiLineArray()
2 changes: 2 additions & 0 deletions src/Standards/Squiz/Tests/Commenting/FunctionCommentUnitTest.php
View file
Open in desktop
Expand Up @@ -116,6 +116,8 @@ public function getErrorList()
1004 => 2,
1006 => 1,
1029 => 1,
1052 => 2,
1053 => 2,
];

// Scalar type hints only work from PHP 7 onwards.
Expand Down