CS: remove blank line at end of functions

These made sense for readability with the noisy `//end ...` comments, but not without those... they really are not needed.

Includes removing the rule from the PHPCS native ruleset and adding another one to enforce the opposite, i.e. no blank line between function body and close curly.

Includes updating the comment format used for "required method which we don't use" comments in four sniffs to not run into "Empty line required after block comment" issues.

Author: jrfnl

autoload.php

@@ -140,7 +140,6 @@ public static function load(string $className)
             }
 
             return false;
-
         }
 
 
@@ -183,7 +182,6 @@ public static function loadFile(string $path)
             self::$loadedClasses[$path]    = $className;
             self::$loadedFiles[$className] = $path;
             return self::$loadedClasses[$path];
-
         }
 
 
@@ -244,7 +242,6 @@ static function ($remaining, $current) {
             }
 
             return $className;
-
         }
 
 
@@ -259,7 +256,6 @@ static function ($remaining, $current) {
         public static function addSearchPath(string $path, string $nsPrefix = '')
         {
             self::$searchPaths[$path] = rtrim(trim((string) $nsPrefix), '\\');
-
         }
 
 
@@ -271,7 +267,6 @@ public static function addSearchPath(string $path, string $nsPrefix = '')
         public static function getSearchPaths()
         {
             return self::$searchPaths;
-
         }
 
 
@@ -290,7 +285,6 @@ public static function getLoadedClassName(string $path)
             }
 
             return self::$loadedClasses[$path];
-
         }
 
 
@@ -309,7 +303,6 @@ public static function getLoadedFileName(string $className)
             }
 
             return self::$loadedFiles[$className];
-
         }
 
 
@@ -321,7 +314,6 @@ public static function getLoadedFileName(string $className)
         public static function getLoadedClasses()
         {
             return self::$loadedClasses;
-
         }
 
 
@@ -333,7 +325,6 @@ public static function getLoadedClasses()
         public static function getLoadedFiles()
         {
             return self::$loadedFiles;
-
         }
 
 

phpcs.xml.dist

@@ -64,7 +64,10 @@
     <rule ref="Squiz.Strings.DoubleQuoteUsage.NotRequired"/>
     <rule ref="Generic.Strings.UnnecessaryHeredoc"/>
     <rule ref="Squiz.WhiteSpace.ControlStructureSpacing"/>
-    <rule ref="Squiz.WhiteSpace.FunctionClosingBraceSpace"/>
+    <rule ref="Squiz.WhiteSpace.FunctionClosingBraceSpace">
+        <exclude name="Squiz.WhiteSpace.FunctionClosingBraceSpace.SpacingBeforeClose"/>
+    </rule>
+    <rule ref="PSR2.Methods.FunctionClosingBrace"/>
     <rule ref="Squiz.WhiteSpace.FunctionSpacing"/>
     <rule ref="Squiz.WhiteSpace.MemberVarSpacing"/>
     <rule ref="PSR12.Operators.OperatorSpacing"/>

requirements.php

@@ -69,5 +69,4 @@ function checkRequirements()
         fwrite(STDERR, sprintf($error, $required, $missing));
         exit($exitCode);
     }
-
 }

scripts/BuildRequirementsCheckMatrix.php

@@ -71,7 +71,6 @@ public function getBuilds()
         );
 
         return $builds;
-
     }
 
 
@@ -105,7 +104,6 @@ private function getValidBuilds()
         }
 
         return $builds;
-
     }
 
 
@@ -137,7 +135,6 @@ private function getInvalidPHPBuilds()
         }
 
         return $builds;
-
     }
 
 
@@ -181,7 +178,6 @@ private function getMissingExtensionsBuilds()
         }//end foreach
 
         return $builds;
-
     }
 
 

scripts/build-phar.php

@@ -75,7 +75,6 @@ function stripWhitespaceAndComments(string $fullpath, Config $config)
     }
 
     return $stripped;
-
 }
 
 

src/Config.php

@@ -275,7 +275,6 @@ public function __get(string $name)
         }
 
         return $this->settings[$name];
-
     }
 
 
@@ -348,7 +347,6 @@ public function __set(string $name, $value)
         }//end switch
 
         $this->settings[$name] = $value;
-
     }
 
 
@@ -362,7 +360,6 @@ public function __set(string $name, $value)
     public function __isset(string $name)
     {
         return isset($this->settings[$name]);
-
     }
 
 
