chore: enable phpstan (#56)

* chore: enable phpstan

* chore: npm audit fix

.github/workflows/backend.yml

@@ -7,5 +7,6 @@ jobs:
     uses: flarum/framework/.github/workflows/REUSABLE_backend.yml@main
     with:
       enable_backend_testing: true
+      enable_phpstan: true
 
       backend_directory: .

composer.json

@@ -65,7 +65,9 @@
     },
     "require-dev": {
         "flarum/bbcode": "*",
-        "flarum/testing": "^1.0.0"
+        "flarum/testing": "^1.0.0",
+        "flarum/phpstan": "*",
+        "flarum/suspend": "*"
     },
     "autoload-dev": {
         "psr-4": {
@@ -79,12 +81,15 @@
         ],
         "test:unit": "phpunit -c tests/phpunit.unit.xml",
         "test:integration": "phpunit -c tests/phpunit.integration.xml",
-        "test:setup": "@php tests/integration/setup.php"
+        "test:setup": "@php tests/integration/setup.php",
+        "analyse:phpstan": "phpstan analyse",
+        "clear-cache:phpstan": "phpstan clear-result-cache"
     },
     "scripts-descriptions": {
         "test": "Runs all tests.",
         "test:unit": "Runs all unit tests.",
         "test:integration": "Runs all integration tests.",
-        "test:setup": "Sets up a database for use with integration tests. Execute this only once."
+        "test:setup": "Sets up a database for use with integration tests. Execute this only once.",
+        "analyse:phpstan": "Run static analysis"
     }
 }

extend.php

@@ -27,6 +27,9 @@
 
     new Flarum\Locales(__DIR__.'/resources/locale'),
 
+    (new Flarum\Model(User::class))
+        ->cast('bio', 'string'),
+
     (new Flarum\Event())
         ->listen(Saving::class, Listeners\SaveUserBio::class)
         ->listen(Saved::class, Listeners\ClearFormatterCache::class),

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/Access/UserPolicy.php

@@ -51,6 +51,7 @@ protected function isSuspended(User $user): bool
         // suspended_until is null if flarum/suspend isn't installed
         // laravel sets all non existing attributes to null
         // suspend_until is also null if the user isn't suspended.
+        /** @phpstan-ignore-next-line */
         return $user->suspended_until !== null
             && $user->suspended_until instanceof Carbon
             && $user->suspended_until->isFuture();

src/Formatter/FormatterServiceProvider.php

@@ -15,7 +15,7 @@
 use Flarum\Foundation\AbstractServiceProvider;
 use Flarum\Foundation\Paths;
 use Illuminate\Cache\Repository;
-use Illuminate\Container\Container;
+use Illuminate\Contracts\Container\Container;
 
 class FormatterServiceProvider extends AbstractServiceProvider
 {

src/Formatter/UserBioFormatter.php

@@ -63,6 +63,7 @@ protected function getConfigurator()
         $configurator = parent::getConfigurator();
 
         if ($this->extensions->isEnabled('flarum-markdown')) {
+            /** @phpstan-ignore-next-line */
             $configurator->Litedown;
         }