SlevomatCodingStandard.TypeHints.ClassConstantTypeHint: fixing only private constants

Author: maryo

SlevomatCodingStandard/Sniffs/TypeHints/ClassConstantTypeHintSniff.php

@@ -13,6 +13,7 @@
 use function array_key_exists;
 use function count;
 use function sprintf;
+use const T_CLOSE_CURLY_BRACKET;
 use const T_CONST;
 use const T_CONSTANT_ENCAPSED_STRING;
 use const T_DNUMBER;
@@ -22,7 +23,10 @@
 use const T_LNUMBER;
 use const T_MINUS;
 use const T_NULL;
+use const T_OPEN_CURLY_BRACKET;
 use const T_OPEN_SHORT_ARRAY;
+use const T_PRIVATE;
+use const T_SEMICOLON;
 use const T_START_HEREDOC;
 use const T_START_NOWDOC;
 use const T_TRUE;
@@ -34,8 +38,14 @@ class ClassConstantTypeHintSniff implements Sniff
 	public const CODE_USELESS_DOC_COMMENT = 'UselessDocComment';
 	public const CODE_USELESS_VAR_ANNOTATION = 'UselessVarAnnotation';
 
+	private const YES = 'yes';
+	private const NO = 'no';
+	private const PRIVATE = 'private';
+
 	public ?bool $enableNativeTypeHint = null;
 
+	public string $fixableNativeTypeHint = self::YES;
+
 	/** @var array<int|string, string> */
 	private static array $tokenToTypeHintMapping = [
 		T_FALSE => 'false',
@@ -113,7 +123,14 @@ private function checkNativeTypeHint(File $phpcsFile, int $constantPointer): voi
 			self::CODE_MISSING_NATIVE_TYPE_HINT,
 		];
 
-		if ($typeHint === null) {
+		if (
+			$typeHint === null
+			|| $this->fixableNativeTypeHint === self::NO
+			|| (
+				$this->fixableNativeTypeHint === self::PRIVATE
+				&& !$this->isConstantPrivate($phpcsFile, $constantPointer)
+			)
+		) {
 			$phpcsFile->addError(...$errorParameters);
 			return;
 		}
@@ -193,4 +210,16 @@ private function getConstantNamePointer(File $phpcsFile, int $constantPointer):
 		return TokenHelper::findPreviousEffective($phpcsFile, $equalPointer - 1);
 	}
 
+	private function isConstantPrivate(File $phpcsFile, int $constantPointer): bool
+	{
+		$tokens = $phpcsFile->getTokens();
+		$previousPointer = TokenHelper::findPrevious(
+			$phpcsFile,
+			[T_PRIVATE, T_OPEN_CURLY_BRACKET, T_CLOSE_CURLY_BRACKET, T_SEMICOLON],
+			$constantPointer - 1,
+		);
+
+		return $previousPointer !== null && $tokens[$previousPointer]['code'] === T_PRIVATE;
+	}
+
 }

doc/type-hints.md

@@ -8,6 +8,7 @@
 Sniff provides the following settings:
 
 * `enableNativeTypeHint`: enforces native typehint. It's on by default if you're on PHP 8.3+
+* `fixableNativeTypeHint`: (default: `yes`) allows fixing native type hints. Use `no` to disable fixing, or `private` to fix only private constants (safer for inheritance/interface compatibility).
 
 #### SlevomatCodingStandard.TypeHints.DeclareStrictTypes 🔧
 

tests/Sniffs/TypeHints/ClassConstantTypeHintSniffTest.php

@@ -43,6 +43,22 @@ public function testNativeTypeHintErrors(): void
 		self::assertAllFixedInFile($report);
 	}
 
+	public function testNativeTypeHintPrivateErrors(): void
+	{
+		$report = self::checkFile(__DIR__ . '/data/classConstantTypeHintNativePrivateErrors.php', [
+			'enableNativeTypeHint' => true,
+			'fixableNativeTypeHint' => 'private',
+		]);
+
+		self::assertSame(4, $report->getErrorCount());
+
+		foreach (range(6, 9) as $line) {
+			self::assertSniffError($report, $line, ClassConstantTypeHintSniff::CODE_MISSING_NATIVE_TYPE_HINT);
+		}
+
+		self::assertAllFixedInFile($report);
+	}
+
 	public function testUselessDocCommentNoErrors(): void
 	{
 		$report = self::checkFile(__DIR__ . '/data/classConstantTypeHintUselessDocCommentNoErrors.php', [

tests/Sniffs/TypeHints/data/classConstantTypeHintNativePrivateErrors.fixed.php

@@ -0,0 +1,11 @@
+<?php // lint >= 8.3
+
+class Whatever
+{
+
+	const C_IMPLICIT_PUBLIC = 'implicit_public';
+	public const C_EXPLICIT_PUBLIC = 'explicit_public';
+	protected const C_PROTECTED = 'protected';
+	private const string C_PRIVATE = 'private';
+
+}

tests/Sniffs/TypeHints/data/classConstantTypeHintNativePrivateErrors.php

@@ -0,0 +1,11 @@
+<?php // lint >= 8.3
+
+class Whatever
+{
+
+	const C_IMPLICIT_PUBLIC = 'implicit_public';
+	public const C_EXPLICIT_PUBLIC = 'explicit_public';
+	protected const C_PROTECTED = 'protected';
+	private const C_PRIVATE = 'private';
+
+}