chore: enable phpstan

.github/workflows/backend.yml

@@ -0,0 +1,12 @@
+name: FoF Night Mode 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 Night Mode 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: yarn
       main_git_branch: master
+
     secrets:
       bundlewatch_github_token: ${{ secrets.BUNDLEWATCH_GITHUB_TOKEN }}

composer.json

@@ -57,7 +57,12 @@
         },
         "optional-dependencies": [
             "fof/default-user-preferences"
-        ]
+        ],
+        "flarum-cli": {
+            "modules": {
+                "githubActions": true
+            }
+        }
     },
     "autoload": {
         "psr-4": {
@@ -68,5 +73,15 @@
             "src/Overrides/Frontend/Assets.php",
             "src/Overrides/Frontend/RecompileFrontendAssets.php"
         ]
+    },
+    "scripts": {
+        "analyse:phpstan": "phpstan analyse",
+        "clear-cache:phpstan": "phpstan clear-result-cache"
+    },
+    "scripts-descriptions": {
+        "analyse:phpstan": "Run static analysis"
+    },
+    "require-dev": {
+        "flarum/phpstan": "*"
     }
 }

js/package.json

@@ -17,7 +17,7 @@
         "format-check": "prettier --check src"
     },
     "devDependencies": {
-        "prettier": "^2.6.2"
+        "prettier": "^3.0.3"
     },
     "packageManager": "[email protected]"
 }

js/yarn.lock

@@ -1702,7 +1702,7 @@ __metadata:
     es-cookie: ^1.4.0
     flarum-tsconfig: ^1.0.2
     flarum-webpack-config: ^2.0.2
-    prettier: ^2.6.2
+    prettier: ^3.0.3
     webpack: ^5.88.2
     webpack-cli: ^5.1.4
   languageName: unknown
@@ -2991,12 +2991,12 @@ __metadata:
   languageName: node
   linkType: hard
 
-"prettier@npm:^2.6.2":
-  version: 2.7.1
-  resolution: "prettier@npm:2.7.1"
+"prettier@npm:^3.0.3":
+  version: 3.0.3
+  resolution: "prettier@npm:3.0.3"
   bin:
-    prettier: bin-prettier.js
-  checksum: 55a4409182260866ab31284d929b3cb961e5fdb91fe0d2e099dac92eaecec890f36e524b4c19e6ceae839c99c6d7195817579cdffc8e2c80da0cb794463a748b
+    prettier: bin/prettier.cjs
+  checksum: e10b9af02b281f6c617362ebd2571b1d7fc9fb8a3bd17e371754428cda992e5e8d8b7a046e8f7d3e2da1dcd21aa001e2e3c797402ebb6111b5cd19609dd228e0
   languageName: node
   linkType: hard
 

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/Content/Assets.php

@@ -78,11 +78,11 @@ protected function assembleCompilers(?string $locale): array
     /**
      * @param string|null $url
      * @param string      $type
-     * @param string      $auto
+     * @param bool        $auto
      *
      * @return string
      */
-    protected function generateTag(?string $url, string $type, string $auto): string
+    protected function generateTag(?string $url, string $type, bool $auto): string
     {
         return sprintf(
             '<link rel="stylesheet" media="%s" class="nightmode-%s" href="%s" />',