Merge current expirimental rules to main ruleset (#69)

laurensotto · Laurens · web-flow · commit 36bc5bf42f47 · 2022-04-04T14:58:30.000+02:00
* Merge current expirimental rules to main ruleset

* Add allow-plugins preset to composer.json

* Solve phpcs errors

Co-authored-by: Laurens &lt;laurens.otto@hva.nl&gt;
diff --git a/composer.json b/composer.json
@@ -31,6 +31,11 @@
     "config": {
         "preferred-install": {
             "squizlabs/php_codesniffer": "source"
+        },
+        "allow-plugins": {
+            "composer/*":                                     true,
+            "hostnet/*":                                      true,
+            "dealerdirect/phpcodesniffer-composer-installer": false
         }
     },
     "extra": {
diff --git a/src/Hostnet/Component/CodeSniffer/Installer.php b/src/Hostnet/Component/CodeSniffer/Installer.php
@@ -65,11 +65,11 @@ public function activate(Composer $composer, IOInterface $io): void
         $this->io = $io;
     }
 
-    public function deactivate(Composer $composer, IOInterface $io)
+    public function deactivate(Composer $composer, IOInterface $io): void
     {
     }
 
-    public function uninstall(Composer $composer, IOInterface $io)
+    public function uninstall(Composer $composer, IOInterface $io): void
     {
     }
 
diff --git a/src/Hostnet/Sniffs/Classes/NoVerticalWhitespaceBetweenUseStatementsSniff.php b/src/Hostnet/Sniffs/Classes/NoVerticalWhitespaceBetweenUseStatementsSniff.php
@@ -25,8 +25,6 @@ public function register(): array
     /**
      * @param File $phpcs_file
      * @param int|bool $stack_ptr
-     *
-     * @return void
      */
     public function process(File $phpcs_file, $stack_ptr): void
     {
diff --git a/src/Hostnet/Sniffs/Classes/UseStatementsAlphabeticallyOrderedSniff.php b/src/Hostnet/Sniffs/Classes/UseStatementsAlphabeticallyOrderedSniff.php
@@ -37,8 +37,6 @@ public function register(): array
     /**
      * @param File $phpcs_file
      * @param int|bool $stack_ptr
-     *
-     * @return void
      */
     public function process(File $phpcs_file, $stack_ptr): void
     {
@@ -113,8 +111,6 @@ private function fixUseStatements(File $phpcs_file): void
      *
      * @param File $phpcs_file The file where the token was found.
      * @param int  $stack_ptr the current position in the stack
-     *
-     * @return void
      */
     private function createAndCheckStatements(File $phpcs_file, $stack_ptr): void
     {
diff --git a/src/Hostnet/Sniffs/Commenting/AtCoversFullyQualifiedNameSniff.php b/src/Hostnet/Sniffs/Commenting/AtCoversFullyQualifiedNameSniff.php
@@ -14,8 +14,9 @@
  */
 class AtCoversFullyQualifiedNameSniff extends FileCommentSniff
 {
-    const ERROR_TYPE    = 'AtCoversNeedsFQCN';
-    const ERROR_MESSAGE = 'Covers annotation should use fully qualified class name (it should start with a "\") "%s"';
+    private const ERROR_TYPE    = 'AtCoversNeedsFQCN';
+    private const ERROR_MESSAGE =
+        'Covers annotation should use fully qualified class name (it should start with a "\") "%s"';
 
     /**
      * @return int[]
diff --git a/src/Hostnet/Sniffs/Commenting/FileCommentCopyrightSniff.php b/src/Hostnet/Sniffs/Commenting/FileCommentCopyrightSniff.php
@@ -115,8 +115,6 @@ private function getCopyrightLine(): string
      * @param File $phpcs_file The file being scanned.
      * @param int $stack_ptr The position of the current token in the stack passed in $tokens.
      * @param int $comment_start Position in the stack where the comment started.
-     *
-     * @return void
      */
     private function processCopyrightTags(File $phpcs_file, $stack_ptr, $comment_start): void
     {
@@ -275,8 +273,6 @@ public function process(File $phpcs_file, $stack_ptr): int
      *
      * @param File $phpcs_file
      * @param array $tags
-     *
-     * @return void
      */
     protected function processCopyright(File $phpcs_file, array $tags): void
     {
diff --git a/src/Hostnet/ruleset.xml b/src/Hostnet/ruleset.xml
@@ -201,6 +201,27 @@
     <!-- Require use of short versions of scalar types (i.e. int instead of integer) -->
     <rule ref="SlevomatCodingStandard.TypeHints.LongTypeHints"/>
 
+    <rule ref="SlevomatCodingStandard.Classes.ClassConstantVisibility"/>
+
+    <rule ref="SlevomatCodingStandard.Namespaces.UnusedUses">
+        <exclude phpcbf-only="true" name="SlevomatCodingStandard.Namespaces.UnusedUses.UnusedUse"/>
+        <properties>
+            <property name="searchAnnotations" value="true"/>
+        </properties>
+    </rule>
+
+    <rule ref="SlevomatCodingStandard.TypeHints">
+        <exclude name="SlevomatCodingStandard.TypeHints.ParameterTypeHint"/>
+        <exclude name="SlevomatCodingStandard.TypeHints.PropertyTypeHint"/>
+        <exclude name="SlevomatCodingStandard.TypeHints.ReturnTypeHint.MissingTraversableTypeHintSpecification"/>
+        <exclude name="SlevomatCodingStandard.TypeHints.DisallowArrayTypeHintSyntax.DisallowedArrayTypeHintSyntax"/>
+        <exclude name="SlevomatCodingStandard.TypeHints.NullableTypeForNullDefaultValue.NullabilityTypeMissing"/>
+        <exclude name="SlevomatCodingStandard.TypeHints.DisallowMixedTypeHint.DisallowedMixedTypeHint"/>
+        <exclude name="SlevomatCodingStandard.Commenting.UselessFunctionDocComment"/>
+    </rule>
+
+    <rule ref="SlevomatCodingStandard.Commenting.UselessInheritDocComment"/>
+
     <!-- Require one space between typehint and variable, require no space between nullability sign and typehint -->
     <rule ref="Squiz.Functions.FunctionDeclarationArgumentSpacing">
         <properties>
@@ -326,4 +347,6 @@
             <property name="ignoreBlankLines" value="false"/>
         </properties>
     </rule>
+
+    <rule ref="Squiz.Strings.DoubleQuoteUsage.NotRequired" />
 </ruleset>
diff --git a/src/HostnetExperimental/ruleset.xml b/src/HostnetExperimental/ruleset.xml
@@ -2,22 +2,4 @@
 <ruleset name="HostnetExperimental">
     <description>The future Hostnet coding standard.</description>
     <rule ref="Hostnet"/>
-    <rule ref="Squiz.Strings.DoubleQuoteUsage.NotRequired" />
-    <rule ref="SlevomatCodingStandard.Classes.ClassConstantVisibility"/>
-    <rule ref="SlevomatCodingStandard.Namespaces.UnusedUses">
-        <exclude phpcbf-only="true" name="SlevomatCodingStandard.Namespaces.UnusedUses.UnusedUse"/>
-        <properties>
-            <property name="searchAnnotations" value="true"/>
-        </properties>
-    </rule>
-    <rule ref="SlevomatCodingStandard.TypeHints">
-        <exclude name="SlevomatCodingStandard.TypeHints.ParameterTypeHint"/>
-        <exclude name="SlevomatCodingStandard.TypeHints.PropertyTypeHint"/>
-        <exclude name="SlevomatCodingStandard.TypeHints.ReturnTypeHint.MissingTraversableTypeHintSpecification"/>
-        <exclude name="SlevomatCodingStandard.TypeHints.DisallowArrayTypeHintSyntax.DisallowedArrayTypeHintSyntax"/>
-        <exclude name="SlevomatCodingStandard.TypeHints.NullableTypeForNullDefaultValue.NullabilityTypeMissing"/>
-        <exclude name="SlevomatCodingStandard.TypeHints.DisallowMixedTypeHint.DisallowedMixedTypeHint"/>
-        <exclude name="SlevomatCodingStandard.Commenting.UselessFunctionDocComment"/>
-    </rule>
-    <rule ref="SlevomatCodingStandard.Commenting.UselessInheritDocComment"/>
 </ruleset>
diff --git a/test/Hostnet/Tests/Classes/AbstractClassMustBePrefixedWithAbstractUnitTest.php b/test/Hostnet/Tests/Classes/AbstractClassMustBePrefixedWithAbstractUnitTest.php
@@ -20,10 +20,8 @@ class AbstractClassMustBePrefixedWithAbstractUnitTest extends AbstractSniffUnitT
      * should represent the number of errors that should occur on that line.
      *
      * @param string $filename
-     *
-     * @return [int => int]
      */
-    public function getErrorList($filename = null)
+    public function getErrorList($filename = null): array
     {
         switch ($filename) {
             case 'AbstractClassMustBePrefixedWithAbstractUnitTest.0.inc':
@@ -44,10 +42,8 @@ public function getErrorList($filename = null)
      * should represent the number of warnings that should occur on that line.
      *
      * @param string $filename
-     *
-     * @return [int => int]
      */
-    public function getWarningList($filename = null)
+    public function getWarningList($filename = null): array
     {
         return [];
     }
diff --git a/test/Hostnet/Tests/Classes/ClassAndNamespaceMustBeInPascalCaseUnitTest.php b/test/Hostnet/Tests/Classes/ClassAndNamespaceMustBeInPascalCaseUnitTest.php
@@ -20,10 +20,8 @@ class ClassAndNamespaceMustBeInPascalCaseUnitTest extends AbstractSniffUnitTest
      * should represent the number of errors that should occur on that line.
      *
      * @param string $filename
-     *
-     * @return [int => int]
      */
-    public function getErrorList($filename = null)
+    public function getErrorList($filename = null): array
     {
         switch ($filename) {
             case 'ClassAndNamespaceMustBeInPascalCaseUnitTest.0.inc':
@@ -48,10 +46,8 @@ public function getErrorList($filename = null)
      * should represent the number of warnings that should occur on that line.
      *
      * @param string $filename
-     *
-     * @return [int => int]
      */
-    public function getWarningList($filename = null)
+    public function getWarningList($filename = null): array
     {
         return [];
     }
diff --git a/test/Hostnet/Tests/Classes/InterfaceMustBePostfixedWithInterfaceUnitTest.php b/test/Hostnet/Tests/Classes/InterfaceMustBePostfixedWithInterfaceUnitTest.php
@@ -20,10 +20,8 @@ class InterfaceMustBePostfixedWithInterfaceUnitTest extends AbstractSniffUnitTes
      * should represent the number of errors that should occur on that line.
      *
      * @param string $filename
-     *
-     * @return [int => int]
      */
-    public function getErrorList($filename = null)
+    public function getErrorList($filename = null): array
     {
         switch ($filename) {
             case 'InterfaceMustBePostfixedWithInterfaceUnitTest.0.inc':
@@ -42,10 +40,8 @@ public function getErrorList($filename = null)
      *
      * The key of the array should represent the line number and the value
      * should represent the number of warnings that should occur on that line.
-     *
-     * @return [int => int]
      */
-    public function getWarningList()
+    public function getWarningList(): array
     {
         return [];
     }
diff --git a/test/Hostnet/Tests/Classes/NoVerticalWhitespaceBetweenUseStatementsUnitTest.php b/test/Hostnet/Tests/Classes/NoVerticalWhitespaceBetweenUseStatementsUnitTest.php
@@ -21,7 +21,7 @@ class NoVerticalWhitespaceBetweenUseStatementsUnitTest extends AbstractSniffUnit
      *
      * @return array(int => int)
      */
-    public function getErrorList($filename = null)
+    public function getErrorList($filename = null): array
     {
         switch ($filename) {
             case 'NoVerticalWhitespaceBetweenUseStatementsUnitTest.0.inc':
@@ -43,7 +43,7 @@ public function getErrorList($filename = null)
      *
      * @return array(int => int)
      */
-    public function getWarningList()
+    public function getWarningList(): array
     {
         return [];
     }
diff --git a/test/Hostnet/Tests/Classes/OnlyOneUseStatementPerLineUnitTest.php b/test/Hostnet/Tests/Classes/OnlyOneUseStatementPerLineUnitTest.php
@@ -22,7 +22,7 @@ class OnlyOneUseStatementPerLineUnitTest extends AbstractSniffUnitTest
      *
      * @return array(int => int)
      */
-    public function getErrorList($filename = null)
+    public function getErrorList($filename = null): array
     {
         return [4 => 1, 5 => 1, 7 => 1];
     }
@@ -35,7 +35,7 @@ public function getErrorList($filename = null)
      *
      * @return array(int => int)
      */
-    public function getWarningList()
+    public function getWarningList(): array
     {
         return [];
     }
diff --git a/test/Hostnet/Tests/Classes/ProtectedPropertiesAreNotAllowedUnitTest.php b/test/Hostnet/Tests/Classes/ProtectedPropertiesAreNotAllowedUnitTest.php
@@ -23,7 +23,7 @@ class ProtectedPropertiesAreNotAllowedUnitTest extends AbstractSniffUnitTest
      *
      * @return array(int => int)
      */
-    public function getErrorList($filename = null)
+    public function getErrorList($filename = null): array
     {
         return [9 => 1, 23 => 1, 25 => 1, 27 => 1, 30 => 1, 32 => 2];
     }
@@ -36,7 +36,7 @@ public function getErrorList($filename = null)
      *
      * @return array(int => int)
      */
-    public function getWarningList()
+    public function getWarningList(): array
     {
         return [];
     }
diff --git a/test/Hostnet/Tests/Classes/TraitMustBePostfixedWithTraitUnitTest.php b/test/Hostnet/Tests/Classes/TraitMustBePostfixedWithTraitUnitTest.php
@@ -20,10 +20,8 @@ class TraitMustBePostfixedWithTraitUnitTest extends AbstractSniffUnitTest
      * should represent the number of errors that should occur on that line.
      *
      * @param string $filename
-     *
-     * @return [int => int]
      */
-    public function getErrorList($filename = null)
+    public function getErrorList($filename = null): array
     {
         switch ($filename) {
             case 'TraitMustBePostfixedWithTraitUnitTest.0.inc':
@@ -44,10 +42,8 @@ public function getErrorList($filename = null)
      * should represent the number of warnings that should occur on that line.
      *
      * @param string $filename
-     *
-     * @return [int => int]
      */
-    public function getWarningList($filename = null)
+    public function getWarningList($filename = null): array
     {
         return [];
     }
diff --git a/test/Hostnet/Tests/Classes/UseStatementsAlphabeticallyOrderedUnitTest.php b/test/Hostnet/Tests/Classes/UseStatementsAlphabeticallyOrderedUnitTest.php
@@ -21,7 +21,7 @@ class UseStatementsAlphabeticallyOrderedUnitTest extends AbstractSniffUnitTest
      *
      * @return array(int => int)
      */
-    public function getErrorList($filename = null)
+    public function getErrorList($filename = null): array
     {
         switch ($filename) {
             case 'UseStatementsAlphabeticallyOrderedUnitTest.0.inc':
@@ -43,7 +43,7 @@ public function getErrorList($filename = null)
      *
      * @return array(int => int)
      */
-    public function getWarningList()
+    public function getWarningList(): array
     {
         return [];
     }
diff --git a/test/Hostnet/Tests/Classes/VariableAndPropertyMustBeInSnakeCaseUnitTest.php b/test/Hostnet/Tests/Classes/VariableAndPropertyMustBeInSnakeCaseUnitTest.php
@@ -18,10 +18,8 @@ class VariableAndPropertyMustBeInSnakeCaseUnitTest extends AbstractSniffUnitTest
      *
      * The key of the array should represent the line number and the value
      * should represent the number of errors that should occur on that line.
-     *
-     * @return [int => int]
      */
-    public function getErrorList()
+    public function getErrorList(): array
     {
         return [
             6  => 1,
@@ -44,10 +42,8 @@ public function getErrorList()
      *
      * The key of the array should represent the line number and the value
      * should represent the number of warnings that should occur on that line.
-     *
-     * @return [int => int]
      */
-    public function getWarningList()
+    public function getWarningList(): array
     {
         return [];
     }
diff --git a/test/Hostnet/Tests/Commenting/AtCoversFullyQualifiedNameUnitTest.php b/test/Hostnet/Tests/Commenting/AtCoversFullyQualifiedNameUnitTest.php
@@ -21,7 +21,7 @@ class AtCoversFullyQualifiedNameUnitTest extends AbstractSniffUnitTest
      *
      * @return array(int => int)
      */
-    public function getErrorList($filename = '')
+    public function getErrorList($filename = ''): array
     {
         $list = [
             'AtCoversFullyQualifiedNameUnitTest.php.0.inc' => [
@@ -45,7 +45,7 @@ public function getErrorList($filename = '')
      *
      * @return array(int => int)
      */
-    public function getWarningList()
+    public function getWarningList(): array
     {
         return [];
     }
diff --git a/test/Hostnet/Tests/Commenting/FileCommentCopyrightUnitTest.php b/test/Hostnet/Tests/Commenting/FileCommentCopyrightUnitTest.php
@@ -18,7 +18,7 @@ class FileCommentCopyrightUnitTest extends AbstractSniffUnitTest
      *
      * @return array empty list.
      */
-    public function getErrorList($filename = '')
+    public function getErrorList($filename = ''): array
     {
         $list = [
             'FileCommentCopyrightUnitTest.1.inc'  => [
@@ -67,7 +67,7 @@ public function getErrorList($filename = '')
      *
      * @return array(int => int)
      */
-    public function getWarningList($filename = '')
+    public function getWarningList($filename = ''): array
     {
         return [];
     }
diff --git a/test/Hostnet/Tests/Declares/StrictUnitTest.php b/test/Hostnet/Tests/Declares/StrictUnitTest.php
@@ -25,7 +25,7 @@ class StrictUnitTest extends AbstractSniffUnitTest
      * @param string $test_file
      * @return array <int, int>
      */
-    public function getErrorList($test_file = '')
+    public function getErrorList($test_file = ''): array
     {
         if ($test_file === 'StrictUnitTest.1.inc') {
             return [1 => 1];
@@ -57,7 +57,7 @@ public function getErrorList($test_file = '')
      *
      * @return array<int, int>
      */
-    public function getWarningList()
+    public function getWarningList(): array
     {
         return [];
     }
diff --git a/test/Hostnet/Tests/NamingConventions/MethodNameStartsWithGetIsUnitTest.php b/test/Hostnet/Tests/NamingConventions/MethodNameStartsWithGetIsUnitTest.php
diff --git a/test/Hostnet/Tests/PhpUnit/NamespaceUnitTest.php b/test/Hostnet/Tests/PhpUnit/NamespaceUnitTest.php

Original file line number	Diff line number	Diff line change
`@@ -65,11 +65,11 @@ public function activate(Composer $composer, IOInterface $io): void`
`65`	`65`	`$this->io = $io;`
`66`	`66`	`}`
`67`	`67`
`68`		`- public function deactivate(Composer $composer, IOInterface $io)`
	`68`	`+ public function deactivate(Composer $composer, IOInterface $io): void`
`69`	`69`	`{`
`70`	`70`	`}`
`71`	`71`
`72`		`- public function uninstall(Composer $composer, IOInterface $io)`
	`72`	`+ public function uninstall(Composer $composer, IOInterface $io): void`
`73`	`73`	`{`
`74`	`74`	`}`
`75`	`75`
Original file line number	Diff line number	Diff line change
`@@ -25,8 +25,6 @@ public function register(): array`
`25`	`25`	`/**`
`26`	`26`	`* @param File $phpcs_file`
`27`	`27`	`* @param int\|bool $stack_ptr`
`28`		`- *`
`29`		`- * @return void`
`30`	`28`	`*/`
`31`	`29`	`public function process(File $phpcs_file, $stack_ptr): void`
`32`	`30`	`{`
Original file line number	Diff line number	Diff line change
`@@ -37,8 +37,6 @@ public function register(): array`
`37`	`37`	`/**`
`38`	`38`	`* @param File $phpcs_file`
`39`	`39`	`* @param int\|bool $stack_ptr`
`40`		`- *`
`41`		`- * @return void`
`42`	`40`	`*/`
`43`	`41`	`public function process(File $phpcs_file, $stack_ptr): void`
`44`	`42`	`{`
`@@ -113,8 +111,6 @@ private function fixUseStatements(File $phpcs_file): void`
`113`	`111`	`*`
`114`	`112`	`* @param File $phpcs_file The file where the token was found.`
`115`	`113`	`* @param int $stack_ptr the current position in the stack`
`116`		`- *`
`117`		`- * @return void`
`118`	`114`	`*/`
`119`	`115`	`private function createAndCheckStatements(File $phpcs_file, $stack_ptr): void`
`120`	`116`	`{`
Original file line number	Diff line number	Diff line change
`@@ -115,8 +115,6 @@ private function getCopyrightLine(): string`
`115`	`115`	`* @param File $phpcs_file The file being scanned.`
`116`	`116`	`* @param int $stack_ptr The position of the current token in the stack passed in $tokens.`
`117`	`117`	`* @param int $comment_start Position in the stack where the comment started.`
`118`		`- *`
`119`		`- * @return void`
`120`	`118`	`*/`
`121`	`119`	`private function processCopyrightTags(File $phpcs_file, $stack_ptr, $comment_start): void`
`122`	`120`	`{`
`@@ -275,8 +273,6 @@ public function process(File $phpcs_file, $stack_ptr): int`
`275`	`273`	`*`
`276`	`274`	`* @param File $phpcs_file`
`277`	`275`	`* @param array $tags`
`278`		`- *`
`279`		`- * @return void`
`280`	`276`	`*/`
`281`	`277`	`protected function processCopyright(File $phpcs_file, array $tags): void`
`282`	`278`	`{`
Original file line number	Diff line number	Diff line change
`@@ -20,10 +20,8 @@ class AbstractClassMustBePrefixedWithAbstractUnitTest extends AbstractSniffUnitT`
`20`	`20`	`* should represent the number of errors that should occur on that line.`
`21`	`21`	`*`
`22`	`22`	`* @param string $filename`
`23`		`- *`
`24`		`- * @return [int => int]`
`25`	`23`	`*/`
`26`		`- public function getErrorList($filename = null)`
	`24`	`+ public function getErrorList($filename = null): array`
`27`	`25`	`{`
`28`	`26`	`switch ($filename) {`
`29`	`27`	`case 'AbstractClassMustBePrefixedWithAbstractUnitTest.0.inc':`
`@@ -44,10 +42,8 @@ public function getErrorList($filename = null)`
`44`	`42`	`* should represent the number of warnings that should occur on that line.`
`45`	`43`	`*`
`46`	`44`	`* @param string $filename`
`47`		`- *`
`48`		`- * @return [int => int]`
`49`	`45`	`*/`
`50`		`- public function getWarningList($filename = null)`
	`46`	`+ public function getWarningList($filename = null): array`
`51`	`47`	`{`
`52`	`48`	`return [];`
`53`	`49`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,10 +20,8 @@ class ClassAndNamespaceMustBeInPascalCaseUnitTest extends AbstractSniffUnitTest`
`20`	`20`	`* should represent the number of errors that should occur on that line.`
`21`	`21`	`*`
`22`	`22`	`* @param string $filename`
`23`		`- *`
`24`		`- * @return [int => int]`
`25`	`23`	`*/`
`26`		`- public function getErrorList($filename = null)`
	`24`	`+ public function getErrorList($filename = null): array`
`27`	`25`	`{`
`28`	`26`	`switch ($filename) {`
`29`	`27`	`case 'ClassAndNamespaceMustBeInPascalCaseUnitTest.0.inc':`
`@@ -48,10 +46,8 @@ public function getErrorList($filename = null)`
`48`	`46`	`* should represent the number of warnings that should occur on that line.`
`49`	`47`	`*`
`50`	`48`	`* @param string $filename`
`51`		`- *`
`52`		`- * @return [int => int]`
`53`	`49`	`*/`
`54`		`- public function getWarningList($filename = null)`
	`50`	`+ public function getWarningList($filename = null): array`
`55`	`51`	`{`
`56`	`52`	`return [];`
`57`	`53`	`}`