UHF-9329: Add phpstan check

City-of-Helsinki · Feb 9, 2024 · 407556a · 407556a
1 parent 14a41fa
commit 407556a
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 8 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -43,6 +43,9 @@ jobs:
           vendor/bin/phpcs public/modules/custom/ --ignore="*.js,*.css" --extensions=php,module,install --standard=Drupal,DrupalPractice
           vendor/bin/phpcs public/themes/custom/ --ignore="*.js,*.css" --extensions=php,theme --standard=Drupal,DrupalPractice
 
+      - name: Run phpstan
+        run: vendor/bin/phpstan analyze
+
       - name: Download latest dump
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

diff --git a/phpstan.neon b/phpstan.neon
@@ -1,5 +1,14 @@
 parameters:
-  treatPhpDocTypesAsCertain: false
+  fileExtensions:
+      - php
+      - module
+      - install
+      - theme
+  paths:
+    - ./public/modules/custom
+    - ./public/themes/custom
   excludePaths:
-      - *Test.php
-      - *TestBase.php
+    - vendor
+  level: 3
+  checkMissingIterableValueType: false
+  treatPhpDocTypesAsCertain: false
diff --git a/public/modules/custom/helfi_emergency_general/src/AnnouncementClient.php b/public/modules/custom/helfi_emergency_general/src/AnnouncementClient.php
@@ -13,13 +13,13 @@
 /**
  * Announcement client for dealing with requests to azure storage.
  */
-class AnnouncementClient {
+final class AnnouncementClient {
   use StringTranslationTrait;
 
   /**
    * A fully-configured Guzzle client to pass to the client.
    *
-   * @var \GuzzleHttp\Client
+   * @var \GuzzleHttp\ClientInterface
    */
   protected ClientInterface $httpClient;
 

diff --git a/public/modules/custom/helfi_emergency_general/src/Form/AnnouncementEditForm.php b/public/modules/custom/helfi_emergency_general/src/Form/AnnouncementEditForm.php
@@ -14,7 +14,7 @@
 /**
  * Form class for emergency announcement message.
  */
-class AnnouncementEditForm extends FormBase {
+final class AnnouncementEditForm extends FormBase {
 
   use StringTranslationTrait;
 

diff --git a/public/modules/custom/helfi_static_trigger/src/Form/TriggerForm.php b/public/modules/custom/helfi_static_trigger/src/Form/TriggerForm.php
@@ -10,7 +10,7 @@
 /**
  * Provides a form for triggering static site re-generation.
  */
-class TriggerForm extends FormBase {
+final class TriggerForm extends FormBase {
 
   /**
    * The Static Trigger service.

diff --git a/public/themes/custom/hdbt_subtheme/hdbt_subtheme.theme b/public/themes/custom/hdbt_subtheme/hdbt_subtheme.theme
@@ -64,7 +64,7 @@ function hdbt_subtheme_preprocess_paragraph(&$variables) {
   /** @var \Drupal\paragraphs\Entity\Paragraph $paragraph */
   $paragraph = $variables['paragraph'];
   // Get the referenced entities.
-  /** @var \Drupal\paragraphs\Entity\ParagraphsType $referencedEntities */
+  /** @var \Drupal\paragraphs\Entity\ParagraphsType[] $referencedEntities */
   $referencedEntities = $paragraph->referencedEntities();
   foreach ($referencedEntities as $paragraph_type) {
     // Add local (crisis) news to the helfi_news template.