Merge pull request #254 from magento-l3/ACP2E-2674

victor-v-rad · web-flow · commit 372d4c6ff285 · 2023-12-04T11:50:24.000-06:00
ACP2E-2674: [MCS] Fix duplicate "Comment block is missing"
diff --git a/Magento2/Sniffs/Annotation/MethodAnnotationStructureSniff.php b/Magento2/Sniffs/Annotation/MethodAnnotationStructureSniff.php
@@ -71,7 +71,7 @@ public function process(File $phpcsFile, $stackPtr)
         } while ($commentEndPtr !== false && !in_array($tokens[$commentEndPtr]['code'], $tokensToFind, true));
 
         if ($commentEndPtr === false || $tokens[$commentEndPtr]['code'] !== \T_DOC_COMMENT_CLOSE_TAG) {
-            $phpcsFile->addError('Comment block is missing', $stackPtr, 'MethodArguments');
+            $phpcsFile->addError('Comment block is missing', $stackPtr, 'NoCommentBlock');
             return;
         }
 
diff --git a/Magento2/ruleset.xml b/Magento2/ruleset.xml
@@ -758,6 +758,8 @@
         <exclude-pattern>*/Test/*</exclude-pattern>
         <exclude-pattern>*Test.php</exclude-pattern>
         <exclude-pattern>*/PHPCSUtils/*</exclude-pattern>
+        <!-- duplicates Magento2.Annotation.MethodAnnotationStructure.NoCommentBlock-->
+        <exclude name="Magento2.Annotation.MethodArguments.NoCommentBlock"/>
     </rule>
 
     <rule ref="Internal.NoCodeFound">

Original file line number	Diff line number	Diff line change
`@@ -71,7 +71,7 @@ public function process(File $phpcsFile, $stackPtr)`
`71`	`71`	`} while ($commentEndPtr !== false && !in_array($tokens[$commentEndPtr]['code'], $tokensToFind, true));`
`72`	`72`
`73`	`73`	`if ($commentEndPtr === false \|\| $tokens[$commentEndPtr]['code'] !== \T_DOC_COMMENT_CLOSE_TAG) {`
`74`		`- $phpcsFile->addError('Comment block is missing', $stackPtr, 'MethodArguments');`
	`74`	`+ $phpcsFile->addError('Comment block is missing', $stackPtr, 'NoCommentBlock');`
`75`	`75`	`return;`
`76`	`76`	`}`
`77`	`77`