Merge pull request #21 from php-collective/next

dereuromark · web-flow · commit 925a2007b268 · 2024-12-19T15:55:03.000+01:00
Trailing comma sniffs.
diff --git a/PhpCollective/Sniffs/AbstractSniffs/AbstractSniff.php b/PhpCollective/Sniffs/AbstractSniffs/AbstractSniff.php
@@ -584,7 +584,7 @@ protected function getMethodSignatureMultilineLength(
         array $tokens,
         int $stackPtr,
         array $methodProperties,
-        array $methodParameters
+        array $methodParameters,
     ): int {
         $totalLength = $this->getMethodSingleLineSignatureLength($tokens, $stackPtr);
         $firstLineEndPosition = $this->getLineEndingPosition($tokens, $stackPtr);
diff --git a/PhpCollective/Sniffs/Classes/MethodArgumentDefaultValueSniff.php b/PhpCollective/Sniffs/Classes/MethodArgumentDefaultValueSniff.php
@@ -147,11 +147,9 @@ protected function removeDefaultArgument(File $phpcsFile, int $startIndex, int $
      */
     protected function isTypehintedNullableVariable(File $phpcsFile, int $index): bool
     {
-        $tokens = $phpcsFile->getTokens();
-
-        $nextIndex = $phpcsFile->findNext(Tokens::$emptyTokens, $index + 1, null, true);
-
-        $nextToken = $tokens[$nextIndex];
+        //$tokens = $phpcsFile->getTokens();
+        //$nextIndex = $phpcsFile->findNext(Tokens::$emptyTokens, $index + 1, null, true);
+        //$nextToken = $tokens[$nextIndex];
 
         /*
         if (!$nextToken->equals([T_STRING, 'null'], false)) {
diff --git a/PhpCollective/Sniffs/Commenting/DisallowArrayTypeHintSyntaxSniff.php b/PhpCollective/Sniffs/Commenting/DisallowArrayTypeHintSyntaxSniff.php
@@ -307,7 +307,7 @@ protected function findGenericIdentifier(
         File $phpcsFile,
         int $docCommentOpenPointer,
         TypeNode $typeNode,
-        PhpDocTagValueNode $annotationValue
+        PhpDocTagValueNode $annotationValue,
     ): ?string {
         if (!$typeNode instanceof UnionTypeNode) {
             if (!$annotationValue instanceof ParamTagValueNode && !$annotationValue instanceof ReturnTagValueNode) {
@@ -501,7 +501,7 @@ protected function fixGenericObjectCollection(
         Annotation $annotation,
         int $docCommentOpenPointer,
         ArrayTypeNode $typeNode,
-        array $unionTypeNodes
+        array $unionTypeNodes,
     ): void {
         $genericType = null;
         $arrayType = null;
diff --git a/PhpCollective/Sniffs/Commenting/DocBlockConstSniff.php b/PhpCollective/Sniffs/Commenting/DocBlockConstSniff.php
@@ -236,7 +236,7 @@ protected function handleMissingVar(
         File $phpCsFile,
         int $docBlockEndIndex,
         int $docBlockStartIndex,
-        ?string $defaultValueType
+        ?string $defaultValueType,
     ): void {
         $error = 'Doc Block annotation @var for const missing';
 
diff --git a/PhpCollective/Sniffs/Commenting/DocBlockReturnNullableTypeSniff.php b/PhpCollective/Sniffs/Commenting/DocBlockReturnNullableTypeSniff.php
@@ -160,7 +160,7 @@ public function assertNotNullableReturnType(File $phpCsFile, int $stackPointer,
     public function assertRequiredNullableReturnType(
         File $phpCsFile,
         int $stackPointer,
-        array $docBlockReturnTypes
+        array $docBlockReturnTypes,
     ): void {
         if (!$docBlockReturnTypes) {
             return;
diff --git a/PhpCollective/Sniffs/Commenting/DocBlockReturnSelfSniff.php b/PhpCollective/Sniffs/Commenting/DocBlockReturnSelfSniff.php
@@ -98,7 +98,7 @@ protected function assertCorrectDocBlockParts(
         int $classNameIndex,
         array $parts,
         array $returnTypes,
-        string $appendix
+        string $appendix,
     ): void {
         $result = [];
         foreach ($parts as $key => $part) {
@@ -185,7 +185,7 @@ protected function fixClassToThis(
         int $classNameIndex,
         array $parts,
         string $appendix,
-        array $returnTypes
+        array $returnTypes,
     ): void {
         $ownClassName = '\\' . $this->getClassName($phpCsFile);
 
@@ -295,7 +295,7 @@ protected function assertChainableReturnType(
         File $phpCsFile,
         int $stackPointer,
         array $parts,
-        array $returnTypes
+        array $returnTypes,
     ): void {
         if ($returnTypes && $parts === ['$this'] && $returnTypes !== ['$this']) {
             $phpCsFile->addError('Chainable method (@return $this) cannot have multiple return types in code.', $stackPointer, 'InvalidChainable');
diff --git a/PhpCollective/Sniffs/Commenting/DocBlockReturnVoidSniff.php b/PhpCollective/Sniffs/Commenting/DocBlockReturnVoidSniff.php
@@ -181,7 +181,7 @@ protected function addReturnAnnotation(
         File $phpcsFile,
         int $docBlockStartIndex,
         int $docBlockEndIndex,
-        string $returnType = 'void'
+        string $returnType = 'void',
     ): void {
         $indentation = $this->getIndentationWhitespace($phpcsFile, $docBlockEndIndex);
 
@@ -250,7 +250,7 @@ protected function assertExisting(
         File $phpcsFile,
         int $pointer,
         int $docBlockReturnIndex,
-        ?string $returnType
+        ?string $returnType,
     ): void {
         $tokens = $phpcsFile->getTokens();
 
diff --git a/PhpCollective/Sniffs/Commenting/DocBlockTagIterableSniff.php b/PhpCollective/Sniffs/Commenting/DocBlockTagIterableSniff.php
@@ -40,7 +40,7 @@ public function process(File $phpcsFile, $stackPtr): void
 
         $tag = $content;
         if (str_contains($tag, ' ')) {
-            [$tag, $description] = explode(' ', $content, 2);
+            [$tag] = explode(' ', $content, 2);
         }
 
         if (!preg_match('#^@(?:[a-z]+-)?(?:param|return|var)\b#i', $tag)) {
diff --git a/PhpCollective/Sniffs/Commenting/DocBlockThrowsSniff.php b/PhpCollective/Sniffs/Commenting/DocBlockThrowsSniff.php
@@ -251,7 +251,7 @@ protected function compareExceptionsAndAnnotations(
         File $phpCsFile,
         array $exceptions,
         array $annotations,
-        int $docBlockEndIndex
+        int $docBlockEndIndex,
     ): void {
         $useStatements = $this->getUseStatements($phpCsFile);
 
diff --git a/PhpCollective/Sniffs/Commenting/DocBlockVarSniff.php b/PhpCollective/Sniffs/Commenting/DocBlockVarSniff.php
@@ -214,7 +214,7 @@ protected function handleMissingVar(
         File $phpCsFile,
         int $docBlockEndIndex,
         int $docBlockStartIndex,
-        ?string $defaultValueType
+        ?string $defaultValueType,
     ): void {
         $error = 'Doc Block annotation @var for property missing';
         if ($defaultValueType === null) {
diff --git a/PhpCollective/Sniffs/Commenting/DocCommentSniff.php b/PhpCollective/Sniffs/Commenting/DocCommentSniff.php
@@ -128,12 +128,10 @@ public function process(File $phpcsFile, $stackPtr): void
 
         // Account for the fact that a short description might cover
         // multiple lines.
-        $shortContent = $tokens[$short]['content'];
         $shortEnd = $short;
         for ($i = ($short + 1); $i < $commentEnd; $i++) {
             if ($tokens[$i]['code'] === T_DOC_COMMENT_STRING) {
                 if ($tokens[$i]['line'] === ($tokens[$shortEnd]['line'] + 1)) {
-                    $shortContent .= $tokens[$i]['content'];
                     $shortEnd = $i;
                 } else {
                     break;
diff --git a/PhpCollective/Sniffs/Commenting/TypeHintSniff.php b/PhpCollective/Sniffs/Commenting/TypeHintSniff.php
@@ -117,7 +117,12 @@ public function process(File $phpcsFile, $stackPtr): void
 
             $tagComment = $phpcsFile->fixer->getTokenContent($tag + 2);
             $valueNode = static::getValueNode($tokens[$tag]['content'], $tagComment);
+
             if ($valueNode instanceof InvalidTagValueNode || $valueNode instanceof TypelessParamTagValueNode) {
+                if (!isset($valueNode->type)) {
+                    $phpcsFile->addWarning('%s type hint is missing', $tag, 'MissingParamType', [$tokens[$tag]['content']]);
+                }
+
                 continue;
             }
 
diff --git a/PhpCollective/Sniffs/ControlStructures/NoInlineAssignmentSniff.php b/PhpCollective/Sniffs/ControlStructures/NoInlineAssignmentSniff.php
@@ -67,7 +67,7 @@ protected function isFixableInlineAssignment(
         File $phpcsFile,
         int $startIndex,
         int $endIndex,
-        int &$indexEqualSign
+        int &$indexEqualSign,
     ): bool {
         $tokens = $phpcsFile->getTokens();
 
diff --git a/PhpCollective/Sniffs/PHP/ExitSniff.php b/PhpCollective/Sniffs/PHP/ExitSniff.php
@@ -48,8 +48,7 @@ public function process(File $phpcsFile, $stackPtr): void
      */
     protected function checkExitUsage(File $phpcsFile, int $stackPtr): void
     {
-        $wrongTokens = [T_FUNCTION, T_OBJECT_OPERATOR, T_NEW, T_DOUBLE_COLON];
-
+        //$wrongTokens = [T_FUNCTION, T_OBJECT_OPERATOR, T_NEW, T_DOUBLE_COLON];
         $tokens = $phpcsFile->getTokens();
 
         $tokenContent = $tokens[$stackPtr]['content'];
diff --git a/PhpCollective/Sniffs/PHP/PreferCastOverFunctionSniff.php b/PhpCollective/Sniffs/PHP/PreferCastOverFunctionSniff.php
@@ -87,7 +87,7 @@ protected function fixContent(
         int $stackPtr,
         string $key,
         int $openingBraceIndex,
-        int $closingBraceIndex
+        int $closingBraceIndex,
     ): void {
         $needsBrackets = $this->needsBrackets($phpcsFile, $openingBraceIndex, $closingBraceIndex);
 
diff --git a/PhpCollective/Sniffs/Testing/ExpectExceptionSniff.php b/PhpCollective/Sniffs/Testing/ExpectExceptionSniff.php
@@ -51,7 +51,7 @@ public function process(File $phpcsFile, $stackPtr): void
      */
     protected function assertNoAssertsAfterExpectException(
         File $phpcsFile,
-        int $stackPtr
+        int $stackPtr,
     ): void {
         $tokens = $phpcsFile->getTokens();
         if (empty($tokens[$stackPtr]['scope_opener'])) {
diff --git a/PhpCollective/Sniffs/Testing/MockSniff.php b/PhpCollective/Sniffs/Testing/MockSniff.php
@@ -61,7 +61,7 @@ protected function assertNoReturnTypehint(
         File $phpcsFile,
         int $stackPtr,
         ?TypeHint $returnTypeHint,
-        array $docBlockReturnTypes
+        array $docBlockReturnTypes,
     ): void {
         if (!$returnTypeHint || $returnTypeHint->getTypeHint() !== 'MockObject') {
             return;
@@ -111,7 +111,7 @@ protected function assertDocBlockReturnAnnotation(
         File $phpcsFile,
         int $stackPtr,
         array $docBlockReturnTypes,
-        ?TypeHint $returnTypeHint
+        ?TypeHint $returnTypeHint,
     ): void {
         $hasMockAnnotation = $this->hasMockObjectAnnotation($docBlockReturnTypes);
 
diff --git a/PhpCollective/Sniffs/WhiteSpace/TernarySpacingSniff.php b/PhpCollective/Sniffs/WhiteSpace/TernarySpacingSniff.php
diff --git a/PhpCollective/ruleset.xml b/PhpCollective/ruleset.xml
diff --git a/docs/sniffs.md b/docs/sniffs.md
diff --git a/tests/TestCase.php b/tests/TestCase.php

Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ public function process(File $phpcsFile, $stackPtr): void`
`40`	`40`
`41`	`41`	`$tag = $content;`
`42`	`42`	`if (str_contains($tag, ' ')) {`
`43`		`- [$tag, $description] = explode(' ', $content, 2);`
	`43`	`+ [$tag] = explode(' ', $content, 2);`
`44`	`44`	`}`
`45`	`45`
`46`	`46`	`if (!preg_match('#^@(?:[a-z]+-)?(?:param\|return\|var)\b#i', $tag)) {`