Skip to content

Convert array type to generic in non-unions #338

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
othercorey merged 1 commit into from
Jul 14, 2021
Merged

Convert array type to generic in non-unions #338

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions CakePHP/Sniffs/Commenting/TypeHintSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,20 +90,28 @@ public function process(File $phpcsFile, $stackPtr)

$tagComment = $phpcsFile->fixer->getTokenContent($tag + 2);
$valueNode = self::getValueNode($tokens[$tag]['content'], $tagComment);
if ($valueNode instanceof InvalidTagValueNode || !$valueNode->type instanceof UnionTypeNode) {
if ($valueNode instanceof InvalidTagValueNode) {
continue;
}

$originalTypeHint = $this->renderUnionTypes($valueNode->type->types);
$sortedTypeHint = $this->getSortedTypeHint($valueNode->type->types);
if ($valueNode->type instanceof UnionTypeNode) {
$types = $valueNode->type->types;
} elseif ($valueNode->type instanceof ArrayTypeNode) {
$types = [$valueNode->type];
} else {
continue;
}

$originalTypeHint = $this->renderUnionTypes($types);
$sortedTypeHint = $this->getSortedTypeHint($types);
if ($sortedTypeHint === $originalTypeHint) {
continue;
}

$fix = $phpcsFile->addFixableWarning(
'%s type hint is not formatted properly, expected "%s"',
$tag,
'Format',
'IncorrectFormat',
[$tokens[$tag]['content'], $sortedTypeHint]
);
if (!$fix) {
Expand Down
4 changes: 2 additions & 2 deletions CakePHP/Tests/Commenting/TypeHintUnitTest.1.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ namespace Beakman;

class Foo
{
/** @var int|string[]|int[] */
/** @var string[] */
protected $testVar;

/** @var null|string|class-string<\Cake\I18n\Number>|array $testVar2 */
/** @var null|string[]|class-string<\Cake\I18n\Number> $testVar2 */
protected $testVar2;

/**
Expand Down
4 changes: 2 additions & 2 deletions CakePHP/Tests/Commenting/TypeHintUnitTest.1.inc.fixed
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ namespace Beakman;

class Foo
{
/** @var array<string>|array<int>|int */
/** @var array<string> */
protected $testVar;

/** @var array|class-string<\Cake\I18n\Number>|string|null $testVar2 */
/** @var array<string>|class-string<\Cake\I18n\Number>|null $testVar2 */
protected $testVar2;

/**
Expand Down