[php] Configure Psalm 6 default settings findUnusedBaselineEntry, findUnusedCode (#234)

* [php] Configure Psalm 6 default settings

This fixes a warning that outputs that we should be explicit about this setting. I picked enabling it as the solution.

* [php] Configure new Psalm checks OFF

We were not ready yet. These are now explicitly disabled, which takes care of the reminder message.

* [php] Psalm annotate exception class props.

This tells Psalm that these are a part of an expected API.

* Misc clean up

* Run `vendor/bin/psalm --no-cache --alter --issues=MissingParamType`
* Bump "phpunit/phpunit": "^10.5" to minimum deps run doesn't use a version that is too old
* Upgrade to latest phpunit.xml format
* Set findUnusedBaselineEntry="false" and findUnusedCode="false" to suppress paslm warnings

---------

Co-authored-by: M.P. Korstanje <[email protected]>

Author: olleolleolle

php/composer.json

@@ -18,7 +18,7 @@
         "cucumber/messages": ">=19.1.4 <=24"
     },
     "require-dev": {
-        "phpunit/phpunit": "^10.0",
+        "phpunit/phpunit": "^10.5",
         "vimeo/psalm": "5.19.1",
         "friendsofphp/php-cs-fixer": "^3.51",
         "psalm/plugin-phpunit": "^0.18.0",

php/phpunit.xml

@@ -1,21 +1,13 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.0/phpunit.xsd"
-         bootstrap="vendor/autoload.php"
-         cacheDirectory=".phpunit.cache"
-         executionOrder="depends,defects"
-         beStrictAboutOutputDuringTests="true"
-         failOnRisky="true"
-         failOnWarning="true"
-         beStrictAboutCoverageMetadata="true">
-    <testsuites>
-        <testsuite name="default">
-            <directory>tests</directory>
-        </testsuite>
-    </testsuites>
-    <coverage>
-        <include>
-            <directory suffix=".php">src</directory>
-        </include>
-    </coverage>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.5/phpunit.xsd" bootstrap="vendor/autoload.php" cacheDirectory=".phpunit.cache" executionOrder="depends,defects" beStrictAboutOutputDuringTests="true" failOnRisky="true" failOnWarning="true" beStrictAboutCoverageMetadata="true">
+  <testsuites>
+    <testsuite name="default">
+      <directory>tests</directory>
+    </testsuite>
+  </testsuites>
+  <source>
+    <include>
+      <directory suffix=".php">src</directory>
+    </include>
+  </source>
 </phpunit>

php/psalm.xml

@@ -2,6 +2,8 @@
 <psalm
     errorLevel="1"
     resolveFromConfigFile="true"
+    findUnusedBaselineEntry="false"
+    findUnusedCode="false"
     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"

php/src/AstNode.php

@@ -62,8 +62,14 @@ public function getSingle(string $expectedType, RuleType $ruleType, ?object $def
         return $items[0] ?? $defaultValue;
     }
 
-    /** needed for non-object return */
-    public function getSingleUntyped(RuleType $ruleType, mixed $defaultValue = null): mixed
+    /**
+     * needed for non-object return
+     *
+     * @param null|string $defaultValue
+     *
+     * @psalm-param ''|null $defaultValue
+     */
+    public function getSingleUntyped(RuleType $ruleType, string|null $defaultValue = null): mixed
     {
         $items = $this->subItems[$ruleType->name] ?? [];
 

php/src/ParserException/UnexpectedEofException.php

@@ -7,6 +7,9 @@
 use Cucumber\Gherkin\ParserException;
 use Cucumber\Gherkin\Token;
 
+/**
+ * @psalm-api
+ */
 final class UnexpectedEofException extends ParserException
 {
     /**

php/src/ParserException/UnexpectedTokenException.php

@@ -8,6 +8,9 @@
 use Cucumber\Gherkin\ParserException;
 use Cucumber\Gherkin\Token;
 
+/**
+ * @psalm-api
+ */
 final class UnexpectedTokenException extends ParserException
 {
     /**