Merge pull request #215 from ergebnis/feature/no-superfluous-phpdoc-tags

Enhancement: Enable and configure no_superfluous_phpdoc_tags fixer
ergebnis · Oct 21, 2020 · 309a510 · 309a510
2 parents de56d93 + e2ff2b3
commit 309a510
Show file tree

Hide file tree

Showing 11 changed files with 43 additions and 26 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,7 +6,15 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ## Unreleased
 
-For a full diff see [`2.3.0...main`][2.3.0...main].
+For a full diff see [`2.4.0...main`][2.4.0...main].
+
+## [`2.4.0`][2.4.0]
+
+For a full diff see [`2.3.0...2.4.0`][2.3.0...2.4.0].
+
+### Changed
+
+* Enabled `no_superfluous_phpdoc_tags` fixer ([#215]), by [@localheinz]
 
 ## [`2.3.0`][2.3.0]
 
@@ -103,6 +111,7 @@ For a full diff see [`d899e77...1.0.0`][d899e77...1.0.0].
 [2.2.1]: https://github.com/ergebnis/php-cs-fixer-config/releases/tag/2.2.1
 [2.2.2]: https://github.com/ergebnis/php-cs-fixer-config/releases/tag/2.2.2
 [2.3.0]: https://github.com/ergebnis/php-cs-fixer-config/releases/tag/2.3.0
+[2.4.0]: https://github.com/ergebnis/php-cs-fixer-config/releases/tag/2.4.0
 
 [d899e77...1.0.0]: https://github.com/ergebnis/php-cs-fixer-config/compare/d899e77...1.0.0
 [1.0.0...1.1.0]: https://github.com/ergebnis/php-cs-fixer-config/compare/1.0.0...1.1.0
@@ -115,7 +124,8 @@ For a full diff see [`d899e77...1.0.0`][d899e77...1.0.0].
 [2.2.0...2.2.1]: https://github.com/ergebnis/php-cs-fixer-config/compare/2.2.0...2.2.1
 [2.2.1...2.2.2]: https://github.com/ergebnis/php-cs-fixer-config/compare/2.2.1...2.2.2
 [2.2.2...2.3.0]: https://github.com/ergebnis/php-cs-fixer-config/compare/2.2.1...2.3.0
-[2.3.0...main]: https://github.com/ergebnis/php-cs-fixer-config/compare/2.3.0...main
+[2.3.0...2.4.0]: https://github.com/ergebnis/php-cs-fixer-config/compare/2.3.0...2.4.0
+[2.4.0...main]: https://github.com/ergebnis/php-cs-fixer-config/compare/2.4.0...main
 
 [#3]: https://github.com/ergebnis/php-cs-fixer-config/pull/3
 [#14]: https://github.com/ergebnis/php-cs-fixer-config/pull/14
@@ -127,6 +137,7 @@ For a full diff see [`d899e77...1.0.0`][d899e77...1.0.0].
 [#135]: https://github.com/ergebnis/php-cs-fixer-config/pull/135
 [#168]: https://github.com/ergebnis/php-cs-fixer-config/pull/168
 [#200]: https://github.com/ergebnis/php-cs-fixer-config/pull/200
+[#215]: https://github.com/ergebnis/php-cs-fixer-config/pull/215
 
 [@dependabot]: https://github.com/apps/dependabot
 [@linuxjuggler]: https://github.com/linuxjuggler

diff --git a/src/Factory.php b/src/Factory.php
@@ -20,12 +20,7 @@ final class Factory
     /**
      * Creates a configuration based on a rule set.
      *
-     * @param RuleSet $ruleSet
-     * @param array   $overrideRules
-     *
      * @throws \RuntimeException
-     *
-     * @return Config
      */
     public static function fromRuleSet(RuleSet $ruleSet, array $overrideRules = []): Config
     {

diff --git a/src/RuleSet.php b/src/RuleSet.php
@@ -17,24 +17,18 @@ interface RuleSet
 {
     /**
      * Returns the name of the rule set.
-     *
-     * @return string
      */
     public function name(): string;
 
     /**
      * Returns an array of rules along with their configuration.
-     *
-     * @return array
      */
     public function rules(): array;
 
     /**
      * Returns the minimum required PHP version (PHP_VERSION_ID).
      *
      * @see http://php.net/manual/en/reserved.constants.php
-     *
-     * @return int
      */
     public function targetPhpVersion(): int;
 }
diff --git a/src/RuleSet/Php71.php b/src/RuleSet/Php71.php
@@ -193,7 +193,11 @@ final class Php71 extends AbstractRuleSet
         'no_singleline_whitespace_before_semicolons' => true,
         'no_spaces_around_offset' => true,
         'no_superfluous_elseif' => true,
-        'no_superfluous_phpdoc_tags' => false,
+        'no_superfluous_phpdoc_tags' => [
+            'allow_mixed' => true,
+            'allow_unused_params' => false,
+            'remove_inheritdoc' => false,
+        ],
         'no_trailing_comma_in_list_call' => true,
         'no_trailing_comma_in_singleline_array' => true,
         'no_unneeded_control_parentheses' => true,

diff --git a/src/RuleSet/Php73.php b/src/RuleSet/Php73.php
@@ -193,7 +193,11 @@ final class Php73 extends AbstractRuleSet
         'no_singleline_whitespace_before_semicolons' => true,
         'no_spaces_around_offset' => true,
         'no_superfluous_elseif' => true,
-        'no_superfluous_phpdoc_tags' => false,
+        'no_superfluous_phpdoc_tags' => [
+            'allow_mixed' => true,
+            'allow_unused_params' => false,
+            'remove_inheritdoc' => false,
+        ],
         'no_trailing_comma_in_list_call' => true,
         'no_trailing_comma_in_singleline_array' => true,
         'no_unneeded_control_parentheses' => true,

diff --git a/src/RuleSet/Php74.php b/src/RuleSet/Php74.php
@@ -192,7 +192,11 @@ final class Php74 extends AbstractRuleSet
         'no_singleline_whitespace_before_semicolons' => true,
         'no_spaces_around_offset' => true,
         'no_superfluous_elseif' => true,
-        'no_superfluous_phpdoc_tags' => false,
+        'no_superfluous_phpdoc_tags' => [
+            'allow_mixed' => true,
+            'allow_unused_params' => false,
+            'remove_inheritdoc' => false,
+        ],
         'no_trailing_comma_in_list_call' => true,
         'no_trailing_comma_in_singleline_array' => true,
         'no_unneeded_control_parentheses' => true,

diff --git a/test/Unit/FactoryTest.php b/test/Unit/FactoryTest.php
@@ -66,8 +66,6 @@ public function targetPhpVersion(): int
 
     /**
      * @dataProvider providerTargetPhpVersion
-     *
-     * @param int $targetPhpVersion
      */
     public function testFromRuleSetCreatesConfig(int $targetPhpVersion): void
     {

diff --git a/test/Unit/RuleSet/AbstractRuleSetTestCase.php b/test/Unit/RuleSet/AbstractRuleSetTestCase.php
@@ -127,7 +127,6 @@ final public function providerValidHeader(): \Generator
     /**
      * @dataProvider providerRuleNames
      *
-     * @param string   $source
      * @param string[] $ruleNames
      */
     final public function testRulesAreSortedByName(string $source, array $ruleNames): void
@@ -159,8 +158,6 @@ final public function providerRuleNames(): \Generator
 
     /**
      * @throws \RuntimeException
-     *
-     * @return string
      */
     final protected static function className(): string
     {
@@ -188,8 +185,6 @@ final protected static function className(): string
      * @param string $header
      *
      * @throws \RuntimeException
-     *
-     * @return Config\RuleSet
      */
     final protected static function createRuleSet($header = null): Config\RuleSet
     {

diff --git a/test/Unit/RuleSet/Php71Test.php b/test/Unit/RuleSet/Php71Test.php
@@ -199,7 +199,11 @@ final class Php71Test extends AbstractRuleSetTestCase
         'no_singleline_whitespace_before_semicolons' => true,
         'no_spaces_around_offset' => true,
         'no_superfluous_elseif' => true,
-        'no_superfluous_phpdoc_tags' => false,
+        'no_superfluous_phpdoc_tags' => [
+            'allow_mixed' => true,
+            'allow_unused_params' => false,
+            'remove_inheritdoc' => false,
+        ],
         'no_trailing_comma_in_list_call' => true,
         'no_trailing_comma_in_singleline_array' => true,
         'no_unneeded_control_parentheses' => true,

diff --git a/test/Unit/RuleSet/Php73Test.php b/test/Unit/RuleSet/Php73Test.php
@@ -199,7 +199,11 @@ final class Php73Test extends AbstractRuleSetTestCase
         'no_singleline_whitespace_before_semicolons' => true,
         'no_spaces_around_offset' => true,
         'no_superfluous_elseif' => true,
-        'no_superfluous_phpdoc_tags' => false,
+        'no_superfluous_phpdoc_tags' => [
+            'allow_mixed' => true,
+            'allow_unused_params' => false,
+            'remove_inheritdoc' => false,
+        ],
         'no_trailing_comma_in_list_call' => true,
         'no_trailing_comma_in_singleline_array' => true,
         'no_unneeded_control_parentheses' => true,

diff --git a/test/Unit/RuleSet/Php74Test.php b/test/Unit/RuleSet/Php74Test.php
@@ -198,7 +198,11 @@ final class Php74Test extends AbstractRuleSetTestCase
         'no_singleline_whitespace_before_semicolons' => true,
         'no_spaces_around_offset' => true,
         'no_superfluous_elseif' => true,
-        'no_superfluous_phpdoc_tags' => false,
+        'no_superfluous_phpdoc_tags' => [
+            'allow_mixed' => true,
+            'allow_unused_params' => false,
+            'remove_inheritdoc' => false,
+        ],
         'no_trailing_comma_in_list_call' => true,
         'no_trailing_comma_in_singleline_array' => true,
         'no_unneeded_control_parentheses' => true,