ReturnTypeHintSniff: Fixed fixer for "void" in union type hint

Author: kukulich

SlevomatCodingStandard/Helpers/TypeHintHelper.php

@@ -7,6 +7,7 @@
 use SlevomatCodingStandard\Helpers\Annotation\TypeAliasAnnotation;
 use SlevomatCodingStandard\Helpers\Annotation\TypeImportAnnotation;
 use function array_key_exists;
+use function array_map;
 use function array_merge;
 use function array_unique;
 use function count;
@@ -355,6 +356,12 @@ private static function normalize(string $typeHint): string
 
 		$convertedParts = array_unique($convertedParts);
 
+		if (count($convertedParts) > 1) {
+			$convertedParts = array_map(static function (string $part): string {
+				return $part === 'void' ? 'null' : $part;
+			}, $convertedParts);
+		}
+
 		sort($convertedParts);
 
 		return implode('|', $convertedParts);

SlevomatCodingStandard/Sniffs/TypeHints/ReturnTypeHintSniff.php

@@ -341,7 +341,9 @@ private function checkFunctionTypeHint(
 				return;
 			}
 
-			$typeHintsWithConvertedUnion[$typeHintNo] = TypeHintHelper::convertLongSimpleTypeHintToShort($typeHint);
+			$typeHintsWithConvertedUnion[$typeHintNo] = $typeHint === 'void'
+				? 'null'
+				: TypeHintHelper::convertLongSimpleTypeHintToShort($typeHint);
 		}
 
 		if ($originalReturnTypeNode instanceof NullableTypeNode) {

tests/Sniffs/TypeHints/ReturnTypeHintSniffTest.php

@@ -87,6 +87,7 @@ public function testErrors(): void
 	public function testWithUnionNoErrors(): void
 	{
 		$report = self::checkFile(__DIR__ . '/data/returnTypeHintWithUnionNoErrors.php', [
+			'enableObjectTypeHint' => true,
 			'enableMixedTypeHint' => true,
 			'enableUnionTypeHint' => true,
 			'traversableTypeHints' => ['Traversable', '\ArrayIterator'],
@@ -97,12 +98,13 @@ public function testWithUnionNoErrors(): void
 	public function testWithUnionErrors(): void
 	{
 		$report = self::checkFile(__DIR__ . '/data/returnTypeHintWithUnionErrors.php', [
+			'enableObjectTypeHint' => true,
 			'enableMixedTypeHint' => true,
 			'enableUnionTypeHint' => true,
 			'traversableTypeHints' => ['Traversable', '\ArrayIterator'],
 		]);
 
-		self::assertSame(14, $report->getErrorCount());
+		self::assertSame(15, $report->getErrorCount());
 
 		self::assertSniffError($report, 7, ReturnTypeHintSniff::CODE_MISSING_NATIVE_TYPE_HINT);
 		self::assertSniffError($report, 11, ReturnTypeHintSniff::CODE_MISSING_NATIVE_TYPE_HINT);
@@ -119,6 +121,7 @@ public function testWithUnionErrors(): void
 		self::assertSniffError($report, 51, ReturnTypeHintSniff::CODE_MISSING_NATIVE_TYPE_HINT);
 		self::assertSniffError($report, 55, ReturnTypeHintSniff::CODE_MISSING_NATIVE_TYPE_HINT);
 		self::assertSniffError($report, 59, ReturnTypeHintSniff::CODE_MISSING_NATIVE_TYPE_HINT);
+		self::assertSniffError($report, 63, ReturnTypeHintSniff::CODE_MISSING_NATIVE_TYPE_HINT);
 
 		self::assertAllFixedInFile($report);
 	}

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

@@ -59,4 +59,8 @@ private function numericNullable(): int|float|null
 	private function scalarAndnumericNullable(): string|int|float|bool|null
 	{}
 
+	/***/
+	private function objectAndVoid(): object|null
+	{}
+
 }

tests/Sniffs/TypeHints/data/returnTypeHintWithUnionErrors.php

@@ -59,4 +59,8 @@ private function numericNullable()
 	private function scalarAndnumericNullable()
 	{}
 
+	/** @return object|void */
+	private function objectAndVoid()
+	{}
+
 }