Remove NoVoidGetterMethodRule as not that practical (#125)

symplify · May 25, 2024 · 57c08e8 · 57c08e8
1 parent a9766b3
commit 57c08e8
Show file tree

Hide file tree

Showing 15 changed files with 1 addition and 366 deletions.
diff --git a/config/naming-rules.neon b/config/naming-rules.neon
@@ -1,7 +1,6 @@
 rules:
     - Symplify\PHPStanRules\Rules\Explicit\ExplicitClassPrefixSuffixRule
     - Symplify\PHPStanRules\Rules\NoReturnSetterMethodRule
-    - Symplify\PHPStanRules\Rules\NoVoidGetterMethodRule
     - Symplify\PHPStanRules\Rules\UppercaseConstantRule
     - Symplify\PHPStanRules\Rules\ClassNameRespectsParentSuffixRule
     - Symplify\PHPStanRules\Rules\CheckTypehintCallerTypeRule

diff --git a/docs/rules_overview.md b/docs/rules_overview.md
@@ -1,4 +1,4 @@
-# 41 Rules Overview
+# 40 Rules Overview
 
 ## AnnotateRegexClassConstWithRegexLinkRule
 
@@ -1100,40 +1100,6 @@ final class SkipApiMock extends TestCase
 
 <br>
 
-## NoVoidGetterMethodRule
-
-Getter method must return something, not void
-
-- class: [`Symplify\PHPStanRules\Rules\NoVoidGetterMethodRule`](../src/Rules/NoVoidGetterMethodRule.php)
-
-```php
-final class SomeClass
-{
-    public function getData(): void
-    {
-        // ...
-    }
-}
-```
-
-:x:
-
-<br>
-
-```php
-final class SomeClass
-{
-    public function getData(): array
-    {
-        // ...
-    }
-}
-```
-
-:+1:
-
-<br>
-
 ## PreferredClassRule
 
 Instead of "%s" class/interface use "%s"

diff --git a/src/Rules/NoVoidGetterMethodRule.php b/src/Rules/NoVoidGetterMethodRule.php
diff --git a/tests/Rules/NoVoidGetterMethodRule/Fixture/SkipAbstractGetter.php b/tests/Rules/NoVoidGetterMethodRule/Fixture/SkipAbstractGetter.php
diff --git a/tests/Rules/NoVoidGetterMethodRule/Fixture/SkipGetterWithReturn.php b/tests/Rules/NoVoidGetterMethodRule/Fixture/SkipGetterWithReturn.php
diff --git a/tests/Rules/NoVoidGetterMethodRule/Fixture/SkipIfElseReturn.php b/tests/Rules/NoVoidGetterMethodRule/Fixture/SkipIfElseReturn.php
diff --git a/tests/Rules/NoVoidGetterMethodRule/Fixture/SkipInterfaceContractGetter.php b/tests/Rules/NoVoidGetterMethodRule/Fixture/SkipInterfaceContractGetter.php
diff --git a/tests/Rules/NoVoidGetterMethodRule/Fixture/SkipNoThrows.php b/tests/Rules/NoVoidGetterMethodRule/Fixture/SkipNoThrows.php
diff --git a/tests/Rules/NoVoidGetterMethodRule/Fixture/SkipSetter.php b/tests/Rules/NoVoidGetterMethodRule/Fixture/SkipSetter.php
diff --git a/tests/Rules/NoVoidGetterMethodRule/Fixture/SkipYieldFrom.php b/tests/Rules/NoVoidGetterMethodRule/Fixture/SkipYieldFrom.php
diff --git a/tests/Rules/NoVoidGetterMethodRule/Fixture/SkipYielder.php b/tests/Rules/NoVoidGetterMethodRule/Fixture/SkipYielder.php
diff --git a/tests/Rules/NoVoidGetterMethodRule/Fixture/SomeGetterVoid.php b/tests/Rules/NoVoidGetterMethodRule/Fixture/SomeGetterVoid.php
diff --git a/tests/Rules/NoVoidGetterMethodRule/Fixture/SomeGetterWithNoReturn.php b/tests/Rules/NoVoidGetterMethodRule/Fixture/SomeGetterWithNoReturn.php
diff --git a/tests/Rules/NoVoidGetterMethodRule/NoVoidGetterMethodRuleTest.php b/tests/Rules/NoVoidGetterMethodRule/NoVoidGetterMethodRuleTest.php
diff --git a/tests/Rules/NoVoidGetterMethodRule/config/configured_rule.neon b/tests/Rules/NoVoidGetterMethodRule/config/configured_rule.neon