Skip to content

Fix VariableWrong false positives for partial doc blocks #40

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 1 commit into from
Nov 27, 2025
Merged

Fix VariableWrong false positives for partial doc blocks #40

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
26 changes: 17 additions & 9 deletions PhpCollective/Sniffs/Commenting/DocBlockParamSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,21 +153,29 @@ public function process(File $phpcsFile, $stackPointer): void
return;
}

foreach ($docBlockParams as $docBlockParam) {
/** @var array<string, mixed> $methodParam */
$methodParam = array_shift($methodSignature);
$variableName = $tokens[$methodParam['variableIndex']]['content'];
// Build a map of method param variable names for lookup
$methodParamsByName = [];
foreach ($methodSignature as $methodParam) {
$varName = $tokens[$methodParam['variableIndex']]['content'];
$methodParamsByName[$varName] = $methodParam;
}

if ($docBlockParam['variable'] === $variableName) {
continue;
}
foreach ($docBlockParams as $docBlockParam) {
// We let other sniffers take care of missing type for now
if (str_contains($docBlockParam['type'], '$')) {
continue;
}

$error = 'Doc Block param variable `' . $docBlockParam['variable'] . '` should be `' . $variableName . '`';
// For now just report (buggy yet)
$docBlockVariable = $docBlockParam['variable'];

// Check if the doc block variable exists in the method signature
if (isset($methodParamsByName[$docBlockVariable])) {
// Variable name matches a method param - this is correct
continue;
}

// Variable doesn't exist in method signature - report error
$error = 'Doc Block param variable `' . $docBlockVariable . '` does not exist in method signature';
$phpcsFile->addError($error, $docBlockParam['index'], 'VariableWrong');
}
}
Expand Down