✨ Minor improvements

Author: VincentLanglet

SymfonyCustom/Sniffs/Namespaces/UnusedUseSniff.php

@@ -109,8 +109,13 @@ public function process(File $phpcsFile, $stackPtr)
                     true
                 );
 
-                // If a backslash is used before the class name then this is some other use statement.
-                if (T_USE !== $tokens[$beforeUsage]['code'] && T_NS_SEPARATOR !== $tokens[$beforeUsage]['code']) {
+                if (!in_array($tokens[$beforeUsage]['code'], [
+                    T_USE,
+                    // If a backslash is used before the class name then this is some other use statement.
+                    T_NS_SEPARATOR,
+                    // If an object operator is used before the class name then is a class property.
+                    T_OBJECT_OPERATOR,
+                ])) {
                     return;
                 }
 

SymfonyCustom/Sniffs/WhiteSpace/CloseBracketSpacingSniff.php

@@ -7,7 +7,7 @@
 use PHP_CodeSniffer\Util\Tokens;
 
 /**
- * Checks that there is no white space before a closing bracket, for ")" and "}".
+ * Checks that there is no white space before a closing bracket, for ")", "}", and array bracket.
  * Square Brackets are handled by Squiz_Sniffs_Arrays_ArrayBracketSpacingSniff.
  */
 class CloseBracketSpacingSniff implements Sniff

SymfonyCustom/Sniffs/WhiteSpace/OpenBracketSpacingSniff.php

@@ -6,7 +6,7 @@
 use PHP_CodeSniffer\Sniffs\Sniff;
 
 /**
- * Checks that there is no white space after an opening bracket, for "(" and "{".
+ * Checks that there is no white space after an opening bracket, for "(", "{", and array bracket.
  * Square Brackets are handled by Squiz_Sniffs_Arrays_ArrayBracketSpacingSniff.
  */
 class OpenBracketSpacingSniff implements Sniff

SymfonyCustom/Tests/Namespaces/UnusedUseUnitTest.inc

@@ -13,6 +13,7 @@ use Client;
 use Clients;
 use PasClient;
 use Somewhere\Something;
+use Somewhere\SomethingElse;
 
 class Container
 {
@@ -28,7 +29,8 @@ class Container
     function test (Bar $bar): Something
     {
         /** @var Client|Clients[]|PasClient $client */
+        $client = [$this->somethingElse];
 
-        return;
+        return $client;
     }
 }

SymfonyCustom/Tests/Namespaces/UnusedUseUnitTest.inc.fixed

@@ -27,7 +27,8 @@ class Container
     function test (Bar $bar): Something
     {
         /** @var Client|Clients[]|PasClient $client */
+        $client = [$this->somethingElse];
 
-        return;
+        return $client;
     }
 }

SymfonyCustom/Tests/Namespaces/UnusedUseUnitTest.php

@@ -23,6 +23,7 @@ public function getErrorList()
     {
         return [
             11 => 1,
+            16 => 1,
         ];
     }
 

SymfonyCustom/ruleset.xml

@@ -60,12 +60,10 @@
     </rule>
 
     <!-- Added by VincentLanglet repo -->
-    <rule ref="Generic.PHP.ForbiddenFunctions"/>
-    <rule ref="Squiz.PHP.DiscouragedFunctions"/>
-    <rule ref="Squiz.Strings.DoubleQuoteUsage">
-        <exclude name="Squiz.Strings.DoubleQuoteUsage.ContainsVar"/>
-    </rule>
+    <!-- Whitespace -->
+    <rule ref="Squiz.WhiteSpace.CastSpacing"/>
     <rule ref="Squiz.WhiteSpace.FunctionOpeningBraceSpace"/>
+    <rule ref="Squiz.WhiteSpace.LogicalOperatorSpacing"/>
     <rule ref="Squiz.WhiteSpace.OperatorSpacing">
         <properties>
             <property name="ignoreNewlines" value="true"/>
@@ -77,9 +75,19 @@
         </properties>
     </rule>
     <rule ref="Squiz.WhiteSpace.SemicolonSpacing"/>
+
+    <!-- Comment -->
+    <rule ref="Generic.Commenting.DocComment">
+        <exclude name="Generic.Commenting.DocComment.MissingShort"/>
+    </rule>
+    <rule ref="Squiz.Commenting.DocCommentAlignment"/>
+
+    <!-- Others -->
+    <rule ref="Generic.PHP.ForbiddenFunctions"/>
+    <rule ref="Squiz.PHP.DiscouragedFunctions"/>
     <rule ref="Generic.Arrays.DisallowLongArraySyntax"/>
+    <rule ref="Squiz.Strings.DoubleQuoteUsage">
+        <exclude name="Squiz.Strings.DoubleQuoteUsage.ContainsVar"/>
+    </rule>
     <rule ref="Generic.CodeAnalysis.EmptyPHPStatement"/>
-    <rule ref="Squiz.WhiteSpace.LogicalOperatorSpacing"/>
-    <rule ref="Squiz.WhiteSpace.CastSpacing"/>
-    <rule ref="Squiz.WhiteSpace.ObjectOperatorSpacing"/>
 </ruleset>

docs/standards.md

@@ -138,6 +138,15 @@ we do not respect this rule:
 </rule>
 ```
 
+- DocComment should start on a new line, end on a new line and be correctly indented
+
+```
+<rule ref="Generic.Commenting.DocComment">
+    <exclude name="Generic.Commenting.DocComment.MissingShort"/>
+</rule>
+<rule ref="Squiz.Commenting.DocCommentAlignment"/>
+```
+
 ### Custom
 - Some others checks are made about array (`=>` alignments and indentation)
 

docs/standards/symfony.md

@@ -182,7 +182,7 @@ Covered by `PSR1` completed by
 
 - Add PHPDoc blocks for all classes, methods, and functions
 
-We added exceptions for functions `setUp`, `tearDown` and `tests` with no `@param` or `@return`
+We added exceptions for functions with no `@param` or `@return`
 ```
 <rule ref="SymfonyCustom.Commenting.ClassComment"/>
 <rule ref="SymfonyCustom.Commenting.FunctionComment"/>