Skip to content

AC-1339: Detect comment for typed class properties #289

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 4 commits into from
Sep 28, 2021
Merged

AC-1339: Detect comment for typed class properties #289

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
14704dd
AC-1339: Detect comment for typed class properties
svera Sep 28, 2021
6570218
AC-1339: Detect comment for typed class properties
svera Sep 28, 2021
0c5c0f3
AC-1339: Detect comment for typed class properties
svera Sep 28, 2021
96f00e7
AC-1339: Detect comment for typed class properties
svera Sep 28, 2021
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion Magento2/Sniffs/Commenting/ClassPropertyPHPDocFormattingSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,13 +57,17 @@ public function processMemberVar(File $phpcsFile, $stackPtr)
$tokens = $phpcsFile->getTokens();

$commentEnd = $phpcsFile->findPrevious($this->ignoreTokens, ($stackPtr - 1), null, true);
if ($commentEnd === false

if ($commentEnd !== false && $tokens[$commentEnd]['code'] === T_STRING) {
$commentEnd = $phpcsFile->findPrevious($this->ignoreTokens, ($commentEnd - 1), null, true);
} elseif ($commentEnd === false
|| ($tokens[$commentEnd]['code'] !== T_DOC_COMMENT_CLOSE_TAG
&& $tokens[$commentEnd]['code'] !== T_COMMENT)
) {
$phpcsFile->addWarning('Missing PHP DocBlock for class property.', $stackPtr, 'Missing');
return;
}

$commentStart = $tokens[$commentEnd]['comment_opener'];
$foundVar = null;
foreach ($tokens[$commentStart]['comment_tags'] as $tag) {
Expand Down
5 changes: 5 additions & 0 deletions Magento2/Tests/Commenting/ClassPropertyPHPDocFormattingUnitTest.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,4 +120,9 @@ class correctlyFormattedClassMemberDocBlock
* @var test
*/
protected $test;

/**
* @var string
*/
protected string $test;
}