Support for non-falsy-string, list and non-empty-list type hints

Author: kukulich

SlevomatCodingStandard/Helpers/AnnotationHelper.php

@@ -497,7 +497,7 @@ public static function isAnnotationUseless(
 
 			if (in_array(
 				strtolower($annotationTypeNode->name),
-				['class-string', 'trait-string', 'callable-string', 'numeric-string', 'non-empty-string', 'literal-string', 'positive-int', 'negative-int'],
+				['class-string', 'trait-string', 'callable-string', 'numeric-string', 'non-empty-string', 'non-falsy-string', 'literal-string', 'positive-int', 'negative-int'],
 				true
 			)) {
 				return false;

SlevomatCodingStandard/Helpers/AnnotationTypeHelper.php

@@ -733,7 +733,7 @@ public static function getTypeHintFromOneType(
 		if ($typeNode instanceof GenericTypeNode) {
 			$genericName = $typeNode->type->name;
 
-			if (strtolower($genericName) === 'non-empty-array') {
+			if (in_array(strtolower($genericName), ['non-empty-array', 'list', 'non-empty-list'], true)) {
 				return 'array';
 			}
 
@@ -755,7 +755,7 @@ public static function getTypeHintFromOneType(
 
 			if (in_array(
 				strtolower($typeNode->name),
-				['class-string', 'trait-string', 'callable-string', 'numeric-string', 'non-empty-string', 'literal-string'],
+				['class-string', 'trait-string', 'callable-string', 'numeric-string', 'non-empty-string', 'non-falsy-string', 'literal-string'],
 				true
 			)) {
 				return 'string';

SlevomatCodingStandard/Helpers/TypeHintHelper.php

@@ -185,6 +185,7 @@ public static function isSimpleUnofficialTypeHints(string $typeHint): bool
 				'callable-string',
 				'numeric-string',
 				'non-empty-string',
+				'non-falsy-string',
 				'literal-string',
 				'array-key',
 				'list',

SlevomatCodingStandard/Sniffs/PHP/RequireExplicitAssertionSniff.php

@@ -442,12 +442,14 @@ private function createConditions(string $variableName, TypeNode $typeNode): arr
 
 		if (
 			$this->enableAdvancedStringTypes
-			&& in_array($typeNode->name, ['non-empty-string', 'callable-string', 'numeric-string'], true)
+			&& in_array($typeNode->name, ['non-empty-string', 'non-falsy-string', 'callable-string', 'numeric-string'], true)
 		) {
 			$conditions = [sprintf('\is_string(%s)', $variableName)];
 
 			if ($typeNode->name === 'non-empty-string') {
 				$conditions[] = sprintf("%s !== ''", $variableName);
+			} elseif ($typeNode->name === 'non-falsy-string') {
+				$conditions[] = sprintf('(bool) %s === true', $variableName);
 			} elseif ($typeNode->name === 'callable-string') {
 				$conditions[] = sprintf('\is_callable(%s)', $variableName);
 			} else {

tests/Sniffs/PHP/RequireExplicitAssertionSniffTest.php

@@ -99,12 +99,13 @@ public function testAdvancedStringTypesErrors(): void
 			'enableAdvancedStringTypes' => true,
 		]);
 
-		self::assertSame(4, $report->getErrorCount());
+		self::assertSame(5, $report->getErrorCount());
 
 		self::assertSniffError($report, 3, RequireExplicitAssertionSniff::CODE_REQUIRED_EXPLICIT_ASSERTION);
 		self::assertSniffError($report, 6, RequireExplicitAssertionSniff::CODE_REQUIRED_EXPLICIT_ASSERTION);
 		self::assertSniffError($report, 9, RequireExplicitAssertionSniff::CODE_REQUIRED_EXPLICIT_ASSERTION);
 		self::assertSniffError($report, 12, RequireExplicitAssertionSniff::CODE_REQUIRED_EXPLICIT_ASSERTION);
+		self::assertSniffError($report, 15, RequireExplicitAssertionSniff::CODE_REQUIRED_EXPLICIT_ASSERTION);
 
 		self::assertAllFixedInFile($report);
 	}

tests/Sniffs/PHP/data/requireExplicitAssertionAdvancedStringTypesErrors.fixed.php

@@ -3,6 +3,9 @@
 $a = 'string';
 \assert(\is_string($a) && $a !== '');
 
+$a = 'string';
+\assert(\is_string($a) && (bool) $a === true);
+
 $b = 'MyClass::myCallbackMethod';
 \assert(\is_string($b) && \is_callable($b));
 

tests/Sniffs/PHP/data/requireExplicitAssertionAdvancedStringTypesErrors.php

@@ -3,6 +3,9 @@
 /** @var non-empty-string $a */
 $a = 'string';
 
+/** @var non-falsy-string $a */
+$a = 'string';
+
 /** @var callable-string $b */
 $b = 'MyClass::myCallbackMethod';
 

tests/Sniffs/TypeHints/ReturnTypeHintSniffTest.php

@@ -33,7 +33,7 @@ public function testErrors(): void
 			'traversableTypeHints' => ['Traversable', '\ArrayIterator'],
 		]);
 
-		self::assertSame(57, $report->getErrorCount());
+		self::assertSame(60, $report->getErrorCount());
 
 		self::assertSniffError($report, 6, ReturnTypeHintSniff::CODE_MISSING_ANY_TYPE_HINT);
 		self::assertSniffError($report, 14, ReturnTypeHintSniff::CODE_MISSING_NATIVE_TYPE_HINT);
@@ -98,6 +98,9 @@ public function testErrors(): void
 		self::assertSniffError($report, 343, ReturnTypeHintSniff::CODE_MISSING_NATIVE_TYPE_HINT);
 		self::assertSniffError($report, 348, ReturnTypeHintSniff::CODE_MISSING_NATIVE_TYPE_HINT);
 		self::assertSniffError($report, 353, ReturnTypeHintSniff::CODE_MISSING_NATIVE_TYPE_HINT);
+		self::assertSniffError($report, 358, ReturnTypeHintSniff::CODE_MISSING_NATIVE_TYPE_HINT);
+		self::assertSniffError($report, 363, ReturnTypeHintSniff::CODE_MISSING_NATIVE_TYPE_HINT);
+		self::assertSniffError($report, 368, ReturnTypeHintSniff::CODE_MISSING_NATIVE_TYPE_HINT);
 
 		self::assertAllFixedInFile($report);
 	}

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

@@ -332,11 +332,26 @@ public function returnsNonEmptyArray(): array
 	{
 	}
 
+	/** @return list<int> */
+	public function returnsList(): array
+	{
+	}
+
+	/** @return non-empty-list<int> */
+	public function returnsNonEmptyList(): array
+	{
+	}
+
 	/** @return non-empty-string */
 	public function returnsNonEmptyString(): string
 	{
 	}
 
+	/** @return non-falsy-string */
+	public function returnsNonFalseString(): string
+	{
+	}
+
 	/** @return literal-string */
 	public function returnsLiteralString(): string
 	{

tests/Sniffs/TypeHints/data/returnTypeHintErrors.php

@@ -344,11 +344,26 @@ public function returnsNonEmptyArray()
 	{
 	}
 
+	/** @return list<int> */
+	public function returnsList()
+	{
+	}
+
+	/** @return non-empty-list<int> */
+	public function returnsNonEmptyList()
+	{
+	}
+
 	/** @return non-empty-string */
 	public function returnsNonEmptyString()
 	{
 	}
 
+	/** @return non-falsy-string */
+	public function returnsNonFalseString()
+	{
+	}
+
 	/** @return literal-string */
 	public function returnsLiteralString()
 	{