Merge pull request #217 from spaze/spaze/psalm

Psalm & PHPStan strict rules

.github/workflows/run-tests.yml

@@ -48,3 +48,6 @@ jobs:
 
       - name: Execute PHPStan
         run: vendor/bin/phpstan analyse -c phpstan.neon
+
+      - name: Execute Psalm
+        run: vendor/bin/psalm

composer.json

@@ -22,7 +22,8 @@
     "require-dev": {
         "phpunit/phpunit": "^7.5.15|^8.5|^9.0",
         "phpstan/phpstan": "^1.9",
-        "phpstan/phpstan-strict-rules": "^1.6"
+        "phpstan/phpstan-strict-rules": "^1.6",
+        "vimeo/psalm": "^5.26"
     },
     "autoload": {
         "psr-4": {

psalm.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0"?>
+<psalm
+    errorLevel="1"
+    resolveFromConfigFile="true"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns="https://getpsalm.org/schema/config"
+    xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
+    findUnusedBaselineEntry="true"
+    findUnusedCode="false"
+>
+    <projectFiles>
+        <directory name="src" />
+        <ignoreFiles>
+            <directory name="vendor" />
+        </ignoreFiles>
+    </projectFiles>
+</psalm>

tests/tools/analyse.sh

@@ -3,26 +3,30 @@ source tests/tools/helpers.sh
 
 function main
 {
-    get_phpstan_path
+    get_paths
 
     banner
 
     $PHPSTAN analyse -c phpstan.neon
+    $PSALM
 }
 
-function get_phpstan_path()
+function get_paths()
 {
     current_directory
 
     PHPSTAN="$ROOT_DIRECTORY/vendor/bin/phpstan"
+    PSALM="$ROOT_DIRECTORY/vendor/bin/psalm"
 }
 
 function banner
 {
     echo  Google2FA testing framework
     echo -----------------------------
     echo
-    echo You can execute these tests by running $PHPSTAN
+    echo You can execute these tests by running
+    echo - $PHPSTAN
+    echo - $PSALM
     echo
 }