Added RequireMultiLineNullCoalesceSniff

Author: vossik

InfinityloopCodingStandard/Sniffs/ControlStructures/RequireMultiLineNullCoalesceSniff.php

@@ -0,0 +1,117 @@
+<?php declare(strict_types = 1);
+
+namespace InfinityloopCodingStandard\Sniffs\ControlStructures;
+
+use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Sniffs\Sniff;
+use SlevomatCodingStandard\Helpers\TokenHelper;
+use function array_merge;
+use function in_array;
+use function strlen;
+use function substr;
+use const T_COALESCE;
+use const T_OPEN_TAG;
+use const T_OPEN_TAG_WITH_ECHO;
+use const T_WHITESPACE;
+
+class RequireMultiLineNullCoalesceSniff implements Sniff
+{
+
+    public const CODE_MULTI_LINE_NULL_COALESCE_OPERATOR_NOT_USED = 'MultiLineNullCoalesceOperatorNotUsed';
+
+    private const TAB_INDENT = "\t";
+    private const SPACES_INDENT = '    ';
+
+    /**
+     * @return array<int, (int|string)>
+     */
+    public function register(): array
+    {
+        return [
+            T_COALESCE,
+        ];
+    }
+
+    /**
+     * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint
+     * @param File $phpcsFile
+     * @param int $coalescePointer
+     */
+    public function process(File $phpcsFile, $coalescePointer): void
+    {
+        $tokens = $phpcsFile->getTokens();
+
+        /** @var int $variablePointer */
+        $variablePointer = TokenHelper::findPrevious($phpcsFile, T_VARIABLE, $coalescePointer + 1);
+
+        if ($tokens[$coalescePointer]['line'] !== $tokens[$variablePointer]['line']) {
+            return;
+        }
+
+        $fix = $phpcsFile->addFixableError('Null coalesce operator should be reformatted to next line.', $coalescePointer, self::CODE_MULTI_LINE_NULL_COALESCE_OPERATOR_NOT_USED);
+
+        if (!$fix) {
+            return;
+        }
+
+        $endOfLineBeforeCoalescePointer = $this->getEndOfLineBefore($phpcsFile, $coalescePointer);
+
+        $indentation = $this->getIndentation($phpcsFile, $endOfLineBeforeCoalescePointer);
+
+        $phpcsFile->fixer->beginChangeset();
+        $phpcsFile->fixer->addContentBefore($coalescePointer, $phpcsFile->eolChar . $indentation);
+        $phpcsFile->fixer->endChangeset();
+    }
+
+    private function getEndOfLineBefore(File $phpcsFile, int $pointer): int
+    {
+        $tokens = $phpcsFile->getTokens();
+
+        $endOfLineBefore = null;
+
+        $startPointer = $pointer - 1;
+        while (true) {
+            $possibleEndOfLinePointer = TokenHelper::findPrevious(
+                $phpcsFile,
+                array_merge([T_WHITESPACE, T_OPEN_TAG, T_OPEN_TAG_WITH_ECHO], TokenHelper::$inlineCommentTokenCodes),
+                $startPointer
+            );
+            if ($tokens[$possibleEndOfLinePointer]['code'] === T_WHITESPACE && $tokens[$possibleEndOfLinePointer]['content'] === $phpcsFile->eolChar) {
+                $endOfLineBefore = $possibleEndOfLinePointer;
+                break;
+            }
+
+            if ($tokens[$possibleEndOfLinePointer]['code'] === T_OPEN_TAG || $tokens[$possibleEndOfLinePointer]['code'] === T_OPEN_TAG_WITH_ECHO) {
+                $endOfLineBefore = $possibleEndOfLinePointer;
+                break;
+            }
+
+            if (
+                in_array($tokens[$possibleEndOfLinePointer]['code'], TokenHelper::$inlineCommentTokenCodes, true)
+                && substr($tokens[$possibleEndOfLinePointer]['content'], -1) === $phpcsFile->eolChar
+            ) {
+                $endOfLineBefore = $possibleEndOfLinePointer;
+                break;
+            }
+
+            $startPointer = $possibleEndOfLinePointer - 1;
+        }
+
+        /** @var int $endOfLineBefore */
+        $endOfLineBefore = $endOfLineBefore;
+        return $endOfLineBefore;
+    }
+
+    private function getIndentation(File $phpcsFile, int $endOfLinePointer): string
+    {
+        $pointerAfterWhitespace = TokenHelper::findNextExcluding($phpcsFile, T_WHITESPACE, $endOfLinePointer + 1);
+        $actualIndentation = TokenHelper::getContent($phpcsFile, $endOfLinePointer + 1, $pointerAfterWhitespace - 1);
+
+        if (strlen($actualIndentation) !== 0) {
+            return $actualIndentation . (substr($actualIndentation, -1) === self::TAB_INDENT ? self::TAB_INDENT : self::SPACES_INDENT);
+        }
+
+        $tabPointer = TokenHelper::findPreviousContent($phpcsFile, T_WHITESPACE, self::TAB_INDENT, $endOfLinePointer - 1);
+        return $tabPointer !== null ? self::TAB_INDENT : self::SPACES_INDENT;
+    }
+}

InfinityloopCodingStandard/ruleset.xml

@@ -44,6 +44,7 @@
     <rule ref="Generic.Commenting.Todo"/>
     <rule ref="Generic.ControlStructures.InlineControlStructure"/>
     <rule ref="Generic.Files.ByteOrderMark"/>
+    <rule ref="Generic.Files.EndFileNewline"/>
     <rule ref="Generic.Files.InlineHTML"/>
     <rule ref="Generic.Files.LineEndings">
         <properties>
@@ -517,4 +518,5 @@
     </rule>
     <rule ref="InfinityloopCodingStandard.Classes.FinalClassVisibility"/>
     <rule ref="InfinityloopCodingStandard.Namespaces.UseDoesNotStartWithBackslash"/>
+    <rule ref="InfinityloopCodingStandard.ControlStructures.RequireMultiLineNullCoalesce"/>
 </ruleset>

README.md

@@ -72,6 +72,10 @@ When class is final and doesnt extend any other class, it's safe to change visib
 
 Inverted `SlevomatCodingStandard.Namespaces.UseDoesNotStartWithBackslash` sniff - require imports to start with backslash.
 
+#### InfinityloopCodingStandard.ControlStructures.RequireMultiLineNullCoalesce :wrench:
+
+Enforces null coalesce operator to be reformatted to new line
+
 ### Slevomat sniffs
 
 Detailed list of Slevomat sniffs with configured settings. Some sniffs are not included, either because we dont find them helpful, the are too strict, or collide with their counter-sniff (require/disallow pairs).

composer.json

@@ -8,7 +8,7 @@
 	"require": {
 		"php": "^7.4",
 		"squizlabs/php_codesniffer": "~3.5.3",
-		"slevomat/coding-standard": "~6.1.1"
+		"slevomat/coding-standard": "~6.3.8"
 	},
 	"autoload": {
 		"psr-4": {