Bump phpmyadmin/coding-standard version to 4.0

Signed-off-by: Maurício Meneghini Fauth <[email protected]>
phpmyadmin · Sep 13, 2023 · f37b41c · f37b41c
1 parent b3be03d
commit f37b41c
Show file tree

Hide file tree

Showing 12 changed files with 56 additions and 102 deletions.
diff --git a/composer.json b/composer.json
@@ -24,7 +24,7 @@
         "twig/twig": "^3.7"
     },
     "require-dev": {
-        "phpmyadmin/coding-standard": "^3.0.0",
+        "phpmyadmin/coding-standard": "^4.0",
         "phpmyadmin/motranslator": "^5.2",
         "phpstan/phpstan": "^1.9.4",
         "phpunit/phpunit": "^9.6"

diff --git a/phpcs.xml.dist b/phpcs.xml.dist
@@ -10,10 +10,7 @@
     <file>src</file>
     <file>test</file>
 
-    <rule ref="PhpMyAdmin">
-        <exclude name="SlevomatCodingStandard.TypeHints.ReturnTypeHint.MissingNativeTypeHint"/>
-        <exclude name="SlevomatCodingStandard.TypeHints.ReturnTypeHint.MissingTraversableTypeHintSpecification"/>
-    </rule>
+    <rule ref="PhpMyAdmin"/>
 
     <rule ref="SlevomatCodingStandard.ControlStructures.RequireSingleLineCondition"/>
     <rule ref="SlevomatCodingStandard.Functions.RequireSingleLineCall"/>

diff --git a/src/I18nExtension.php b/src/I18nExtension.php
@@ -57,7 +57,7 @@ public function getName()
      * @param string      $message The message to translate
      * @param string|null $domain  The GetText domain
      */
-    public function translate(string $message, ?string $domain = null): string
+    public function translate(string $message, string|null $domain = null): string
     {
         /* If we don't have a domain, assume we're just using the default */
         if ($domain === null) {

diff --git a/src/Node/TransNode.php b/src/Node/TransNode.php
@@ -40,41 +40,33 @@ class TransNode extends Node
 {
     /**
      * The label for gettext notes to be exported
-     *
-     * @var string
      */
-    public static $notesLabel = '// notes: ';
+    public static string $notesLabel = '// notes: ';
 
     /**
      * Enable MoTranslator functions
-     *
-     * @var bool
      */
-    public static $enableMoTranslator = false;
+    public static bool $enableMoTranslator = false;
 
     /**
      * Enable calls to addDebugInfo
-     *
-     * @var bool
      */
-    public static $enableAddDebugInfo = false;
+    public static bool $enableAddDebugInfo = false;
 
     /**
      * Enables context functions usage
-     *
-     * @var bool
      */
-    public static $hasContextFunctions = false;
+    public static bool $hasContextFunctions = false;
 
     public function __construct(
         Node $body,
-        ?Node $plural,
-        ?AbstractExpression $count,
-        ?Node $context = null,
-        ?Node $notes = null,
-        ?Node $domain = null,
+        Node|null $plural,
+        AbstractExpression|null $count,
+        Node|null $context = null,
+        Node|null $notes = null,
+        Node|null $domain = null,
         int $lineno = 0,
-        ?string $tag = null
+        string|null $tag = null,
     ) {
         $nodes = ['body' => $body];
         if ($count !== null) {
@@ -220,6 +212,8 @@ public function compile(Compiler $compiler)
 
     /**
      * Keep this method protected instead of private some implementations may use it
+     *
+     * @psalm-return array{Node, list<NameExpression>}
      */
     protected function compileString(Node $body): array
     {

diff --git a/src/TokenParser/TransTokenParser.php b/src/TokenParser/TransTokenParser.php
@@ -16,6 +16,7 @@
 
 use PhpMyAdmin\Twig\Extensions\Node\TransNode;
 use Twig\Error\SyntaxError;
+use Twig\Node\Expression\AbstractExpression;
 use Twig\Node\Expression\NameExpression;
 use Twig\Node\Node;
 use Twig\Node\PrintNode;
@@ -44,6 +45,7 @@ public function parse(Token $token)
         return new TransNode($body, $plural, $count, $context, $notes, $domain, $lineno, $tag);
     }
 
+    /** @psalm-return array{Node, Node|null, AbstractExpression|null, Node|null, Node|null, Node|null, int, string} */
     protected function preParse(Token $token): array
     {
         $lineno = $token->getLine();
@@ -95,18 +97,12 @@ protected function preParse(Token $token): array
         return [$body, $plural, $count, $context, $notes, $domain, $lineno, $this->getTag()];
     }
 
-    /**
-     * @return bool
-     */
-    public function decideForFork(Token $token)
+    public function decideForFork(Token $token): bool
     {
         return $token->test(['plural', 'context', 'notes', 'endtrans']);
     }
 
-    /**
-     * @return bool
-     */
-    public function decideForEnd(Token $token)
+    public function decideForEnd(Token $token): bool
     {
         return $token->test('endtrans');
     }
@@ -119,12 +115,8 @@ public function getTag()
         return 'trans';
     }
 
-    /**
-     * @return void
-     *
-     * @throws SyntaxError
-     */
-    protected function checkTransString(Node $body, int $lineno)
+    /** @throws SyntaxError */
+    protected function checkTransString(Node $body, int $lineno): void
     {
         foreach ($body as $i => $node) {
             if (
@@ -137,7 +129,7 @@ protected function checkTransString(Node $body, int $lineno)
 
             throw new SyntaxError(
                 'The text to be translated with "trans" can only contain references to simple variables.',
-                $lineno
+                $lineno,
             );
         }
     }

diff --git a/test/I18nExtensionMoTranslatorDebugTest.php b/test/I18nExtensionMoTranslatorDebugTest.php
@@ -14,7 +14,7 @@
 use PhpMyAdmin\MoTranslator\Loader;
 use PhpMyAdmin\Tests\Twig\Extensions\MoTranslator\I18nExtensionDebug;
 use PhpMyAdmin\Twig\Extensions\I18nExtension;
-use Twig\Extension\AbstractExtension;
+use Twig\Extension\ExtensionInterface;
 use Twig\Test\IntegrationTestCase;
 
 class I18nExtensionMoTranslatorDebugTest extends IntegrationTestCase
@@ -24,20 +24,15 @@ public static function setUpBeforeClass(): void
         Loader::loadFunctions();
     }
 
-    /**
-     * @return AbstractExtension[]
-     */
-    public function getExtensions()
+    /** @return ExtensionInterface[] */
+    public function getExtensions(): array
     {
         return [
             new I18nExtensionDebug(),
         ];
     }
 
-    /**
-     * @return string
-     */
-    public function getFixturesDir()
+    public function getFixturesDir(): string
     {
         return __DIR__ . '/Fixtures/';
     }

diff --git a/test/I18nExtensionMoTranslatorSandboxTest.php b/test/I18nExtensionMoTranslatorSandboxTest.php
@@ -13,7 +13,7 @@
 
 use PhpMyAdmin\MoTranslator\Loader;
 use PhpMyAdmin\Twig\Extensions\I18nExtension;
-use Twig\Extension\AbstractExtension;
+use Twig\Extension\ExtensionInterface;
 use Twig\Extension\SandboxExtension;
 use Twig\Sandbox\SecurityPolicy;
 use Twig\Test\IntegrationTestCase;
@@ -25,10 +25,8 @@ public static function setUpBeforeClass(): void
         Loader::loadFunctions();
     }
 
-    /**
-     * @return AbstractExtension[]
-     */
-    public function getExtensions()
+    /** @return ExtensionInterface[] */
+    public function getExtensions(): array
     {
         $tags = ['if', 'set', 'trans'];
         $filters = ['upper', 'escape'];
@@ -43,10 +41,7 @@ public function getExtensions()
         ];
     }
 
-    /**
-     * @return string
-     */
-    public function getFixturesDir()
+    public function getFixturesDir(): string
     {
         return __DIR__ . '/FixturesWithSandbox/';
     }

diff --git a/test/I18nExtensionMoTranslatorTest.php b/test/I18nExtensionMoTranslatorTest.php
@@ -13,7 +13,7 @@
 
 use PhpMyAdmin\MoTranslator\Loader;
 use PhpMyAdmin\Tests\Twig\Extensions\MoTranslator\I18nExtensionMoTranslator;
-use Twig\Extension\AbstractExtension;
+use Twig\Extension\ExtensionInterface;
 use Twig\Test\IntegrationTestCase;
 
 class I18nExtensionMoTranslatorTest extends IntegrationTestCase
@@ -23,20 +23,15 @@ public static function setUpBeforeClass(): void
         Loader::loadFunctions();
     }
 
-    /**
-     * @return AbstractExtension[]
-     */
-    public function getExtensions()
+    /** @return ExtensionInterface[] */
+    public function getExtensions(): array
     {
         return [
             new I18nExtensionMoTranslator(),
         ];
     }
 
-    /**
-     * @return string
-     */
-    public function getFixturesDir()
+    public function getFixturesDir(): string
     {
         return __DIR__ . '/Fixtures/';
     }

diff --git a/test/I18nExtensionSandboxTest.php b/test/I18nExtensionSandboxTest.php
@@ -12,17 +12,15 @@
 namespace PhpMyAdmin\Tests\Twig\Extensions\Node;
 
 use PhpMyAdmin\Twig\Extensions\I18nExtension;
-use Twig\Extension\AbstractExtension;
+use Twig\Extension\ExtensionInterface;
 use Twig\Extension\SandboxExtension;
 use Twig\Sandbox\SecurityPolicy;
 use Twig\Test\IntegrationTestCase;
 
 class I18nExtensionSandboxTest extends IntegrationTestCase
 {
-    /**
-     * @return AbstractExtension[]
-     */
-    public function getExtensions()
+    /** @return ExtensionInterface[] */
+    public function getExtensions(): array
     {
         $tags = ['if', 'set', 'trans'];
         $filters = ['upper', 'escape'];
@@ -37,10 +35,7 @@ public function getExtensions()
         ];
     }
 
-    /**
-     * @return string
-     */
-    public function getFixturesDir()
+    public function getFixturesDir(): string
     {
         return __DIR__ . '/FixturesWithSandbox/';
     }

diff --git a/test/I18nExtensionTest.php b/test/I18nExtensionTest.php
@@ -12,25 +12,20 @@
 namespace PhpMyAdmin\Tests\Twig\Extensions\Node;
 
 use PhpMyAdmin\Twig\Extensions\I18nExtension;
-use Twig\Extension\AbstractExtension;
+use Twig\Extension\ExtensionInterface;
 use Twig\Test\IntegrationTestCase;
 
 class I18nExtensionTest extends IntegrationTestCase
 {
-    /**
-     * @return AbstractExtension[]
-     */
-    public function getExtensions()
+    /** @return ExtensionInterface[] */
+    public function getExtensions(): array
     {
         return [
             new I18nExtension(),
         ];
     }
 
-    /**
-     * @return string
-     */
-    public function getFixturesDir()
+    public function getFixturesDir(): string
     {
         return __DIR__ . '/Fixtures/';
     }

diff --git a/test/Node/MoTranslatorTransTest.php b/test/Node/MoTranslatorTransTest.php
@@ -70,9 +70,7 @@ public function testFullConstructor(): void
         $this->assertEquals($context, $node->getNode('context'));
     }
 
-    /**
-     * @return array[]
-     */
+    /** @return mixed[] */
     public function getTests(): array
     {
         $tests = [];
@@ -107,7 +105,7 @@ public function getTests(): array
             $node,
             sprintf(
                 'echo strtr(_gettext("J\'ai %%foo%% pommes"), array("%%foo%%" => %s, ));',
-                $this->getVariableGetter('foo')
+                $this->getVariableGetter('foo'),
             ),
         ];
 
@@ -132,7 +130,7 @@ public function getTests(): array
                 . ' I have %%count%% apples", abs(12)), array("%%name%%" => %s,'
                 . ' "%%name%%" => %s, "%%count%%" => abs(12), ));',
                 $this->getVariableGetter('name'),
-                $this->getVariableGetter('name')
+                $this->getVariableGetter('name'),
             ),
         ];
 
