Merge pull request #33 from MekDrop/add-phpstan

Added phpstan

Author: MekDrop

.github/workflows/on_pull_request.yml

@@ -36,6 +36,8 @@ jobs:
         run: composer test
       - name: PHP CodeSniffer
         run: composer phpcs
+      - name: PHPStan
+        run: composer phpstan
       - name: Install Composer dependencies (without dev)
         run: composer install --no-progress --no-dev --no-suggest --prefer-dist --optimize-autoloader
 

.gitignore

@@ -3,3 +3,4 @@
 composer.lock
 /.phpunit.result.cache
 /.phpunit.cache/
+/.phpstan.cache/

README.md

@@ -120,6 +120,28 @@ Debuging variables can be done from templates...
 ```smarty
 {"_AD_INSTALLEDMODULES"|debug_print_var}
 ```
+## Development
+
+### Code Quality Tools
+
+This project uses several tools to ensure code quality:
+
+- **PHPUnit** - For unit testing
+  ```bash
+  composer test
+  ```
+
+- **PHP CodeSniffer** - For coding standards (PSR-12)
+  ```bash
+  composer phpcs    # Check code style
+  composer phpcbf   # Fix code style issues automatically
+  ```
+
+- **PHPStan** - For static analysis
+  ```bash
+  composer phpstan
+  ```
+
 ## How to contribute?
 
 If you want to add some functionality or fix bugs, you can fork, change and create pull request. If you not sure how this works, try [interactive GitHub tutorial](https://skills.github.com).

composer.json

@@ -33,11 +33,13 @@
     ],
     "require-dev": {
         "phpunit/phpunit": "^10.0",
-        "squizlabs/php_codesniffer": "^3.8"
+        "squizlabs/php_codesniffer": "^3.8",
+        "phpstan/phpstan": "^2"
     },
     "scripts": {
         "test": "phpunit --testdox",
         "phpcs": "phpcs",
-        "phpcbf": "phpcbf"
+        "phpcbf": "phpcbf",
+        "phpstan": "phpstan analyse"
     }
 }

phpstan.neon

@@ -0,0 +1,14 @@
+parameters:
+    # Level 5 is a good starting point for most projects
+    level: 5
+
+    paths:
+        - src
+        - tests
+
+    # Exclude vendor directory
+    excludePaths:
+        - vendor
+
+    # PHP 8.3 compatibility
+    phpVersion: 80300

tests/DebugExtensionTest.php

@@ -10,8 +10,8 @@
 
 class DebugExtensionTest extends TestCase
 {
-    private readonly DebugExtension $extension;
-    private readonly Smarty $smarty;
+    private DebugExtension $extension;
+    private Smarty $smarty;
 
     protected function setUp(): void
     {