Merge pull request #26 from fhict-skilltree/25-install-static-code-analysis-tool-phpstan

Install static code analysis tool phpstan

Author: cyrildewit

.github/workflows/ci.yml

@@ -81,6 +81,10 @@ jobs:
           DB_PORT: ${{ job.services.mysql.ports['3306'] }}
           REDIS_PORT: ${{ job.services.redis.ports['6379'] }}
 
+      - name: Static analyses with Larastan (PHPStan)
+        run: composer run analyse
+        continue-on-error: true
+
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v4-beta
         env:

composer.json

@@ -17,6 +17,7 @@
         "laravel/sail": "^1.18",
         "mockery/mockery": "^1.4.4",
         "nunomaduro/collision": "^7.0",
+        "nunomaduro/larastan": "^2.0",
         "phpunit/phpunit": "^10.1",
         "spatie/laravel-ignition": "^2.0"
     },
@@ -40,6 +41,8 @@
         "pint-dirty": "./vendor/bin/pint --dirty",
         "pint-test": "./vendor/bin/pint --test",
         "pint-test-dirty": "./vendor/bin/pint --test --dirty",
+        "analyse": "./vendor/bin/phpstan analyse --memory-limit=2G",
+        "analyse-baseline": "./vendor/bin/phpstan analyse --generate-baseline phpstan-baseline.php --memory-limit=2G",
         "post-autoload-dump": [
             "Illuminate\\Foundation\\ComposerScripts::postAutoloadDump",
             "@php artisan package:discover --ansi"

composer.lock

@@ -3,6 +3,7 @@ layout: default
 title: Software Architecture
 nav_order: 3
 has_children: true
+parent: Technical Documentation
 permalink: /docs/technical/architecture
 ---
 

docs/technical/architecture/index.md

@@ -73,3 +73,19 @@ composer run pint-test
 # Test the code style of the changes you made
 composer run pint-test-dirty
 ```
+
+## Static code analyses (PHPStan)
+
+We've implemented Larastan (PHPStan) to analyse our code statically. It will search for type errors in the codebase.
+
+To run the static code analyses locally, you can run:
+
+```shell
+composer run analyse
+```
+
+To generate a new baseline, you can run:
+
+```shell
+composer run analyse-baseline
+```

docs/technical/local-development.md

@@ -0,0 +1,15 @@
+includes:
+    - ./vendor/nunomaduro/larastan/extension.neon
+
+parameters:
+    paths:
+        - app/
+        - config/
+
+    excludePaths:
+        - tests
+
+    # Level 9 is the highest level
+    level: 5
+
+    checkMissingIterableValueType: false