✨ Discourage empty function

Author: VincentLanglet

SymfonyCustom/Sniffs/Arrays/ArrayDeclarationSniff.php

@@ -472,8 +472,8 @@ public function processMultiLineArray(File $phpcsFile, int $stackPtr, int $start
             }
         }
 
-        if (!empty($indices)) {
-            $count = count($indices);
+        $count = count($indices);
+        if ($count > 0) {
             $lastIndex = $indices[($count - 1)]['value'];
 
             $trailingContent = $phpcsFile->findPrevious(
@@ -499,12 +499,12 @@ public function processMultiLineArray(File $phpcsFile, int $stackPtr, int $start
 
             $lastValueLine = $stackPtr;
             foreach ($indices as $value) {
-                if (!empty($value['arrow'])) {
+                if (isset($value['arrow'])) {
                     // Array value with arrow are checked later cause there is more checks.
                     continue;
                 }
 
-                if (empty($value['value'])) {
+                if (!isset($value['value'])) {
                     // Array was malformed, so we have to ignore it.
                     // Other parts of this sniff will correct the error.
                     continue;

SymfonyCustom/Sniffs/Namespaces/AlphabeticallySortedUseSniff.php

@@ -99,9 +99,7 @@ public function process(File $phpcsFile, $stackPtr): int
             $lastUse = $use;
         }
 
-        return T_OPEN_TAG === $tokens[$stackPtr]['code']
-            ? $phpcsFile->numTokens + 1
-            : $stackPtr + 1;
+        return T_OPEN_TAG === $tokens[$stackPtr]['code'] ? $phpcsFile->numTokens + 1 : $stackPtr + 1;
     }
 
     /**

SymfonyCustom/Sniffs/PHP/DiscourageEmptySniff.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace SymfonyCustom\Sniffs\PHP;
+
+use PHP_CodeSniffer\Standards\Generic\Sniffs\PHP\ForbiddenFunctionsSniff;
+
+/**
+ * Class DiscourageEmptySniff
+ */
+class DiscourageEmptySniff extends ForbiddenFunctionsSniff
+{
+    /**
+     * @var array
+     */
+    public $forbiddenFunctions = ['empty' => null];
+
+    /**
+     * @var bool
+     */
+    public $error = false;
+}

SymfonyCustom/Tests/Arrays/ArrayDeclarationUnitTest.php

@@ -12,12 +12,7 @@
 class ArrayDeclarationUnitTest extends AbstractSniffUnitTest
 {
     /**
-     * Returns the lines where errors should occur.
-     *
-     * The key of the array should represent the line number and the value
-     * should represent the number of errors that should occur on that line.
-     *
-     * @return array<int, int>
+     * @return array
      */
     protected function getErrorList(): array
     {
@@ -58,12 +53,7 @@ protected function getErrorList(): array
     }
 
     /**
-     * Returns the lines where warnings should occur.
-     *
-     * The key of the array should represent the line number and the value
-     * should represent the number of warnings that should occur on that line.
-     *
-     * @return array<int, int>
+     * @return array
      */
     protected function getWarningList(): array
     {

SymfonyCustom/Tests/Classes/ClassDeclarationUnitTest.php

@@ -12,12 +12,7 @@
 class ClassDeclarationUnitTest extends AbstractSniffUnitTest
 {
     /**
-     * Returns the lines where errors should occur.
-     *
-     * The key of the array should represent the line number and the value
-     * should represent the number of errors that should occur on that line.
-     *
-     * @return array<int, int>
+     * @return array
      */
     protected function getErrorList(): array
     {
@@ -28,12 +23,7 @@ protected function getErrorList(): array
     }
 
     /**
-     * Returns the lines where warnings should occur.
-     *
-     * The key of the array should represent the line number and the value
-     * should represent the number of errors that should occur on that line.
-     *
-     * @return array(int => int)
+     * @return array
      */
     protected function getWarningList(): array
     {

SymfonyCustom/Tests/Classes/PropertyDeclarationUnitTest.php

@@ -12,12 +12,7 @@
 class PropertyDeclarationUnitTest extends AbstractSniffUnitTest
 {
     /**
-     * Returns the lines where errors should occur.
-     *
-     * The key of the array should represent the line number and the value
-     * should represent the number of errors that should occur on that line.
-     *
-     * @return array<int, int>
+     * @return array
      */
     protected function getErrorList(): array
     {
@@ -27,12 +22,7 @@ protected function getErrorList(): array
     }
 
     /**
-     * Returns the lines where warnings should occur.
-     *
-     * The key of the array should represent the line number and the value
-     * should represent the number of errors that should occur on that line.
-     *
-     * @return array(int => int)
+     * @return array
      */
     protected function getWarningList(): array
     {

SymfonyCustom/Tests/Commenting/ClassCommentUnitTest.php

@@ -12,12 +12,7 @@
 class ClassCommentUnitTest extends AbstractSniffUnitTest
 {
     /**
-     * Returns the lines where errors should occur.
-     *
-     * The key of the array should represent the line number and the value
-     * should represent the number of errors that should occur on that line.
-     *
-     * @return array<int, int>
+     * @return array
      */
     protected function getErrorList(): array
     {
@@ -27,12 +22,7 @@ protected function getErrorList(): array
     }
 
     /**
-     * Returns the lines where warnings should occur.
-     *
-     * The key of the array should represent the line number and the value
-     * should represent the number of warnings that should occur on that line.
-     *
-     * @return array(int => int)
+     * @return array
      */
     protected function getWarningList(): array
     {

SymfonyCustom/Tests/Commenting/DocCommentForbiddenTagsUnitTest.php

@@ -12,12 +12,7 @@
 class DocCommentForbiddenTagsUnitTest extends AbstractSniffUnitTest
 {
     /**
-     * Returns the lines where errors should occur.
-     *
-     * The key of the array should represent the line number and the value
-     * should represent the number of errors that should occur on that line.
-     *
-     * @return array<int, int>
+     * @return array
      */
     protected function getErrorList(): array
     {
@@ -32,12 +27,7 @@ protected function getErrorList(): array
     }
 
     /**
-     * Returns the lines where warnings should occur.
-     *
-     * The key of the array should represent the line number and the value
-     * should represent the number of warnings that should occur on that line.
-     *
-     * @return array(int => int)
+     * @return array
      */
     protected function getWarningList(): array
     {

SymfonyCustom/Tests/Commenting/DocCommentGroupSameTypeUnitTest.php

@@ -12,12 +12,7 @@
 class DocCommentGroupSameTypeUnitTest extends AbstractSniffUnitTest
 {
     /**
-     * Returns the lines where errors should occur.
-     *
-     * The key of the array should represent the line number and the value
-     * should represent the number of errors that should occur on that line.
-     *
-     * @return array<int, int>
+     * @return array
      */
     protected function getErrorList(): array
     {
@@ -37,12 +32,7 @@ protected function getErrorList(): array
     }
 
     /**
-     * Returns the lines where warnings should occur.
-     *
-     * The key of the array should represent the line number and the value
-     * should represent the number of warnings that should occur on that line.
-     *
-     * @return array(int => int)
+     * @return array
      */
     protected function getWarningList(): array
     {

SymfonyCustom/Tests/Commenting/DocCommentUnitTest.php

@@ -12,12 +12,7 @@
 class DocCommentUnitTest extends AbstractSniffUnitTest
 {
     /**
-     * Returns the lines where errors should occur.
-     *
-     * The key of the array should represent the line number and the value
-     * should represent the number of errors that should occur on that line.
-     *
-     * @return array<int, int>
+     * @return array
      */
     protected function getErrorList(): array
     {
@@ -37,12 +32,7 @@ protected function getErrorList(): array
     }
 
     /**
-     * Returns the lines where warnings should occur.
-     *
-     * The key of the array should represent the line number and the value
-     * should represent the number of warnings that should occur on that line.
-     *
-     * @return array(int => int)
+     * @return array
      */
     protected function getWarningList(): array
     {

SymfonyCustom/Tests/Commenting/FunctionCommentUnitTest.php

@@ -12,12 +12,7 @@
 class FunctionCommentUnitTest extends AbstractSniffUnitTest
 {
     /**
-     * Returns the lines where errors should occur.
-     *
-     * The key of the array should represent the line number and the value
-     * should represent the number of errors that should occur on that line.
-     *
-     * @return array<int, int>
+     * @return array
      */
     protected function getErrorList(): array
     {
@@ -35,12 +30,7 @@ protected function getErrorList(): array
     }
 
     /**
-     * Returns the lines where warnings should occur.
-     *
-     * The key of the array should represent the line number and the value
-     * should represent the number of warnings that should occur on that line.
-     *
-     * @return array(int => int)
+     * @return array
      */
     protected function getWarningList(): array
     {

SymfonyCustom/Tests/Commenting/VariableCommentUnitTest.php

@@ -12,12 +12,7 @@
 class VariableCommentUnitTest extends AbstractSniffUnitTest
 {
     /**
-     * Returns the lines where errors should occur.
-     *
-     * The key of the array should represent the line number and the value
-     * should represent the number of errors that should occur on that line.
-     *
-     * @return array<int, int>
+     * @return array
      */
     protected function getErrorList(): array
     {
@@ -35,12 +30,7 @@ protected function getErrorList(): array
     }
 
     /**
-     * Returns the lines where warnings should occur.
-     *
-     * The key of the array should represent the line number and the value
-     * should represent the number of warnings that should occur on that line.
-     *
-     * @return array<int, int>
+     * @return array
      */
     protected function getWarningList(): array
     {

SymfonyCustom/Tests/Errors/ExceptionMessageUnitTest.php

@@ -12,12 +12,7 @@
 class ExceptionMessageUnitTest extends AbstractSniffUnitTest
 {
     /**
-     * Returns the lines where errors should occur.
-     *
-     * The key of the array should represent the line number and the value
-     * should represent the number of errors that should occur on that line.
-     *
-     * @return array<int, int>
+     * @return array
      */
     protected function getErrorList(): array
     {
@@ -27,12 +22,7 @@ protected function getErrorList(): array
     }
 
     /**
-     * Returns the lines where warnings should occur.
-     *
-     * The key of the array should represent the line number and the value
-     * should represent the number of errors that should occur on that line.
-     *
-     * @return array(int => int)
+     * @return array
      */
     protected function getWarningList(): array
     {

SymfonyCustom/Tests/Errors/UserDeprecatedUnitTest.php

@@ -12,12 +12,7 @@
 class UserDeprecatedUnitTest extends AbstractSniffUnitTest
 {
     /**
-     * Returns the lines where errors should occur.
-     *
-     * The key of the array should represent the line number and the value
-     * should represent the number of errors that should occur on that line.
-     *
-     * @return array<int, int>
+     * @return array
      */
     protected function getErrorList(): array
     {
@@ -27,12 +22,7 @@ protected function getErrorList(): array
     }
 
     /**
-     * Returns the lines where warnings should occur.
-     *
-     * The key of the array should represent the line number and the value
-     * should represent the number of errors that should occur on that line.
-     *
-     * @return array(int => int)
+     * @return array
      */
     protected function getWarningList(): array
     {

SymfonyCustom/Tests/Formatting/BlankLineBeforeReturnUnitTest.php

@@ -12,12 +12,7 @@
 class BlankLineBeforeReturnUnitTest extends AbstractSniffUnitTest
 {
     /**
-     * Returns the lines where errors should occur.
-     *
-     * The key of the array should represent the line number and the value
-     * should represent the number of errors that should occur on that line.
-     *
-     * @return array(int => int)
+     * @return array
      */
     protected function getErrorList(): array
     {
@@ -29,12 +24,7 @@ protected function getErrorList(): array
     }
 
     /**
-     * Returns the lines where warnings should occur.
-     *
-     * The key of the array should represent the line number and the value
-     * should represent the number of errors that should occur on that line.
-     *
-     * @return array(int => int)
+     * @return array
      */
     protected function getWarningList(): array
     {