Skip to content

Issue #22: Enforce type hint inline comment syntax #23

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: main
Choose a base branch
from
Open

Issue #22: Enforce type hint inline comment syntax #23

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
8 changes: 8 additions & 0 deletions Backdrop/Sniffs/Commenting/InlineCommentSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,14 @@ public function process(File $phpcsFile, $stackPtr)
}
}

if ($tokens[$stackPtr]['type'] === 'T_COMMENT' && strpos($tokens[$stackPtr]['content'], '@var') !== FALSE) {
// Enforce inline type hints to the syntax most widely supported by IDEs and tools.
if (strpos($tokens[$stackPtr]['content'], '/**') !== 0) {
$error = 'Inline type hint comments must be in the form "/** @var ... */".';
$phpcsFile->addError($error, $stackPtr, 'InvalidTypeHint');
}
}

// Only want inline comments.
if (substr($tokens[$stackPtr]['content'], 0, 2) !== '//') {
return;
Expand Down