Merge branch 'master' into dependabot/github_actions/codecov/codecov-action-6

Author: acoulton

.php-cs-fixer.dist.php

@@ -40,5 +40,8 @@
         'single_line_throw' => false,
         'ternary_to_null_coalescing' => true,
         'global_namespace_import' => false,
+        'phpdoc_to_comment' => [ // Keep as a phpdoc if it contains the `@var` annotation
+            'ignored_tags' => ['var'],
+        ],
     ])
     ->setFinder($finder);

bin/update_i18n

@@ -24,6 +24,17 @@ foreach ($gherkinLanguages as $lang => $keywords) {
             $words = [$words];
         }
 
+        assert(array_find($words, fn ($word) => !is_string($word)) === null, 'Expected $words to be an array of strings');
+        /**
+         * Here we force phpstan to recognise that we have narrowed the type of $words to a list of strings with the
+         * assertion above. Otherwise it will report an error from the later `implode()` call that $words must be a
+         * list<string>.
+         *
+         * There does not currently seem to be a way to force phpstan to detect this type narrowing at runtime
+         * https://github.com/phpstan/phpstan/issues/14360
+         *
+         * @var array<string> $words
+         */
         if ($type === 'scenarioOutline') {
             $type = 'scenario_outline';
         }
@@ -32,7 +43,6 @@ foreach ($gherkinLanguages as $lang => $keywords) {
             $formattedKeywords = [];
 
             foreach ($words as $word) {
-                assert(is_string($word));
                 $formattedWord = trim($word);
 
                 if ($formattedWord === $word) {
@@ -45,12 +55,14 @@ foreach ($gherkinLanguages as $lang => $keywords) {
             $words = $formattedKeywords;
         }
 
-        usort($words, static function ($type1, $type2) {
-            assert(is_string($type1));
-            assert(is_string($type2));
+        foreach ($words as $word) {
+            assert(is_string($word));
+        }
 
-            return [mb_strlen($type2, 'utf8'), $type1] <=> [mb_strlen($type1, 'utf8'), $type2];
-        });
+        usort(
+            $words,
+            static fn (string $type1, string $type2) => [mb_strlen($type2, 'utf8'), $type1] <=> [mb_strlen($type1, 'utf8'), $type2]
+        );
 
         $langMessages[$type] = implode('|', $words);
     }

src/Gherkin.php

@@ -151,6 +151,12 @@ public function resolveLoader(mixed $resource)
     {
         foreach ($this->loaders as $loader) {
             if ($loader->supports($resource)) {
+                /**
+                 * If the loader supports the provided resource, then it can safely be typed as
+                 * LoaderInterface<ResourceType>.
+                 *
+                 * @var LoaderInterface<TResourceType> $loader
+                 */
                 return $loader;
             }
         }

src/Loader/LoaderInterface.php

@@ -24,11 +24,9 @@ interface LoaderInterface
     /**
      * Checks if current loader supports provided resource.
      *
-     * @template TSupportedResourceType
+     * @param mixed $resource Resource to load
      *
-     * @param TSupportedResourceType $resource Resource to load
-     *
-     * @phpstan-assert-if-true =LoaderInterface<TSupportedResourceType> $this
+     * @phpstan-assert-if-true =TResourceType $resource
      *
      * @return bool
      */