Merge pull request #10 from ProtonMail/enforce-typehints-1

Add SlevomatCodingStandard.TypeHints.ParameterTypeHint/ReturnTypeHint/PropertyTypeHint rules

Author: BafS

Proton/ruleset.xml

@@ -133,6 +133,7 @@
     <!-- Forbid uses of multiple traits separated by comma -->
     <rule ref="SlevomatCodingStandard.Classes.TraitUseDeclaration"/>
     <rule ref="SlevomatCodingStandard.Classes.UselessLateStaticBinding"/>
+    <!-- use `::class` when possible -->
     <rule ref="SlevomatCodingStandard.Classes.ModernClassNameReference"/>
     <rule ref="SlevomatCodingStandard.Classes.PropertyDeclaration">
         <properties>
@@ -177,6 +178,15 @@
     <rule ref="SlevomatCodingStandard.TypeHints.ParameterTypeHintSpacing"/>
     <rule ref="SlevomatCodingStandard.TypeHints.NullTypeHintOnLastPosition"/>
     <rule ref="SlevomatCodingStandard.TypeHints.NullableTypeForNullDefaultValue"/>
+    <rule ref="SlevomatCodingStandard.TypeHints.ParameterTypeHint">
+        <exclude name="SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingTraversableTypeHintSpecification"/>
+    </rule>
+    <rule ref="SlevomatCodingStandard.TypeHints.ReturnTypeHint">
+        <exclude name="SlevomatCodingStandard.TypeHints.ReturnTypeHint.MissingTraversableTypeHintSpecification"/>
+    </rule>
+    <rule ref="SlevomatCodingStandard.TypeHints.PropertyTypeHint">
+        <exclude name="SlevomatCodingStandard.TypeHints.PropertyTypeHint.MissingTraversableTypeHintSpecification"/>
+    </rule>
     <!-- Define unions style -->
     <rule ref="SlevomatCodingStandard.TypeHints.UnionTypeHintFormat">
         <properties>

tests/correct/ClassOk.php

@@ -5,6 +5,7 @@
 namespace Proton\Test;
 
 use Proton\Http\Request;
+
 use function Proton\Support\phpinfo2;
 
 final class ClassOk
@@ -17,9 +18,8 @@ final class ClassOk
 
     /**
      * Foo.
-     * @var array
      */
-    protected $foo = [];
+    protected array $foo = [];
     private string $test = 'foo';
 
     public function __construct(array $config)
@@ -33,7 +33,7 @@ public function __construct(array $config)
         call_user_func(fn () => {});
     }
 
