Upgrade phpmyadmin/coding-standard to 3.0.0

Signed-off-by: Maurício Meneghini Fauth <mauricio@fauth.dev>
phpmyadmin · Apr 19, 2021 · 90778ee · 90778ee
1 parent 59e4dae
commit 90778ee
Show file tree

Hide file tree

Showing 12 changed files with 33 additions and 10 deletions.
diff --git a/composer.json b/composer.json
@@ -81,7 +81,7 @@
     },
     "require-dev": {
         "php-webdriver/webdriver": "^1.8",
-        "phpmyadmin/coding-standard": "^2.1.1",
+        "phpmyadmin/coding-standard": "^3.0.0",
         "phpstan/extension-installer": "^1.1",
         "phpstan/phpstan": "^0.12.79",
         "phpstan/phpstan-phpunit": "^0.12.17",

diff --git a/libraries/classes/Config/SpecialSchemaLinks.php b/libraries/classes/Config/SpecialSchemaLinks.php
@@ -46,7 +46,6 @@ class SpecialSchemaLinks
      * );
      *
      * @return array<string,array<string,array<string,array<string,array<int,array<string,string>>|string>>>>
-     *
      * @phpstan-return array<
      *              string, array<
      *                  string, array<

diff --git a/libraries/classes/Controllers/Server/Status/StatusController.php b/libraries/classes/Controllers/Server/Status/StatusController.php
@@ -66,9 +66,11 @@ public function index(): void
                     )
                 );
             }
+
             if (isset($this->data->status['Uptime'])) {
                 $uptime = Util::timespanFormat($this->data->status['Uptime']);
             }
+
             $startTime = Util::localisedDate($this->getStartTime());
 
             $traffic = $this->getTrafficInfo();

diff --git a/libraries/classes/Display/Results.php b/libraries/classes/Display/Results.php
@@ -3081,9 +3081,6 @@ private function getRowValues(
      * @param array<string,array<int,array<string,string>>|string> $linkRelations
      * @param string                                               $columnValue   column value
      * @param array                                                $rowInfo       information about row
-     *
-     * @return string generated link
-     *
      * @phpstan-param array{
      *                         'link_param': string,
      *                         'link_dependancy_params'?: array<
@@ -3092,6 +3089,8 @@ private function getRowValues(
      *                                                     >,
      *                         'default_page': string
      *                     } $linkRelations
+     *
+     * @return string generated link
      */
     private function getSpecialLinkUrl(
         array $linkRelations,

diff --git a/libraries/classes/Footer.php b/libraries/classes/Footer.php
@@ -76,7 +76,6 @@ public function __construct()
 
     /**
      * @return array<string, string>
-     *
      * @psalm-return array{revision: string, revisionUrl: string, branch: string, branchUrl: string}|[]
      */
     private function getGitRevisionInfo(): array

diff --git a/libraries/classes/Gis/GisVisualization.php b/libraries/classes/Gis/GisVisualization.php
@@ -728,6 +728,7 @@ private function prepareDataSet(array $data, array $scale_data, $format, $result
             if (! is_string($ref_data)) {
                 continue;
             }
+
             $type_pos = mb_strpos($ref_data, '(');
             if ($type_pos === false) {
                 continue;

diff --git a/libraries/classes/Git.php b/libraries/classes/Git.php
@@ -542,6 +542,7 @@ private function getCommonDirContents(string $gitFolder): ?string
         if (! is_file($gitFolder . '/commondir')) {
             return null;
         }
+
         $commonDirContents = @file_get_contents($gitFolder . '/commondir');
         if ($commonDirContents === false) {
             return null;

diff --git a/libraries/classes/InsertEdit.php b/libraries/classes/InsertEdit.php
@@ -2639,6 +2639,7 @@ private function getHtmlForInsertEditFormColumn(
                 if (! isset($column['values'])) {
                     $column['values'] = $this->getColumnEnumValues($column, $extractedColumnspec);
                 }
+
                 foreach ($column['values'] as $enumValue) {
                     if (
                         $data == $enumValue['plain'] || ($data == ''
@@ -2664,12 +2665,15 @@ private function getHtmlForInsertEditFormColumn(
                         [$blobValue, $blobValueUnit] = $blobSize;
                     }
                 }
+
                 if ($isUpload && $column['is_blob']) {
                     [$maxUploadSize] = $this->getMaxUploadSize($column, $biggestMaxFileSize);
                 }
+
                 if (! empty($GLOBALS['cfg']['UploadDir'])) {
                     $selectOptionForUpload = $this->getSelectOptionForUpload($vkey, $column);
                 }
+
                 if (
                     ! $isColumnProtectedBlob
                     && ! ($column['is_blob'] || ($column['len'] > $GLOBALS['cfg']['LimitChars']))

diff --git a/phpcs.xml.dist b/phpcs.xml.dist
@@ -24,4 +24,25 @@
     <rule ref="SlevomatCodingStandard.Operators.DisallowEqualOperators">
         <severity>4</severity>
     </rule>
+    <rule ref="SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint">
+        <severity>4</severity>
+    </rule>
+    <rule ref="SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingTraversableTypeHintSpecification">
+        <severity>4</severity>
+    </rule>
+    <rule ref="SlevomatCodingStandard.TypeHints.PropertyTypeHint.MissingTraversableTypeHintSpecification">
+        <severity>4</severity>
+    </rule>
+    <rule ref="SlevomatCodingStandard.TypeHints.ReturnTypeHint.MissingNativeTypeHint">
+        <severity>4</severity>
+    </rule>
+    <rule ref="SlevomatCodingStandard.TypeHints.ReturnTypeHint.MissingTraversableTypeHintSpecification">
+        <severity>4</severity>
+    </rule>
+    <rule ref="Squiz.NamingConventions.ValidVariableName.MemberNotCamelCaps">
+        <severity>4</severity>
+    </rule>
+    <rule ref="Squiz.NamingConventions.ValidVariableName.NotCamelCaps">
+        <severity>4</severity>
+    </rule>
 </ruleset>
diff --git a/test/classes/AbstractTestCase.php b/test/classes/AbstractTestCase.php
@@ -171,10 +171,9 @@ protected function tearDown(): void
      * @param string      $className  The class name
      * @param string      $methodName The method name
      * @param array       $params     The parameters for the invocation
+     * @phpstan-param class-string $className
      *
      * @return mixed the output from the protected method.
-     *
-     * @phpstan-param class-string $className
      */
     protected function callFunction($object, string $className, string $methodName, array $params)
     {

diff --git a/test/classes/Gis/GisFactoryTest.php b/test/classes/Gis/GisFactoryTest.php
@@ -21,7 +21,6 @@ class GisFactoryTest extends AbstractTestCase
      *
      * @param string $type geometry type
      * @param string $geom geometry object
-     *
      * @psalm-param class-string $geom
      *
      * @dataProvider providerForTestFactory

diff --git a/test/classes/StorageEngineTest.php b/test/classes/StorageEngineTest.php
@@ -111,7 +111,6 @@ public function testGetArray(): void
      *
      * @param string $expectedClass Class that should be selected
      * @param string $engineName    Engine name
-     *
      * @psalm-param class-string $expectedClass
      *
      * @dataProvider providerGetEngine