Skip to content

Fixed wrongly returning error for valid descriptions #270

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 13 commits into from
Sep 14, 2021
Merged

Fixed wrongly returning error for valid descriptions #270

Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
ef00afd
Fixed wrongly returning error for valid descriptions
svera Sep 13, 2021
95c56c9
Update Magento2/Sniffs/Commenting/ClassPropertyPHPDocFormattingSniff.php
svera Sep 14, 2021
2a57af8
Update Magento2/Sniffs/Commenting/ClassPropertyPHPDocFormattingSniff.php
svera Sep 14, 2021
f209db6
Fixed wrongly returning error for valid descriptions
svera Sep 14, 2021
1ed4156
Fixed wrongly returning error for valid descriptions
svera Sep 14, 2021
efaffac
Fixed wrongly returning error for valid descriptions
svera Sep 14, 2021
62e0fc1
Fixed wrongly returning error for valid descriptions
svera Sep 14, 2021
5b4b543
Fixed wrongly returning error for valid descriptions
svera Sep 14, 2021
0c29f5b
Fixed wrongly returning error for valid descriptions
svera Sep 14, 2021
3fb9cba
Fixed wrongly returning error for valid descriptions
svera Sep 14, 2021
d238849
Fixed wrongly returning error for valid descriptions
svera Sep 14, 2021
e92e17d
Fixed wrongly returning error for valid descriptions
svera Sep 14, 2021
0fb55fc
Fixed wrongly returning error for valid descriptions
svera Sep 14, 2021
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
Prev Previous commit
Next Next commit
Fixed wrongly returning error for valid descriptions
  • Loading branch information
@svera
svera committed Sep 14, 2021
commit e92e17db5e3eae31dc258cbe2ed0ac8f6a36df19
5 changes: 3 additions & 2 deletions Magento2/Sniffs/Commenting/ClassPropertyPHPDocFormattingSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,16 +143,17 @@ public function processMemberVar(File $phpcsFile, $stackPtr)
return;
};
$propertyName = trim($tokens[$propertyNamePosition]['content'], '$');
$shortDescription = strtolower($tokens[$isShortDescriptionPreviousVar]['content']);

if (strtolower($tokens[$isShortDescriptionPreviousVar]['content']) === strtolower($propertyName)) {
if ($shortDescription === strtolower($propertyName)) {
$error = 'Short description duplicates class property name.';
$phpcsFile->addWarning($error, $isShortDescriptionPreviousVar, 'AlreadyHaveMeaningfulNameVar');
return;
}

$propertyNameParts = array_filter(preg_split('/(?=[A-Z])/', $propertyName));

if (strtolower($tokens[$isShortDescriptionPreviousVar]['content']) === strtolower(implode(' ', $propertyNameParts))) {
if ($shortDescription === strtolower(implode(' ', $propertyNameParts))) {
$error = 'Short description duplicates class property name.';
$phpcsFile->addWarning($error, $isShortDescriptionPreviousVar, 'AlreadyHaveMeaningfulNameVar');
}
Expand Down