-    public function ping(Request $request)
+    public function ping(Request $request): mixed
     {
         try {
             $this->foo(
@@ -49,9 +49,8 @@ public function ping(Request $request)
 
     /**
      * @deprecated This is a message
-     * @return bool|string
      */
-    public function foo(string $a, string $b)
+    public function foo(string $a, string $b): bool|string
     {
         $a = $a . 'test';
 

tests/expected_csv.txt

@@ -2,23 +2,33 @@ Line,Column,Type,Source
 4,10,error,PSR2.Files.EndFileNewline.NoneFound
 1,1,error,SlevomatCodingStandard.TypeHints.DeclareStrictTypes.DeclareStrictTypesMissing
 6,12,warning,Generic.Metrics.NestingLevel.TooHigh
+6,12,error,SlevomatCodingStandard.TypeHints.ReturnTypeHint.MissingAnyTypeHint
+6,12,error,SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingAnyTypeHint
+6,12,error,SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingAnyTypeHint
+6,12,error,SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingAnyTypeHint
+6,12,error,SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingAnyTypeHint
+6,12,error,SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingAnyTypeHint
+6,12,error,SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingAnyTypeHint
 5,20,error,PSR2.Classes.ClassDeclaration.OpenBraceNewLine
 21,11,error, found 10"
 20,9,warning,Generic.CodeAnalysis.UnconditionalIfStatement.Found
 20,9,error,SlevomatCodingStandard.ControlStructures.UselessIfConditionWithReturn.UselessIfCondition
 1,1,error,SlevomatCodingStandard.TypeHints.DeclareStrictTypes.DeclareStrictTypesMissing
 8,1,error, found 1."
-61,1,error,PSR2.Files.EndFileNewline.NoneFound
+62,1,error,PSR2.Files.EndFileNewline.NoneFound
 6,18,error,PSR12.Files.FileHeader.SpacingInsideBlock
-57,60,error,SlevomatCodingStandard.TypeHints.UnionTypeHintFormat.NullTypeHintNotOnLastPosition
-57,32,error,SlevomatCodingStandard.TypeHints.UnionTypeHintFormat.NullTypeHintNotOnLastPosition
-57,13,warning,Generic.CodeAnalysis.UnusedFunctionParameter.Found
-52,54,error,SlevomatCodingStandard.TypeHints.ReturnTypeHintSpacing.WhitespaceBeforeColon
-52,54,error,SlevomatCodingStandard.TypeHints.UnionTypeHintFormat.DisallowedWhitespace
-52,52,error,PSR12.Functions.ReturnTypeDeclaration.SpaceBeforeColon
-52,20,warning,Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed
-52,20,error,PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-50,8,error,SlevomatCodingStandard.Commenting.DeprecatedAnnotationDeclaration.MissingDescription
+58,60,error,SlevomatCodingStandard.TypeHints.UnionTypeHintFormat.NullTypeHintNotOnLastPosition
+58,32,error,SlevomatCodingStandard.TypeHints.UnionTypeHintFormat.NullTypeHintNotOnLastPosition
+58,13,warning,Generic.CodeAnalysis.UnusedFunctionParameter.Found
+53,54,error,SlevomatCodingStandard.TypeHints.ReturnTypeHintSpacing.WhitespaceBeforeColon
+53,54,error,SlevomatCodingStandard.TypeHints.UnionTypeHintFormat.DisallowedWhitespace
+53,52,error,PSR12.Functions.ReturnTypeDeclaration.SpaceBeforeColon
+53,20,warning,Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed
+53,20,error,PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+53,20,error,SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingAnyTypeHint
+53,20,error,SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingAnyTypeHint
+51,8,error,SlevomatCodingStandard.Commenting.DeprecatedAnnotationDeclaration.MissingDescription
+50,8,error,SlevomatCodingStandard.TypeHints.ParameterTypeHint.UselessAnnotation
 45,13,error,SlevomatCodingStandard.Functions.RequireTrailingCommaInCall.MissingTrailingComma
 44,1,error,Generic.WhiteSpace.DisallowTabIndent.TabsUsed
 43,1,error,Generic.WhiteSpace.DisallowTabIndent.TabsUsed
@@ -38,6 +48,7 @@ Line,Column,Type,Source
 36,24,error,Generic.Formatting.DisallowMultipleStatements.SameLine
 36,1,error,Generic.WhiteSpace.DisallowTabIndent.TabsUsed
 34,31,error,Squiz.Functions.MultiLineFunctionDeclaration.BraceOnSameLine
+34,13,error,SlevomatCodingStandard.TypeHints.ReturnTypeHint.MissingAnyTypeHint
 31,24,error,Proton.Spacing.ArrowFunctionSpacing.Found
 28,27,error,PSR12.Classes.AnonClassDeclaration.SpaceAfterKeyword
 25,13,error,SlevomatCodingStandard.Arrays.TrailingArrayComma.MissingTrailingComma
@@ -48,6 +59,7 @@ Line,Column,Type,Source
 16,5,error,SlevomatCodingStandard.Classes.TraitUseDeclaration.MultipleTraitsPerDeclaration
 16,16,error,PSR12.Traits.UseDeclaration.MultipleImport
 14,5,warning,PSR12.Properties.ConstantVisibility.NotFound
+12,13,error,SlevomatCodingStandard.TypeHints.PropertyTypeHint.MissingAnyTypeHint
 12,13,error,Squiz.NamingConventions.ValidVariableName.MemberNotCamelCaps
 12,1,error,Generic.WhiteSpace.DisallowTabIndent.TabsUsed
 10,27,error,SlevomatCodingStandard.Classes.EmptyLinesAroundClassBraces.IncorrectEmptyLinesAfterOpeningBrace

tests/wrong/Class1.php

@@ -47,6 +47,7 @@ private function unused() {
     }
 
     /**
+     * @param string $a
      * @deprecated
      */
     private static function Foo(string $a, $b, $c) : array |object