chore: add Larastan for static analysis and CI workflow

Add Larastan as a development dependency to enable static code analysis for the Laravel project. This helps in identifying potential bugs and improving code quality without running the application.

Additionally, a GitHub Actions CI workflow is introduced to automate testing, static analysis, and code style checks on every push or pull request. The workflow includes steps for PHP setup, dependency installation, PHPUnit tests, PHPStan analysis, and Pint code style verification.

A `phpstan.neon` configuration file is also added to customize the static analysis process, including paths to analyze and the desired level of strictness.

Author: oketafred

.github/workflows/ci.yml

@@ -0,0 +1,21 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.0'
+      - name: Install dependencies
+        run: composer install --prefer-dist --no-progress --no-suggest
+      - name: Run PHPUnit tests
+        run: vendor/bin/phpunit
+      - name: Run PHPStan analysis
+        run: vendor/bin/phpstan analyse
+      - name: Check code style
+        run: vendor/bin/pint --test

composer.json

@@ -13,6 +13,7 @@
     },
     "require-dev": {
         "fakerphp/faker": "^1.9.1",
+        "larastan/larastan": "^2.3",
         "laravel/pint": "^1.0",
         "laravel/sail": "^1.0.1",
         "mockery/mockery": "^1.4.4",

composer.lock

@@ -0,0 +1,17 @@
+includes:
+    - vendor/larastan/larastan/extension.neon
+    - vendor/nesbot/carbon/extension.neon
+
+parameters:
+
+    paths:
+        - app/
+
+    # Level 10 is the highest level
+    level: 5
+
+#    ignoreErrors:
+#        - '#PHPDoc tag @var#'
+#
+#    excludePaths:
+#        - ./*/*/FileToBeExcluded.php