chore: enable phpstan (#34)

* chore: enable phpstan

* fix: phpstan complaints

* chore: bump js deps

.github/workflows/backend.yml

@@ -0,0 +1,12 @@
+name: FoF Subscribed 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: .

.github/workflows/build.yml → .github/workflows/frontend.yml

@@ -1,4 +1,4 @@
-name: Javascript
+name: FoF Subscribed 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 }}

composer.json

@@ -47,15 +47,32 @@
             "optional-dependencies": [
                 "flarum/approval",
                 "flarum/flags"
-              ]
+            ]
         },
         "flagrow": {
             "discuss": "https://discuss.flarum.org/d/20917"
+        },
+        "flarum-cli": {
+            "modules": {
+                "githubActions": true
+            }
         }
     },
     "autoload": {
         "psr-4": {
             "FoF\\Subscribed\\": "src/"
         }
+    },
+    "require-dev": {
+        "flarum/phpstan": "*",
+        "flarum/flags": "*",
+        "flarum/approval": "*"
+    },
+    "scripts": {
+        "analyse:phpstan": "phpstan analyse",
+        "clear-cache:phpstan": "phpstan clear-result-cache"
+    },
+    "scripts-descriptions": {
+        "analyse:phpstan": "Run static analysis"
     }
 }

js/package.json

@@ -6,11 +6,11 @@
         "@flarum/prettier-config": "^1.0.0",
         "flarum-tsconfig": "^1.0.2",
         "flarum-webpack-config": "^2.0.0",
-        "webpack": "^5.76.0",
-        "webpack-cli": "^4.9.2"
+        "webpack": "^5.89.0",
+        "webpack-cli": "^5.1.4"
     },
     "devDependencies": {
-        "prettier": "^2.6.1"
+        "prettier": "^3.0.3"
     },
     "scripts": {
         "dev": "webpack --mode development --watch",

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']

src/AddPermissions.php

@@ -28,9 +28,6 @@ public function __construct(ExtensionManager $extensions)
         $this->extensions = $extensions;
     }
 
-    /**
-     * @param ForumSerializer $serializer
-     */
     public function __invoke(CurrentUserSerializer $serializer, User $user, array $attributes): array
     {
         $attributes['canSubscribeDiscussionCreated'] = $serializer->getActor()->can('subscribeDiscussionCreated');

src/Listeners/DiscussionCreated.php

@@ -49,6 +49,7 @@ public function subscribe(Dispatcher $events)
 
     public function whenDiscussionWasStarted(Started $event)
     {
+        /** @phpstan-ignore-next-line */
         if ($event->discussion->is_approved === false) {
             return;
         }
@@ -60,7 +61,7 @@ public function whenDiscussionWasStarted(Started $event)
 
     public function whenDiscussionWasApproved(PostWasApproved $event)
     {
-        if ($event->post->number != 1) {
+        if ($event->post->number !== 1) {
             return;
         }
 

src/Listeners/PostCreated.php

@@ -29,6 +29,7 @@ public function whenPosted(Posted $event)
     {
         // We don't want to notify if this is the first post in a new disccusion, or if the post
         // is not approved.
+        /** @phpstan-ignore-next-line */
         if ($event->post->number === 1 || $event->post->is_approved === false) {
             return;
         }

src/Listeners/UnapprovedPostCreated.php

@@ -50,6 +50,7 @@ public function subscribe(Dispatcher $events)
 
     public function whenPostWasPosted(Posted $event)
     {
+        /** @phpstan-ignore-next-line */
         if ($event->post->is_approved !== false) {
             return;
         }