Docs: improve type specificity

PHPCSStandards · Sep 10, 2024 · 373aa4e · 373aa4e
1 parent 681125d
commit 373aa4e
Show file tree

Hide file tree

Showing 9 changed files with 25 additions and 25 deletions.
diff --git a/Scripts/FeatureComplete/Check.php b/Scripts/FeatureComplete/Check.php
@@ -78,14 +78,14 @@ final class Check
     /**
      * List of all docs files in the repo.
      *
-     * @var array
+     * @var array<string>
      */
     protected $allDocs = [];
 
     /**
      * List of all test files in the repo.
      *
-     * @var array
+     * @var array<string>
      */
     protected $allTests = [];
 

diff --git a/Scripts/FeatureComplete/Config.php b/Scripts/FeatureComplete/Config.php
@@ -135,7 +135,7 @@ final class Config
     /**
      * Help texts.
      *
-     * @var array
+     * @var array<string, array<array<string, string>>>
      */
     private $helpTexts = [
         // phpcs:disable Generic.Files.LineLength.TooLong

diff --git a/Tests/FeatureComplete/Check/ColorTest.php b/Tests/FeatureComplete/Check/ColorTest.php
@@ -63,7 +63,7 @@ public function testColors($fixtureDir, $expectedOutput, $exitCode, $src = 'stdo
     /**
      * Data provider.
      *
-     * @return array
+     * @return array<string, array<string, string|int>>
      */
     public function dataColors()
     {

diff --git a/Tests/FeatureComplete/Check/MarkProgressTest.php b/Tests/FeatureComplete/Check/MarkProgressTest.php
@@ -103,7 +103,7 @@ public function testProgress($nrOfFiles, $expectedOutput)
     /**
      * Data provider.
      *
-     * @return array
+     * @return array<string, array<string, int|string>>
      */
     public function dataProgress()
     {

diff --git a/Tests/FeatureComplete/Check/NoSniffsTest.php b/Tests/FeatureComplete/Check/NoSniffsTest.php
@@ -76,7 +76,7 @@ public function testTargetDoesntContainSniffs($fixtureDir)
     /**
      * Data provider.
      *
-     * @return array
+     * @return array<string, array<string>>
      */
     public function dataTargetDoesntContainSniffs()
     {

diff --git a/Tests/FeatureComplete/Check/ValidStandardsTest.php b/Tests/FeatureComplete/Check/ValidStandardsTest.php
@@ -61,7 +61,7 @@ public function testFeatureCompleteStandard($fixtureDir, $testDocCount)
     /**
      * Data provider.
      *
-     * @return array
+     * @return array<string, array<string, string|int>>
      */
     public function dataFeatureCompleteStandard()
     {

diff --git a/Tests/FeatureComplete/Config/GetHelpTest.php b/Tests/FeatureComplete/Config/GetHelpTest.php
@@ -105,7 +105,7 @@ public function testShowHelpNoColors($command)
     /**
      * Data provider.
      *
-     * @return array
+     * @return array<string, array<string, string>>
      */
     public function dataShowHelp()
     {

diff --git a/Tests/FeatureComplete/Config/GetVersionTest.php b/Tests/FeatureComplete/Config/GetVersionTest.php
@@ -47,7 +47,7 @@ public function testShowVersion($command)
     /**
      * Data provider.
      *
-     * @return array
+     * @return array<string, array<string, string>>
      */
     public function dataShowVersion()
     {

diff --git a/Tests/FeatureComplete/Config/ProcessCliCommandTest.php b/Tests/FeatureComplete/Config/ProcessCliCommandTest.php
@@ -28,7 +28,7 @@ final class ProcessCliCommandTest extends XTestCase
     /**
      * Relevant properties in the Config class and their default value.
      *
-     * @var array
+     * @var array<string, mixed>
      */
     private $defaultSettings = [
         'projectRoot'  => '',
@@ -71,7 +71,7 @@ public function testProcessCliCommandUnsupportedArgument($command)
     /**
      * Data provider.
      *
-     * @return array
+     * @return array<string, array<string, string>>
      */
     public function dataProcessCliCommandUnsupportedArgument()
     {
@@ -107,14 +107,14 @@ public function testProcessInvalidTargetThrowException()
      *
      * @dataProvider dataProcessCliCommand
      *
-     * @param string $command          The command as received from the command line.
-     * @param array  $expectedChanged  The Config class properties which are expected to have been
-     *                                 changed (key) with their value.
-     * @param bool   $checkShowColored Whether to check the value of the "showColored" setting.
-     *                                 This setting should only be checked when `--color` or
-     *                                 `--no-color` has been explicitly passed in the $command
-     *                                 as the auto-detection is not testable.
-     *                                 Defaults to `false`.
+     * @param string                                       $command          The command as received from the command line.
+     * @param array<string, string|bool|int|array<string>> $expectedChanged  The Config class properties which are expected to have been
+     *                                                                       changed (key) with their value.
+     * @param bool                                         $checkShowColored Whether to check the value of the "showColored" setting.
+     *                                                                       This setting should only be checked when `--color` or
+     *                                                                       `--no-color` has been explicitly passed in the $command
+     *                                                                       as the auto-detection is not testable.
+     *                                                                       Defaults to `false`.
      *
      * @return void
      */
@@ -139,7 +139,7 @@ public function testProcessCliCommand($command, array $expectedChanged, $checkSh
     /**
      * Data provider.
      *
-     * @return array
+     * @return array<string, array<string, string|bool|array<string, string|bool|int|array<string>>>>
      */
     public function dataProcessCliCommand()
     {
@@ -378,9 +378,9 @@ public function dataProcessCliCommand()
      *
      * @dataProvider dataProcessCliCommandOutputOnlyArgs
      *
-     * @param string $command         The command as received from the command line.
-     * @param array  $expectedChanged The Config class properties which are expected to have been
-     *                                changed (key) with their value.
+     * @param string                     $command         The command as received from the command line.
+     * @param array<string, string|bool> $expectedChanged The Config class properties which are expected to have been
+     *                                                    changed (key) with their value.
      *
      * @return void
      */
@@ -400,7 +400,7 @@ public function testProcessCliCommandOutputOnlyArgs($command, $expectedChanged)
     /**
      * Data provider.
      *
-     * @return array
+     * @return array<string, array<string, string|array<string, string|bool>>>
      */
     public function dataProcessCliCommandOutputOnlyArgs()
     {
@@ -447,7 +447,7 @@ public function dataProcessCliCommandOutputOnlyArgs()
      *
      * @param \PHPCSDevTools\Scripts\FeatureComplete\Config $config Config object
      *
-     * @return array
+     * @return array<string, mixed>
      */
     private function getCurrentValues(Config $config)
     {