@@ -376,7 +373,6 @@ public function __isset(string $name)
     public function __unset(string $name)
     {
         $this->settings[$name] = null;
-
     }
 
 
@@ -388,7 +384,6 @@ public function __unset(string $name)
     public function getSettings()
     {
         return $this->settings;
-
     }
 
 
@@ -402,7 +397,6 @@ public function getSettings()
     public function setSettings(array $settings)
     {
         $this->settings = $settings;
-
     }
 
 
@@ -487,7 +481,6 @@ public function __construct(array $cliArgs = [], bool $dieOnUnknownArg = true)
         }//end if
 
         fclose($handle);
-
     }
 
 
@@ -538,7 +531,6 @@ public function setCommandLineValues(array $args)
                 $this->processUnknownArgument($arg, $i);
             }//end if
         }//end for
-
     }
 
 
@@ -662,7 +654,6 @@ public function restoreDefaults()
         if ($parallel !== null) {
             $this->parallel = max((int) $parallel, 1);
         }
-
     }
 
 
@@ -774,7 +765,6 @@ public function processShortArgument(string $arg, int $pos)
                 $this->processUnknownArgument('-' . $arg, $pos);
             }
         }//end switch
-
     }
 
 
@@ -1306,7 +1296,6 @@ public function processLongArgument(string $arg, int $pos)
             }//end if
             break;
         }//end switch
-
     }
 
 
@@ -1393,7 +1382,6 @@ static function ($carry, $item) {
         }
 
         return $sniffs;
-
     }
 
 
@@ -1422,7 +1410,6 @@ public function processUnknownArgument(string $arg, int $pos)
         }
 
         $this->processFilePath($arg);
-
     }
 
 
@@ -1458,7 +1445,6 @@ public function processFilePath(string $path)
             $this->files = $files;
             $this->overriddenDefaults['files'] = true;
         }
-
     }
 
 
@@ -1478,7 +1464,6 @@ public function printUsage()
         }
 
         echo PHP_EOL;
-
     }
 
 
@@ -1505,7 +1490,6 @@ public function printShortUsage(bool $returnOutput = false)
         }
 
         echo $usage;
-
     }
 
 
@@ -1531,7 +1515,6 @@ public function printPHPCSUsage()
         $shortOptions = Help::DEFAULT_SHORT_OPTIONS . 'aems';
 
         (new Help($this, $longOptions, $shortOptions))->display();
-
     }
 
 
@@ -1547,7 +1530,6 @@ public function printPHPCBFUsage()
         $shortOptions  = Help::DEFAULT_SHORT_OPTIONS;
 
         (new Help($this, $longOptions, $shortOptions))->display();
-
     }
 
 
@@ -1573,7 +1555,6 @@ public static function getConfigData(string $key)
         }
 
         return $phpCodeSnifferConfig[$key];
-
     }
 
 
@@ -1614,7 +1595,6 @@ public static function getExecutablePath(string $name)
 
         self::$executablePaths[$name] = $result;
         return $result;
-
     }
 
 
@@ -1696,7 +1676,6 @@ public function setConfigData(string $key, ?string $value, bool $temp = false)
         }
 
         return true;
-
     }
 
 
@@ -1738,7 +1717,6 @@ public static function getAllConfigData()
         self::$configDataFile = $configFile;
         self::$configData     = $phpCodeSnifferConfig;
         return self::$configData;
-
     }
 
 
@@ -1773,7 +1751,6 @@ public function prepareConfigDataForDisplay(array $data)
         }
 
         return $output;
-
     }
 
 
@@ -1789,7 +1766,6 @@ public function prepareConfigDataForDisplay(array $data)
     public function printConfigData(array $data)
     {
         echo $this->prepareConfigDataForDisplay($data);
-
     }
 
 

src/Files/DummyFile.php

@@ -55,7 +55,6 @@ public function __construct(string $content, Ruleset $ruleset, Config $config)
         }
 
         parent::__construct($path, $ruleset, $config);
-
     }
 
 
@@ -85,7 +84,6 @@ public function setErrorCounts(
         $this->fixableWarningCount = $fixableWarningCount;
         $this->fixedErrorCount     = $fixedErrorCount;
         $this->fixedWarningCount   = $fixedWarningCount;
-
     }