Removed PHP 7.4 support + added new sniff for space at (inline) comment

.gitignore

@@ -3,4 +3,5 @@
 .phpintel
 /vendor/
 out.csv
+out.diff
 composer.lock

Proton/Sniffs/Commenting/InlineCommentSniff.php

@@ -0,0 +1,67 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Proton\Sniffs\Commenting;
+
+use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Sniffs\Sniff;
+
+class InlineCommentSniff implements Sniff
+{
+    /**
+     * @inheritDoc
+     */
+    public function register(): array
+    {
+        return [T_COMMENT];
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function process(File $phpcsFile, $stackPtr): void
+    {
+        $tokens = $phpcsFile->getTokens();
+
+        if ($tokens[$stackPtr]['content'][0] === '#') {
+            $phpcsFile->recordMetric($stackPtr, 'Inline comment style', '# ...');
+
+            $error = 'Perl-style comments are not allowed. Use "// Comment."';
+            $error .= ' or "/* comment */" instead.';
+            $fix = $phpcsFile->addFixableError($error, $stackPtr, 'WrongStyle');
+            if ($fix === true) {
+                $newComment = ltrim($tokens[$stackPtr]['content'], '# ');
+                $newComment = '// ' . $newComment;
+                $phpcsFile->fixer->replaceToken($stackPtr, $newComment);
+            }
+        } elseif ($tokens[$stackPtr]['content'][0] === '/'
+            && $tokens[$stackPtr]['content'][1] === '/'
+        ) {
+            $phpcsFile->recordMetric($stackPtr, 'Inline comment style', '// ...');
+
+            $this->checkMissingSpaceSeparator($tokens[$stackPtr]['content'], $phpcsFile, $stackPtr);
+        } elseif ($tokens[$stackPtr]['content'][0] === '/'
+            && $tokens[$stackPtr]['content'][1] === '*'
+        ) {
+            $phpcsFile->recordMetric($stackPtr, 'Inline comment style', '/* ... */');
+
+            $this->checkMissingSpaceSeparator($tokens[$stackPtr]['content'], $phpcsFile, $stackPtr);
+        }
+    }
+
+    private function checkMissingSpaceSeparator(string $content, File $phpcsFile, int $stackPtr): void
+    {
+        if ($content[2] === ' ') {
+            return;
+        }
+
+        $error = 'Missing space between comment start and comment description.';
+        $fix = $phpcsFile->addFixableError($error, $stackPtr, 'WrongStyle');
+        if ($fix === true) {
+            $type = substr($content, 0, 2);
+            $newComment = sprintf("%s %s", $type, ltrim($content, $type));
+            $phpcsFile->fixer->replaceToken($stackPtr, $newComment);
+        }
+    }
+}

Proton/Sniffs/Spacing/ArrowFunctionSpacingSniff.php

@@ -20,7 +20,7 @@ public function register(): array
     /**
      * @inheritDoc
      */
-    public function process(File $phpcsFile, $stackPtr)
+    public function process(File $phpcsFile, $stackPtr): void
     {
         $tokens = $phpcsFile->getTokens();
 

Proton/ruleset.xml

@@ -13,7 +13,7 @@
         <exclude name="PSR12.ControlStructures.ControlStructureSpacing.FirstExpressionLine"/> <!-- Clashes with PSR2 SpacingAfterOpenBrace -->
     </rule>
 
-    <rule ref="PEAR.Commenting.InlineComment"/>
+    <rule ref="Proton.Commenting.InlineComment"/>
 
     <rule ref="Generic.Commenting.Todo"/>
     <rule ref="Generic.PHP.BacktickOperator"/>

composer.json

@@ -11,11 +11,12 @@
     "minimum-stability": "dev",
     "prefer-stable": true,
     "scripts": {
+        "test-fix": "phpcs --standard=phpcs.xml --report=diff tests > tests/out.diff && diff tests/out.diff tests/expected.diff",
         "test-print": "phpcs --standard=phpcs.xml --report=summary tests",
         "test": "phpcs --standard=phpcs.xml --report=csv tests | sort -r | cut -f 2,3,4,6 -d ',' > tests/out.csv && diff tests/expected_csv.txt tests/out.csv"
     },
     "require": {
-        "php": "^7.4 || ^8.0",
+        "php": "^8.0",
         "slevomat/coding-standard": "^8.0",
         "squizlabs/php_codesniffer": "^3.7"
     },

tests/correct/ClassOk.php

@@ -25,10 +25,12 @@ final class ClassOk
 
     public function __construct(array $config)
     {
+        // This is a valid comment
         $this->bar = [
             'bar' => 'foo',
         ];
 
+        /* This is another valid comment */
         $this->foo = $config + [
             'foo' => 'bar',
         ];

tests/expected.diff

@@ -0,0 +1,223 @@
+--- tests/wrong/file.php
++++ PHP_CodeSniffer
+@@ -1,4 +1,5 @@
+ <?php
+
+-/* */
+-return [];
+\ No newline at end of file
++declare(strict_types=1);
++
++return [];
+--- tests/wrong/Class1.php
++++ PHP_CodeSniffer
+@@ -1,19 +1,17 @@
+ <?php
+
++declare(strict_types=1);
+
+ namespace Test;
+
+-use Something\Foo;
+-
+-use Something\bar;
+-
+-abstract final class Test {
+-
+-	private $unused_field;
++abstract final class Test
++{
++    private $unused_field;
+
+     const TEST = 'NOTOK';
+
+-    use MyTrait, MyTrait2;
++    use MyTrait;
++    use MyTrait2;
+
+     public function __construct()
+     {
+@@ -22,49 +20,51 @@
+         phpinfo2();
+
+         print_r([
+-            1
+-          ]);
++            1,
++        ]);
+
+-        $this->test = new class() {
++        $this->test = new class () {
+         };
+
+         call_user_func(fn() => {});
+     }
+
+-    private function unused() {
++    private function unused()
++    {
+         $fooBar = 1;
+-    	$foo_bar = '1';;
++        $foo_bar = '1';
+
+-    	IF($foo_bar == '1') {
+-    		return true;
+-    		return true;
+-    	}
+-
+-    	$this->foo(
+-    	    'a',
+-            2
++
++        if ($foo_bar === '1') {
++            return true;
++            return true;
++        }
++
++        $this->foo(
++            'a',
++            2,
+         );
+     }
+
+     /**
+-     * @param string $a
+      * @deprecated
+      */
+-    private static function Foo(string $a, $b, $c) : array |object
++    private static function Foo(string $a, $b, $c): array|object
+     {
+         return [$a, $b];
+     }
+
+-    private function testUnion(null|float|int|string $a,): null|int|float
++    private function testUnion(float|int|string|null $a,): int|float|null
+     {
+         return 1;
+     }
+
+-    private function testAssignmentInCondition(int $a): void {
+-        if ($a == 1 && $b = 2) {
++    private function testAssignmentInCondition(int $a): void
++    {
++        if ($a === 1 && $b = 2) {
+             $c = 3;
+         }
+
+-        $c == 3 && $d = 4;
++        $c === 3 && $d = 4;
+     }
+-}
+\ No newline at end of file
++}
+--- tests/wrong/ClassWrongAbstract.php
++++ PHP_CodeSniffer
+@@ -2,48 +2,32 @@
+
+ declare(strict_types=1);
+
+-
+ namespace wrong;
+
+-use RuntimeException;
+-
+-/**
+- * Class ClassWrongAbstract
+- */
+ abstract class ClassWrongAbstract
+ {
+-
+     abstract public function setOne(int $one = 1): void;
+
+-    /**
+-     * one getter.
+-     *
+-     * Created by me.
+-     * User: me
+-     * Date: now
+-     * Time: now
+-     *
+-     */
+     public function getOne(): int
+     {
+-        //There should be a space separator
++        // There should be a space separator
+         return 1;
+     }
+
+-    #[Attribute1, Attribute2('var')]
+-    #[Attribute3(), Attribute4]
+     /**
+      * Method comment
+      */
++    #[Attribute1, Attribute2('var')]
++    #[Attribute3(), Attribute4]
+     public function method(
++        /** @param int $parameter */
+         #[Attribute1] #[Attribute2] #[Attribute3]
+         #[Attribute4] #[Attribute5] #[Attribute6]
+-        /** @param int $parameter */
+         int $parameter,
+     ): void {
+-        /*There should be a space separator*/
++        /* There should be a space separator*/
+         echo $parameter;
+-        # This comment is not allowed
+-        #This is wrong, too
++        // This comment is not allowed
++        // This is wrong, too
+     }
+ }
+--- tests/wrong/ContainsHTML.php
++++ PHP_CodeSniffer
+@@ -3,18 +3,18 @@
+ declare(strict_types=1);
+
+ $foo = [
+-        "foo" => 1,
++    "foo" => 1,
+ ];
+
+ $bar = [
+-  "bar" => 1,
++    "bar" => 1,
+ ];
+
+ eval("\$str = \"foo\";");
+
+-//
++// 
+
+-if (count($foo) == 1) {
++if (count($foo) === 1) {
+ }
+
+ ?>
+--- tests/wrong/ClassMetrics.php
++++ PHP_CodeSniffer
+@@ -1,8 +1,11 @@
+ <?php
+
++declare(strict_types=1);
++
+ namespace Test;
+
+-class ClassMetrics {
++class ClassMetrics
++{
+     public function foo($a, $b, $c, $d, $e, $f)
+     {
+         if ($a) {
+@@ -17,10 +20,6 @@
+             }
+         }
+
+-        if (true) {
+-          return true;
+-        } else {
+-             return false;
+-        }
++        return true;
+     }
+ }
+

tests/expected.txt

@@ -3,14 +3,15 @@ PHP CODE SNIFFER REPORT SUMMARY
 ------------------------------------------------------------------------------------------------------
 FILE                                                                                  ERRORS  WARNINGS
 ------------------------------------------------------------------------------------------------------
-/Users/Username/dev/Proton/php-coding-standard/tests/wrong/Class1.php                 51      6
+/Users/Username/dev/Proton/php-coding-standard/tests/wrong/Class1.php                 57      6
 /Users/Username/dev/Proton/php-coding-standard/tests/wrong/ClassMetrics.php           11      2
-/Users/Username/dev/Proton/php-coding-standard/tests/wrong/ClassWrongAbstract.php     3       0
-/Users/Username/dev/Proton/php-coding-standard/tests/wrong/file.php                   2       0
+/Users/Username/dev/Proton/php-coding-standard/tests/wrong/ClassWrongAbstract.php     18      0
+/Users/Username/dev/Proton/php-coding-standard/tests/wrong/ContainsHTML.php           7       1
+/Users/Username/dev/Proton/php-coding-standard/tests/wrong/file.php                   3       0
 /Users/Username/dev/Proton/php-coding-standard/tests/wrong/InterfaceWrong.php         1       0
 /Users/Username/dev/Proton/php-coding-standard/tests/wrong/TraitInvalid.php           1       0
 ------------------------------------------------------------------------------------------------------
-A TOTAL OF 91 ERRORS AND 9 WARNINGS WERE FOUND IN 7 FILES
+A TOTAL OF 98 ERRORS AND 9 WARNINGS WERE FOUND IN 7 FILES
 ------------------------------------------------------------------------------------------------------
-PHPCBF CAN FIX 63 OF THESE SNIFF VIOLATIONS AUTOMATICALLY
+PHPCBF CAN FIX 70 OF THESE SNIFF VIOLATIONS AUTOMATICALLY
 ------------------------------------------------------------------------------------------------------

tests/expected_csv.txt

@@ -8,16 +8,23 @@ Line,Column,Type,Source
 21,1,error,Generic.Files.InlineHTML.Found
 17,17,error, use === instead."
 17,1,error,Generic.CodeAnalysis.EmptyStatement.DetectedIf
+15,1,error,Proton.Commenting.InlineComment.WrongStyle
 15,1,error,SlevomatCodingStandard.Commenting.EmptyComment.EmptyComment
 13,1,warning,Squiz.PHP.Eval.Discouraged
 10,3,error,Generic.Arrays.ArrayIndent.KeyIncorrect
 8,1,error,SlevomatCodingStandard.Namespaces.UnusedUses.UnusedUse
 6,1,error, found 2."
-39,37,error,SlevomatCodingStandard.Attributes.RequireAttributeAfterDocComment.AttributeBeforeDocComment
-33,5,error,SlevomatCodingStandard.Attributes.RequireAttributeAfterDocComment.AttributeBeforeDocComment
+47,9,error,Proton.Commenting.InlineComment.WrongStyle
+46,9,error,Proton.Commenting.InlineComment.WrongStyle
+44,9,error,Proton.Commenting.InlineComment.WrongStyle
+40,37,error,SlevomatCodingStandard.Attributes.RequireAttributeAfterDocComment.AttributeBeforeDocComment
+34,5,error,SlevomatCodingStandard.Attributes.RequireAttributeAfterDocComment.AttributeBeforeDocComment
 3,1,error, found 2."
+29,9,error,Proton.Commenting.InlineComment.WrongStyle
+24,8,error,SlevomatCodingStandard.Commenting.ForbiddenComments.CommentForbidden
 23,8,error,SlevomatCodingStandard.Commenting.ForbiddenComments.CommentForbidden
 22,8,error,SlevomatCodingStandard.Commenting.ForbiddenComments.CommentForbidden
+21,8,error,SlevomatCodingStandard.Commenting.ForbiddenComments.CommentForbidden
 19,8,error,SlevomatCodingStandard.Commenting.ForbiddenComments.CommentForbidden
 14,1,error,SlevomatCodingStandard.Classes.EmptyLinesAroundClassBraces.IncorrectEmptyLinesAfterOpeningBrace
 14,1,error,PSR12.Classes.OpeningBraceSpace.Found