@@ -149,7 +147,7 @@ public function getTests(): array
             $node,
             sprintf(
                 'echo strtr(_pgettext("The context", "J\'ai %%foo%% pommes"), array("%%foo%%" => %s, ));',
-                $this->getVariableGetter('foo')
+                $this->getVariableGetter('foo'),
             ),
         ];
 
@@ -177,7 +175,7 @@ public function getTests(): array
                 . ' I have %%count%% apples", abs(12)), array("%%name%%" => %s,'
                 . ' "%%name%%" => %s, "%%count%%" => abs(12), ));',
                 $this->getVariableGetter('name'),
-                $this->getVariableGetter('name')
+                $this->getVariableGetter('name'),
             ),
         ];
 
@@ -197,7 +195,7 @@ public function getTests(): array
             $node,
             sprintf(
                 'echo strtr(_dpgettext("mydomain", "The context", "J\'ai %%foo%% pommes"), array("%%foo%%" => %s, ));',
-                $this->getVariableGetter('foo')
+                $this->getVariableGetter('foo'),
             ),
         ];
 
@@ -228,7 +226,7 @@ public function getTests(): array
                 . ' "Hey %%name%%, I have %%count%% apples", abs(12)), array("%%name%%" => %s,'
                 . ' "%%name%%" => %s, "%%count%%" => abs(12), ));',
                 $this->getVariableGetter('name'),
-                $this->getVariableGetter('name')
+                $this->getVariableGetter('name'),
             ),
         ];