chore: enable phpstan, apply fixes (#4)

* chore: enable phpstan * fix: phpstan errors * Apply fixes from StyleCI --------- Co-authored-by: StyleCI Bot <[email protected]>
imorland · Nov 14, 2023 · 946527c · 946527c
1 parent 0e78111
commit 946527c
Show file tree

Hide file tree

Showing 7 changed files with 95 additions and 44 deletions.
diff --git a/.github/workflows/backend.yml b/.github/workflows/backend.yml
@@ -0,0 +1,12 @@
+name: HTML Head Items PHP
+
+on: [workflow_dispatch, push, pull_request]
+
+jobs:
+  run:
+    uses: flarum/framework/.github/workflows/REUSABLE_backend.yml@main
+    with:
+      enable_backend_testing: false
+      enable_phpstan: true
+
+      backend_directory: .
diff --git a/.github/workflows/build.yml → .github/workflows/frontend.yml b/.github/workflows/build.yml → .github/workflows/frontend.yml
@@ -1,4 +1,4 @@
-name: HTML-Head JS
+name: HTML Head Items JS
 
 on: [workflow_dispatch, push, pull_request]
 
@@ -8,11 +8,12 @@ jobs:
     with:
       enable_bundlewatch: false
       enable_prettier: true
-      enable_typescript: false
+      enable_typescript: true
 
       frontend_directory: ./js
       backend_directory: .
       js_package_manager: npm
       main_git_branch: master
+
     secrets:
       bundlewatch_github_token: ${{ secrets.BUNDLEWATCH_GITHUB_TOKEN }}
diff --git a/composer.json b/composer.json
@@ -1,42 +1,61 @@
 {
-  "name": "ianm/html-head",
-  "description": "Add custom items to the HTML <head> attributes",
-  "keywords": [
-    "flarum", "headers", "html", "head", "custom"
-  ],
-  "type": "flarum-extension",
-  "license": "MIT",
-  "support": {
-    "issues": "https://github.com/imorland/html-head/issues",
-    "source": "https://github.com/imorland/html-head",
-    "forum": "https://discuss.flarum.org/d/25907"
-  },
-  "require": {
-    "flarum/core": "^1.2.0"
-  },
-  "authors": [
-    {
-      "name": "IanM",
-      "homepage": "https://discuss.flarum.org/u/ianm"
-    }
-  ],
-  "autoload": {
-    "psr-4": {
-      "IanM\\HtmlHead\\": "src/"
-    }
-  },
-  "extra": {
-    "flarum-extension": {
-      "title": "HTML Head Items",
-      "category": "feature",
-      "icon": {
-        "name": "fas fa-heading",
-        "backgroundColor": "#0072e3",
-        "color": "#fff"
-      }
+    "name": "ianm/html-head",
+    "description": "Add custom items to the HTML <head> attributes",
+    "keywords": [
+        "flarum",
+        "headers",
+        "html",
+        "head",
+        "custom"
+    ],
+    "type": "flarum-extension",
+    "license": "MIT",
+    "support": {
+        "issues": "https://github.com/imorland/html-head/issues",
+        "source": "https://github.com/imorland/html-head",
+        "forum": "https://discuss.flarum.org/d/25907"
+    },
+    "require": {
+        "flarum/core": "^1.2.0"
+    },
+    "authors": [
+        {
+            "name": "IanM",
+            "homepage": "https://discuss.flarum.org/u/ianm"
+        }
+    ],
+    "autoload": {
+        "psr-4": {
+            "IanM\\HtmlHead\\": "src/"
+        }
+    },
+    "extra": {
+        "flarum-extension": {
+            "title": "HTML Head Items",
+            "category": "feature",
+            "icon": {
+                "name": "fas fa-heading",
+                "backgroundColor": "#0072e3",
+                "color": "#fff"
+            }
+        },
+        "flagrow": {
+            "discuss": "https://discuss.flarum.org/d/25907"
+        },
+        "flarum-cli": {
+            "modules": {
+                "githubActions": true
+            }
+        }
+    },
+    "require-dev": {
+        "flarum/phpstan": "*"
+    },
+    "scripts": {
+        "analyse:phpstan": "phpstan analyse",
+        "clear-cache:phpstan": "phpstan clear-result-cache"
     },
-    "flagrow": {
-      "discuss": "https://discuss.flarum.org/d/25907"
+    "scripts-descriptions": {
+        "analyse:phpstan": "Run static analysis"
     }
-  }
 }
diff --git a/phpstan.neon b/phpstan.neon
@@ -0,0 +1,13 @@
+includes:
+  - vendor/flarum/phpstan/extension.neon
+
+parameters:
+  # The level will be increased in Flarum 2.0
+  level: 5
+  paths:
+    - extend.php
+    - src
+  excludePaths:
+    - *.blade.php
+  checkMissingIterableValueType: false
+  databaseMigrationsPath: ['migrations']
diff --git a/src/Api/Serializers/HeaderSerializer.php b/src/Api/Serializers/HeaderSerializer.php
@@ -23,7 +23,7 @@ class HeaderSerializer extends AbstractSerializer
     protected $type = 'html-headers';
 
     /**
-     * {@inheritdoc}
+     * @param \IanM\HtmlHead\Header $header
      */
     protected function getDefaultAttributes($header)
     {

diff --git a/src/Command/DeleteHeaderItemHandler.php b/src/Command/DeleteHeaderItemHandler.php
@@ -29,11 +29,11 @@ public function __construct(Dispatcher $events)
     }
 
     /**
-     * @param DeleteHeader $command
+     * @param DeleteHeaderItem $command
      *
-     * @return mixed
+     * @return Header
      */
-    public function handle(DeleteHeaderItem $command)
+    public function handle(DeleteHeaderItem $command): Header
     {
         $command->actor->assertAdmin();
 

diff --git a/src/Header.php b/src/Header.php
@@ -14,6 +14,12 @@
 
 use Flarum\Database\AbstractModel;
 
+/**
+ * @property int         $id
+ * @property string|null $description
+ * @property string|null $header
+ * @property bool        $active
+ */
 class Header extends AbstractModel
 {
     public const CACHE_KEY = 'active_html_headers';