Properly run linter and static analyzer in CI

Author: Bernhard Schmitt

.github/workflows/qa.yml

@@ -18,11 +18,7 @@ jobs:
 
       - name: Run PHP Code Sniffer
         run: |
-          phpcs \
-            --standard=PSR12 \
-            --extensions=php \
-            --exclude=Generic.Files.LineLength \
-            Classes/ Tests/
+          composer lint
 
   static-analysis:
     runs-on: ubuntu-20.04
@@ -53,7 +49,7 @@ jobs:
 
       - name: Run phpstan
         run: |
-          composer lint
+          composer analyze
 
   unit-tests:
     runs-on: ubuntu-20.04

Classes/Aspect/CompilingEvaluatorPreprocessor.php

@@ -18,7 +18,7 @@
 final class CompilingEvaluatorPreprocessor
 {
     #[Flow\Before('method(Neos\Eel\CompilingEvaluator->evaluate())')]
-    public function preprocessEvaluate(JoinPointInterface $joinPoint)
+    public function preprocessEvaluate(JoinPointInterface $joinPoint): void
     {
         $context = $joinPoint->getMethodArgument('context');
         $joinPoint->setMethodArgument(

Classes/Domain/Component/PropType/UnionPropType.php

@@ -22,6 +22,7 @@ public function __construct(
         private readonly bool $nullable,
         PropTypeInterface ...$propTypes
     ) {
+        /** @var array<int,PropTypeInterface> $propTypes */
         $this->propTypes = $propTypes;
     }
 

Classes/Domain/Enum/Enum.php

@@ -74,7 +74,7 @@ private function getConstantName(string $value): string
 
     private function camelCaseToUpperSnakeCase(string $value): string
     {
-        return strtoupper(preg_replace('/(?<!^)[A-Z]/', '_$0', $value));
+        return strtoupper(preg_replace('/(?<!^)[A-Z]/', '_$0', $value) ?: '');
     }
 
     /**

Classes/Domain/Enum/EnumGenerator.php

@@ -19,7 +19,7 @@
 final class EnumGenerator
 {
     public function __construct(
-        private FileWriterInterface $fileWriter
+        private readonly FileWriterInterface $fileWriter
     ) {
     }
 

Classes/Domain/Enum/EnumName.php

@@ -42,12 +42,21 @@ public function getPhpNamespace(): string
      */
     public function getPhpClassName(): string
     {
-        return $this->componentName->getPhpNamespace() . '\\' . $this->name;
+        /** @var class-string<mixed> $name */
+        $name = $this->componentName->getPhpNamespace() . '\\' . $this->name;
+
+        return $name;
     }
 
+    /**
+     * @return class-string<mixed>
+     */
     public function getProviderName(): string
     {
-        return $this->name . 'Provider';
+        /** @var class-string<mixed> $name */
+        $name = $this->name . 'Provider';
+
+        return $name;
     }
 
     public function getPhpFilePath(string $packagePath, bool $colocate): string

Classes/Infrastructure/UriService.php

@@ -89,7 +89,7 @@ public function getPersistentResourceUri(PersistentResource $resource): ?Uri
     {
         $uri = $this->resourceManager->getPublicPersistentResourceUri($resource);
 
-        return $uri
+        return is_string($uri)
             ? new Uri($uri)
             : null;
     }

Classes/Presentation/Slot/Collection.php

@@ -22,10 +22,11 @@ final class Collection implements SlotInterface
 
     private function __construct(SlotInterface ...$items)
     {
+        /** @var array<int,SlotInterface> $items */
         $this->items = $items;
     }
 
-    public static function fromSlots(SlotInterface ...$items)
+    public static function fromSlots(SlotInterface ...$items): self
     {
         return new self(...$items);
     }

Tests/Unit/Domain/DummyFactoryRendererTest.php

@@ -64,6 +64,9 @@ public function setUp(): void
 
     public function testGetFactoryContent(): void
     {
+        /** @var Component $object */
+        $object = $this->component;
+
         Assert::assertSame(
             '<?php
 
@@ -81,7 +84,7 @@ final class MyNewComponentFactory extends AbstractComponentPresentationObjectFac
 {
 }
 ',
-            (new DummyFactoryRenderer())->renderFactoryContent($this->component)
+            (new DummyFactoryRenderer())->renderFactoryContent($object)
         );
     }
 }

composer.json

@@ -29,7 +29,8 @@
         "sitegeist/monocle-presentationobjects": "For Monocle integration"
     },
     "scripts": {
-        "lint": "bin/phpunit -c phpunit.xml --enforce-time-limit --coverage-html Build/Reports/coverage Tests",
+        "lint": "bin/phpcs --standard=PSR12 --extensions=php --exclude=Generic.Files.LineLength Classes/ Tests/",
+        "analyse": "bin/phpstan analyse --level 8 Tests/Unit Classes",
         "test": "bin/phpunit -c phpunit.xml --enforce-time-limit --coverage-html Build/Reports/coverage Tests"
     },
     "config": {