PSR2R.WhiteSpace.ConsistentIndent

Author: dereuromark

PSR2R/Sniffs/WhiteSpace/ConsistentIndentSniff.php

@@ -57,6 +57,11 @@ public function process(File $phpcsFile, int $stackPtr): void {
 			return;
 		}
 
+		// Skip comments - they should maintain their context's indentation
+		if ($tokens[$nextToken]['code'] === T_COMMENT || $tokens[$nextToken]['code'] === T_DOC_COMMENT_OPEN_TAG) {
+			return;
+		}
+
 		// Skip closing braces - they're allowed to be dedented
 		if ($tokens[$nextToken]['code'] === T_CLOSE_CURLY_BRACKET) {
 			return;
@@ -70,11 +75,12 @@ public function process(File $phpcsFile, int $stackPtr): void {
 		// Get the expected indentation based on scope
 		$expectedIndent = $this->getExpectedIndent($phpcsFile, $nextToken, $tokens);
 
-		// Special handling for break/continue in switch statements
+		// Special handling for control flow keywords in switch statements
 		// They can be indented one level deeper (at case body level)
-		if (in_array($tokens[$nextToken]['code'], [T_BREAK, T_CONTINUE], true)) {
+		$switchControlFlowTokens = [T_BREAK, T_CONTINUE, T_RETURN, T_THROW];
+		if (in_array($tokens[$nextToken]['code'], $switchControlFlowTokens, true)) {
 			if ($this->isInSwitch($tokens, $nextToken)) {
-				// Allow one extra level of indentation for break/continue in switch
+				// Allow one extra level of indentation in switch
 				// (they're typically at the same level as case body code)
 				if ($currentIndent === $expectedIndent + 1) {
 					return;
@@ -235,6 +241,8 @@ protected function startsWithContinuationOperator(int $nextToken, array $tokens)
 			\T_MINUS,
 			\T_MULTIPLY,
 			\T_DIVIDE,
+			\T_INLINE_THEN, // Ternary ?
+			\T_INLINE_ELSE, // Ternary :
 		];
 
 		return in_array($tokens[$nextToken]['code'], $continuationStarters, true);
@@ -270,7 +278,8 @@ protected function isValidContinuation(File $phpcsFile, int $prevToken, array $t
 			\T_LOGICAL_AND,
 			\T_LOGICAL_OR,
 			\T_INSTANCEOF,
-			\T_INLINE_THEN,
+			\T_INLINE_THEN, // Ternary ?
+			\T_INLINE_ELSE, // Ternary :
 			\T_COALESCE,
 			\T_OBJECT_OPERATOR,
 			\T_NULLSAFE_OBJECT_OPERATOR,
@@ -281,6 +290,13 @@ protected function isValidContinuation(File $phpcsFile, int $prevToken, array $t
 			\T_DIV_EQUAL,
 			\T_CONCAT_EQUAL,
 			\T_MOD_EQUAL,
+			\T_IS_EQUAL, // ==
+			\T_IS_NOT_EQUAL, // !=
+			\T_IS_IDENTICAL, // ===
+			\T_IS_NOT_IDENTICAL, // !==
+			\T_IS_SMALLER_OR_EQUAL, // <=
+			\T_IS_GREATER_OR_EQUAL, // >=
+			\T_SPACESHIP, // <=>
 		];
 
 		if (in_array($prevCode, $continuationTokens, true)) {

tests/PSR2R/Sniffs/WhiteSpace/ConsistentIndentControlFlowNoErrorsSniffTest.php

@@ -0,0 +1,78 @@
+<?php
+
+/**
+ * MIT License
+ * For full license information, please view the LICENSE file that was distributed with this source code.
+ */
+
+namespace PSR2R\Test\PSR2R\Sniffs\WhiteSpace;
+
+use PSR2R\Sniffs\WhiteSpace\ConsistentIndentSniff;
+use PSR2R\Test\TestCase;
+
+/**
+ * Tests that ConsistentIndentSniff does not flag valid control flow patterns.
+ */
+class ConsistentIndentControlFlowNoErrorsSniffTest extends TestCase {
+
+	/**
+	 * Test that valid control flow patterns are not flagged.
+	 *
+	 * @return void
+	 */
+	public function testConsistentIndentControlFlowNoErrors(): void {
+		$this->assertSnifferFindsErrors(new ConsistentIndentSniff(), 0);
+	}
+
+	/**
+	 * Test that no changes are made to valid code.
+	 *
+	 * @return void
+	 */
+	public function testConsistentIndentControlFlowNoErrorsFixer(): void {
+		$this->assertSnifferCanFixErrors(new ConsistentIndentSniff(), 0);
+	}
+
+	/**
+	 * @return string
+	 */
+	protected function testFilePath(): string {
+		return implode(DIRECTORY_SEPARATOR, [
+			__DIR__,
+			'..', '..', '..', '_data',
+		]) . DIRECTORY_SEPARATOR;
+	}
+
+	/**
+	 * @param \PHP_CodeSniffer\Sniffs\Sniff $sniffer
+	 *
+	 * @return string
+	 */
+	protected function getDummyFileBefore($sniffer): string {
+		$className = 'ConsistentIndentControlFlowNoErrors';
+
+		$file = $this->testFilePath() . $className . DIRECTORY_SEPARATOR . static::FILE_BEFORE;
+		if (!file_exists($file)) {
+			$this->fail(sprintf('File not found: %s.', $file));
+		}
+
+		return $file;
+	}
+
+	/**
+	 * @param \PHP_CodeSniffer\Sniffs\Sniff $sniffer
+	 *
+	 * @return string
+	 */
+	protected function getDummyFileAfter($sniffer): string {
+		$className = 'ConsistentIndentControlFlowNoErrors';
+
+		$file = $this->testFilePath() . $className . DIRECTORY_SEPARATOR . static::FILE_AFTER;
+		if (!file_exists($file)) {
+			$this->fail(sprintf('File not found: %s.', $file));
+		}
+
+		return $file;
+	}
+
+}

tests/PSR2R/Sniffs/WhiteSpace/ConsistentIndentControlFlowSniffTest.php

@@ -0,0 +1,37 @@
+<?php
+
+/**
+ * MIT License
+ * For full license information, please view the LICENSE file that was distributed with this source code.
+ */
+
+namespace PSR2R\Test\PSR2R\Sniffs\WhiteSpace;
+
+use PSR2R\Sniffs\WhiteSpace\ConsistentIndentSniff;
+use PSR2R\Test\TestCase;
+
+/**
+ * Tests for ConsistentIndentSniff with control flow keywords (return, break, continue, throw).
+ */
+class ConsistentIndentControlFlowSniffTest extends TestCase {
+
+	/**
+	 * Test that the sniffer finds orphaned control flow statements.
+	 *
+	 * @return void
+	 */
+	public function testConsistentIndentControlFlowSniffer(): void {
+		$errors = $this->runFixer(new ConsistentIndentSniff());
+		$this->assertGreaterThan(0, count($errors), 'Should find at least one error');
+	}
+
+	/**
+	 * Test that the fixer can fix orphaned control flow statements.
+	 *
+	 * @return void
+	 */
+	public function testConsistentIndentControlFlowFixer(): void {
+		$this->assertSnifferCanFixErrors(new ConsistentIndentSniff());
+	}
+
+}