Merge pull request #238 from ergebnis/fix/docblock

Fix: DocBlock
ergebnis · Nov 1, 2020 · 733fdae · 733fdae
2 parents fce058a + d3363c0
commit 733fdae
Show file tree

Hide file tree

Showing 6 changed files with 24 additions and 14 deletions.
diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -1,9 +1,10 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <files psalm-version="3.18.2@19aa905f7c3c7350569999a93c40ae91ae4e1626">
   <file src="test/Unit/FactoryTest.php">
-    <MixedInferredReturnType occurrences="1">
-      <code>\Generator</code>
-    </MixedInferredReturnType>
+    <MixedPropertyTypeCoercion occurrences="2">
+      <code>$rules</code>
+      <code>$rules</code>
+    </MixedPropertyTypeCoercion>
   </file>
   <file src="test/Unit/RuleSet/AbstractRuleSetTestCase.php">
     <InternalClass occurrences="2">
@@ -16,10 +17,6 @@
       <code>getFixers</code>
       <code>registerBuiltInFixers</code>
     </InternalMethod>
-    <MixedInferredReturnType occurrences="2">
-      <code>\Generator</code>
-      <code>\Generator</code>
-    </MixedInferredReturnType>
     <MixedMethodCall occurrences="1">
       <code>getRules</code>
     </MixedMethodCall>

diff --git a/src/Factory.php b/src/Factory.php
@@ -20,6 +20,8 @@ final class Factory
     /**
      * Creates a configuration based on a rule set.
      *
+     * @param array<string, array|bool> $overrideRules
+     *
      * @throws \RuntimeException
      */
     public static function fromRuleSet(RuleSet $ruleSet, array $overrideRules = []): Config

diff --git a/src/RuleSet.php b/src/RuleSet.php
@@ -22,6 +22,8 @@ public function name(): string;
 
     /**
      * Returns an array of rules along with their configuration.
+     *
+     * @return array<string, array|bool>
      */
     public function rules(): array;
 

diff --git a/src/RuleSet/AbstractRuleSet.php b/src/RuleSet/AbstractRuleSet.php
@@ -26,7 +26,7 @@ abstract class AbstractRuleSet implements RuleSet
     protected $name = '';
 
     /**
-     * @var array
+     * @var array<string, array|bool>
      */
     protected $rules = [];
 

diff --git a/test/Unit/FactoryTest.php b/test/Unit/FactoryTest.php
@@ -85,7 +85,7 @@ public function testFromRuleSetCreatesConfig(int $targetPhpVersion): void
             private $name;
 
             /**
-             * @var array
+             * @var array<string, array|bool>
              */
             private $rules;
 
@@ -124,6 +124,9 @@ public function targetPhpVersion(): int
         self::assertSame($rules, $config->getRules());
     }
 
+    /**
+     * @return \Generator<int, array{0: int}>
+     */
     public function provideTargetPhpVersion(): \Generator
     {
         $values = [
@@ -158,7 +161,7 @@ public function testFromRuleSetCreatesConfigWithOverrideRules(): void
             private $name;
 
             /**
-             * @var array
+             * @var array<string, array|bool>
              */
             private $rules;
 

diff --git a/test/Unit/RuleSet/AbstractRuleSetTestCase.php b/test/Unit/RuleSet/AbstractRuleSetTestCase.php
@@ -105,6 +105,9 @@ final public function testHeaderCommentFixerIsEnabledIfHeaderIsProvided(string $
         self::assertSame($expected, $rules['header_comment']);
     }
 
+    /**
+     * @return \Generator<string, array{0: string}>
+     */
     final public function provideValidHeader(): \Generator
     {
         $values = [
@@ -124,8 +127,6 @@ final public function provideValidHeader(): \Generator
 
     /**
      * @dataProvider provideSourceAndRuleNames
-     *
-     * @param string[] $ruleNames
      */
     final public function testRulesAreSortedByName(string $source, array $ruleNames): void
     {
@@ -141,8 +142,6 @@ final public function testRulesAreSortedByName(string $source, array $ruleNames)
 
     /**
      * @dataProvider provideSourceAndRuleNames
-     *
-     * @param string[] $ruleNames
      */
     final public function testRulesDoNotContainRuleSets(string $source, array $ruleNames): void
     {
@@ -157,6 +156,13 @@ final public function testRulesDoNotContainRuleSets(string $source, array $ruleN
         ));
     }
 
+    /**
+     * @phpstan-return \Generator<int, array{0: class-string, 1: array<string>}>
+     *
+     * @psalm-return \Generator<int, array{0: class-string, 1: array<string>}>
+     *
+     * @return \Generator<int, array{0: string, 1: array<string>}>
+     */
     final public function provideSourceAndRuleNames(): \Generator
     {
         $values = [