Merge pull request #28 from Lassombria/add-array-doc-like-vector-rule

add array doc like vector rule

Author: ZhukV

src/PhpCs/FiveLab/ErrorCodes.php

@@ -31,4 +31,5 @@ final class ErrorCodes
     public const LINE_BEFORE_NOT_ALLOWED = 'LineBeforeNotAllowed';
     public const MISSED_CONSTANT_TYPE    = 'MissedConstantType';
     public const NAMESPACE_WRONG         = 'NamespaceWrong';
+    public const ARRAYS_DOC_VECTOR       = 'ArraysDocVector';
 }

src/PhpCs/FiveLab/Sniffs/AbstractFunctionDocCommentSniff.php

@@ -16,9 +16,6 @@
 use PHP_CodeSniffer\Files\File;
 use PHP_CodeSniffer\Sniffs\Sniff;
 
-/**
- * Abstract sniff for check doc comments.
- */
 abstract class AbstractFunctionDocCommentSniff implements Sniff
 {
     public function register(): array

src/PhpCs/FiveLab/Sniffs/Commenting/AnnotationsSniff.php

@@ -17,9 +17,6 @@
 use FiveLab\Component\CiRules\PhpCs\FiveLab\Sniffs\AbstractFunctionDocCommentSniff;
 use PHP_CodeSniffer\Files\File;
 
-/**
- * Check annotations in comments.
- */
 class AnnotationsSniff extends AbstractFunctionDocCommentSniff
 {
     protected function processLines(File $phpcsFile, int $startLineNumber, array $lines, string $functionName, int $countCommentLines): void
@@ -60,5 +57,13 @@ private function processAnnotation(File $phpcsFile, int $lineNumber, string $ann
                 );
             }
         }
+
+        if (\str_contains($value, '[]')) {
+            $phpcsFile->addErrorOnLine(
+                'Please use vector type annotation for arrays.',
+                $lineNumber,
+                ErrorCodes::ARRAYS_DOC_VECTOR
+            );
+        }
     }
 }

tests/PhpCs/FiveLab/Sniffs/Commenting/AnnotationsSniffTest.php

@@ -40,6 +40,18 @@ public static function provideDataSet(): array
                     'message' => 'Please import error class in "use" block and use short class name in @throws annotation.',
                     'source'  => 'FiveLab.Commenting.Annotations.Prohibited',
                 ],
+                [
+                    'message' => 'Please use vector type annotation for arrays.',
+                    'source'  => 'FiveLab.Commenting.Annotations.ArraysDocVector',
+                ],
+                [
+                    'message' => 'Please use vector type annotation for arrays.',
+                    'source'  => 'FiveLab.Commenting.Annotations.ArraysDocVector',
+                ],
+                [
+                    'message' => 'Please use vector type annotation for arrays.',
+                    'source'  => 'FiveLab.Commenting.Annotations.ArraysDocVector',
+                ],
             ],
         ];
     }

tests/PhpCs/FiveLab/Sniffs/Commenting/Resources/annotations/success.php

@@ -22,3 +22,14 @@ function bar(int $a, string $b): int
 {
     return 1;
 }
+
+/**
+ * @param array<string> $a
+ * @param array<SomeObject> $b
+ * @param array<int, string> $c
+ *
+ * @return array<string|SomeObject>
+ */
+function baz(array $a, array $b, array $c): array
+{
+}

tests/PhpCs/FiveLab/Sniffs/Commenting/Resources/annotations/wrong.php

@@ -20,3 +20,13 @@ function bar(): int
 {
     return 1;
 }
+
+/**
+ * @param SomeObject[] $a
+ * @param string[] $b
+ *
+ * @return int[]
+ */
+function baz(array $a, array $b, array $c): array
+{
+}