Check for operator at end of line

Author: VincentLanglet

SymfonyCustom/Sniffs/Operators/OperatorPlacementSniff.php

@@ -0,0 +1,57 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SymfonyCustom\Sniffs\Operators;
+
+use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Sniffs\Sniff;
+use PHP_CodeSniffer\Util\Tokens;
+
+/**
+ * Checks that the operator is at the start of the line.
+ */
+class OperatorPlacementSniff implements Sniff
+{
+    /**
+     * @return int[]
+     */
+    public function register(): array
+    {
+        $targets = Tokens::$comparisonTokens;
+        $targets += Tokens::$operators;
+        $targets[] = T_STRING_CONCAT;
+        $targets[] = T_INLINE_THEN;
+        $targets[] = T_INLINE_ELSE;
+
+        return $targets;
+    }
+
+    /**
+     * @param File $phpcsFile
+     * @param int  $stackPtr
+     *
+     * @return void
+     */
+    public function process(File $phpcsFile, $stackPtr): void
+    {
+        $tokens = $phpcsFile->getTokens();
+
+        $next = $phpcsFile->findNext(Tokens::$emptyTokens, $stackPtr + 1, null, true);
+
+        if ($tokens[$stackPtr]['line'] === $tokens[$next]['line']) {
+            return;
+        }
+
+        $content = $tokens[$stackPtr]['content'];
+        $error = 'Operator "%s" should be on the start of the next line';
+        $fix = $phpcsFile->addFixableError($error, $stackPtr, 'OperatorPlacement', [$content]);
+
+        if ($fix) {
+            $phpcsFile->fixer->beginChangeset();
+            $phpcsFile->fixer->replaceToken($stackPtr, '');
+            $phpcsFile->fixer->addContentBefore($next, $content);
+            $phpcsFile->fixer->endChangeset();
+        }
+    }
+}

SymfonyCustom/Tests/Operators/OperatorPlacementUnitTest.inc

@@ -0,0 +1,20 @@
+<?php
+
+$a = 'foo'.// With comment
+    'foo';
+
+$a = 'foo'.
+    'foo';
+
+$a = 'foo'
+    .'foo';
+
+$a = 'foo'?
+    'foo':
+    'bar';
+
+$a = 1+
+    1;
+
+$a = 1<
+    1;

SymfonyCustom/Tests/Operators/OperatorPlacementUnitTest.inc.fixed

@@ -0,0 +1,20 @@
+<?php
+
+$a = 'foo'// With comment
+    .'foo';
+
+$a = 'foo'
+    .'foo';
+
+$a = 'foo'
+    .'foo';
+
+$a = 'foo'
+    ?'foo'
+    :'bar';
+
+$a = 1
+    +1;
+
+$a = 1
+    <1;

SymfonyCustom/Tests/Operators/OperatorPlacementUnitTest.php

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SymfonyCustom\Tests\Operators;
+
+use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
+
+/**
+ * Unit test class for the OperatorPlacement sniff.
+ */
+class OperatorPlacementUnitTest extends AbstractSniffUnitTest
+{
+    /**
+     * @return array<int, int>
+     */
+    protected function getErrorList(): array
+    {
+        return [
+            3  => 1,
+            6  => 1,
+            12 => 1,
+            13 => 1,
+            16 => 1,
+            19 => 1,
+        ];
+    }
+
+    /**
+     * @return array<int, int>
+     */
+    protected function getWarningList(): array
+    {
+        return [];
+    }
+}