Skip to content

Squiz/PostStatementComment: use a different error code for annotations #627

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 3 commits into from
Oct 30, 2024
Merged

Squiz/PostStatementComment: use a different error code for annotations #627

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f6053a3
Squiz/PostStatementComment: use a different error code for annotations
rodrigoprimo Oct 11, 2024
009c701
Modify regex and add more tests based on PR review feedback
rodrigoprimo Oct 28, 2024
e28bf06
Apply suggestions from code review
rodrigoprimo Oct 29, 2024
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
8 changes: 8 additions & 0 deletions src/Standards/Squiz/Sniffs/Commenting/PostStatementCommentSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,14 @@ public function process(File $phpcsFile, $stackPtr)
}
}

if ($phpcsFile->tokenizerType === 'PHP'
&& preg_match('|^//[ \t]*@[^\s]+|', $tokens[$stackPtr]['content']) === 1
) {
$error = 'Annotations may not appear after statements';
$phpcsFile->addError($error, $stackPtr, 'AnnotationFound');
return;
}

$error = 'Comments may not appear after statements';
$fix = $phpcsFile->addFixableError($error, $stackPtr, 'Found');
if ($fix === true) {
Expand Down
10 changes: 10 additions & 0 deletions src/Standards/Squiz/Tests/Commenting/PostStatementCommentUnitTest.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,3 +52,13 @@ $match = match($foo // comment
) {
1 => 1, // comment
};

// Comments recognized as annotations by PHPCS.
$a = 1; //@codeCoverageIgnore
$b = 2; // @phpstan-ignore variable.undefined
$c = 3; // @phpstan-ignore variable.undefined
$d = 4; // @tabInsteadOfSpace

// Comments that include `@`, but are not recognized as annotations by PHPCS.
$a = 1; // @ = add tag.
$b = 2; // Some comment. // @username
12 changes: 12 additions & 0 deletions src/Standards/Squiz/Tests/Commenting/PostStatementCommentUnitTest.inc.fixed
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,3 +57,15 @@ $match = match($foo // comment
1 => 1,
// comment
};

// Comments recognized as annotations by PHPCS.
$a = 1; //@codeCoverageIgnore
$b = 2; // @phpstan-ignore variable.undefined
$c = 3; // @phpstan-ignore variable.undefined
$d = 4; // @tabInsteadOfSpace

// Comments that include `@`, but are not recognized as annotations by PHPCS.
$a = 1;
// @ = add tag.
$b = 2;
// Some comment. // @username
6 changes: 6 additions & 0 deletions src/Standards/Squiz/Tests/Commenting/PostStatementCommentUnitTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,12 @@ public function getErrorList($testFile='')
18 => 1,
35 => 1,
53 => 1,
57 => 1,
58 => 1,
59 => 1,
60 => 1,
63 => 1,
64 => 1,
];

case 'PostStatementCommentUnitTest.1.js':
Expand Down