Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
SlevomatCodingStandard.TypeHints.DNFTypeHintFormat: New sniff
- Loading branch information
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,357 @@ | ||
| <?php declare(strict_types = 1); | ||
|
|
||
| namespace SlevomatCodingStandard\Sniffs\TypeHints; | ||
|
|
||
| use PHP_CodeSniffer\Files\File; | ||
| use PHP_CodeSniffer\Sniffs\Sniff; | ||
| use SlevomatCodingStandard\Helpers\FixerHelper; | ||
| use SlevomatCodingStandard\Helpers\FunctionHelper; | ||
| use SlevomatCodingStandard\Helpers\PropertyHelper; | ||
| use SlevomatCodingStandard\Helpers\SniffSettingsHelper; | ||
| use SlevomatCodingStandard\Helpers\TokenHelper; | ||
| use SlevomatCodingStandard\Helpers\TypeHint; | ||
| use function array_merge; | ||
| use function in_array; | ||
| use function preg_replace; | ||
| use function sprintf; | ||
| use function strpos; | ||
| use function strtolower; | ||
| use function substr; | ||
| use function substr_count; | ||
| use function trim; | ||
| use const T_TYPE_CLOSE_PARENTHESIS; | ||
| use const T_TYPE_INTERSECTION; | ||
| use const T_TYPE_OPEN_PARENTHESIS; | ||
| use const T_TYPE_UNION; | ||
| use const T_VARIABLE; | ||
| use const T_WHITESPACE; | ||
|
|
||
| class DNFTypeHintFormatSniff implements Sniff | ||
| { | ||
|
|
||
| public const CODE_DISALLOWED_PARENTHESES_AROUND_TYPE_HINT = 'DisallowedParenthesesAroundTypeHint'; | ||
| public const CODE_DISALLOWED_WHITESPACE_AROUND_OPERATOR = 'DisallowedWhitespaceAroundOperator'; | ||
| public const CODE_REQUIRED_WHITESPACE_AROUND_OPERATOR = 'RequiredWhitespaceAroundOperator'; | ||
| public const CODE_DISALLOWED_WHITESPACE_INSIDE_PARENTHESES = 'DisallowedWhitespaceInsideParentheses'; | ||
| public const CODE_REQUIRED_WHITESPACE_INSIDE_PARENTHESES = 'RequiredWhitespaceInsideParentheses'; | ||
| public const CODE_REQUIRED_SHORT_NULLABLE = 'RequiredShortNullable'; | ||
| public const CODE_DISALLOWED_SHORT_NULLABLE = 'DisallowedShortNullable'; | ||
| public const CODE_NULL_TYPE_HINT_NOT_ON_FIRST_POSITION = 'NullTypeHintNotOnFirstPosition'; | ||
| public const CODE_NULL_TYPE_HINT_NOT_ON_LAST_POSITION = 'NullTypeHintNotOnLastPosition'; | ||
|
|
||
| private const YES = 'yes'; | ||
| private const NO = 'no'; | ||
|
|
||
| private const FIRST = 'first'; | ||
| private const LAST = 'last'; | ||
|
|
||
| public ?bool $enable = null; | ||
|
|
||
| public ?string $paranthesesAroundTypeHint = null; | ||
|
|
||
| public ?string $withSpacesAroundOperators = null; | ||
|
|
||
| public ?string $withSpacesInsideParentheses = null; | ||
|
|
||
| public ?string $shortNullable = null; | ||
|
|
||
| public ?string $nullPosition = null; | ||
|
|
||
| /** | ||
| * @return array<int, (int|string)> | ||
| */ | ||
| public function register(): array | ||
| { | ||
| return array_merge( | ||
| [T_VARIABLE], | ||
| TokenHelper::$functionTokenCodes, | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint | ||
| * @param int $pointer | ||
| */ | ||
| public function process(File $phpcsFile, $pointer): void | ||
| { | ||
| $this->enable = SniffSettingsHelper::isEnabledByPhpVersion($this->enable, 80000); | ||
|
|
||
| if (!$this->enable) { | ||
| return; | ||
| } | ||
|
|
||
| $tokens = $phpcsFile->getTokens(); | ||
|
|
||
| if ($tokens[$pointer]['code'] === T_VARIABLE) { | ||
| if (!PropertyHelper::isProperty($phpcsFile, $pointer)) { | ||
| return; | ||
| } | ||
|
|
||
| $propertyTypeHint = PropertyHelper::findTypeHint($phpcsFile, $pointer); | ||
| if ($propertyTypeHint !== null) { | ||
| $this->checkTypeHint($phpcsFile, $propertyTypeHint); | ||
| } | ||
|
|
||
| return; | ||
| } | ||
|
|
||
| $returnTypeHint = FunctionHelper::findReturnTypeHint($phpcsFile, $pointer); | ||
| if ($returnTypeHint !== null) { | ||
| $this->checkTypeHint($phpcsFile, $returnTypeHint); | ||
| } | ||
|
|
||
| foreach (FunctionHelper::getParametersTypeHints($phpcsFile, $pointer) as $parameterTypeHint) { | ||
| if ($parameterTypeHint !== null) { | ||
| $this->checkTypeHint($phpcsFile, $parameterTypeHint); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private function checkTypeHint(File $phpcsFile, TypeHint $typeHint): void | ||
| { | ||
| $tokens = $phpcsFile->getTokens(); | ||
|
|
||
| $typeHintsCount = substr_count($typeHint->getTypeHint(), '|') + substr_count($typeHint->getTypeHint(), '&') + 1; | ||
|
|
||
| if ($typeHintsCount > 1) { | ||
| if ( | ||
| $this->paranthesesAroundTypeHint === self::NO | ||
| && $tokens[$typeHint->getStartPointer()]['code'] === T_TYPE_OPEN_PARENTHESIS | ||
| ) { | ||
| $originalTypeHint = TokenHelper::getContent($phpcsFile, $typeHint->getStartPointer(), $typeHint->getEndPointer()); | ||
| $fix = $phpcsFile->addFixableError( | ||
| sprintf('Parentheses around type hint "%s" are disallowed.', $originalTypeHint), | ||
| $typeHint->getStartPointer(), | ||
| self::CODE_DISALLOWED_PARENTHESES_AROUND_TYPE_HINT, | ||
| ); | ||
| if ($fix) { | ||
| $fixedTypeHint = trim( | ||
| TokenHelper::getContent($phpcsFile, $typeHint->getStartPointer() + 1, $typeHint->getEndPointer() - 1), | ||
| ); | ||
| $this->fixTypeHint($phpcsFile, $typeHint, $fixedTypeHint); | ||
| } | ||
| } | ||
|
|
||
| if ($this->withSpacesAroundOperators === self::NO) { | ||
| $error = false; | ||
| foreach (TokenHelper::findNextAll( | ||
| $phpcsFile, | ||
| T_WHITESPACE, | ||
| $typeHint->getStartPointer(), | ||
| $typeHint->getEndPointer(), | ||
| ) as $whitespacePointer) { | ||
| if (in_array($tokens[$whitespacePointer - 1]['code'], [T_TYPE_UNION, T_TYPE_INTERSECTION], true)) { | ||
| $error = true; | ||
| break; | ||
| } | ||
| if (in_array($tokens[$whitespacePointer + 1]['code'], [T_TYPE_UNION, T_TYPE_INTERSECTION], true)) { | ||
| $error = true; | ||
| break; | ||
| } | ||
| } | ||
|
|
||
| if ($error) { | ||
| $originalTypeHint = TokenHelper::getContent($phpcsFile, $typeHint->getStartPointer(), $typeHint->getEndPointer()); | ||
| $fix = $phpcsFile->addFixableError( | ||
| sprintf('Spaces around "|" or "&" in type hint "%s" are disallowed.', $originalTypeHint), | ||
| $typeHint->getStartPointer(), | ||
| self::CODE_DISALLOWED_WHITESPACE_AROUND_OPERATOR, | ||
| ); | ||
| if ($fix) { | ||
| $fixedTypeHint = preg_replace('~\s*([|&])\s*~', '\1', $originalTypeHint); | ||
| $this->fixTypeHint($phpcsFile, $typeHint, $fixedTypeHint); | ||
| } | ||
| } | ||
| } elseif ($this->withSpacesAroundOperators === self::YES) { | ||
| $error = false; | ||
| foreach (TokenHelper::findNextAll( | ||
| $phpcsFile, | ||
| [T_TYPE_UNION, T_TYPE_INTERSECTION], | ||
| $typeHint->getStartPointer(), | ||
| $typeHint->getEndPointer(), | ||
| ) as $operatorPointer) { | ||
| if ($tokens[$operatorPointer - 1]['content'] !== ' ') { | ||
| $error = true; | ||
| break; | ||
| } | ||
| if ($tokens[$operatorPointer + 1]['content'] !== ' ') { | ||
| $error = true; | ||
| break; | ||
| } | ||
| } | ||
|
|
||
| if ($error) { | ||
| $originalTypeHint = TokenHelper::getContent($phpcsFile, $typeHint->getStartPointer(), $typeHint->getEndPointer()); | ||
| $fix = $phpcsFile->addFixableError( | ||
| sprintf('One space required around each "|" or "&" in type hint "%s".', $originalTypeHint), | ||
| $typeHint->getStartPointer(), | ||
| self::CODE_REQUIRED_WHITESPACE_AROUND_OPERATOR, | ||
| ); | ||
| if ($fix) { | ||
| $fixedTypeHint = preg_replace('~\s*([|&])\s*~', ' \1 ', $typeHint->getTypeHint()); | ||
| $this->fixTypeHint($phpcsFile, $typeHint, $fixedTypeHint); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| if ($this->withSpacesInsideParentheses === self::NO) { | ||
| $error = false; | ||
| foreach (TokenHelper::findNextAll( | ||
| $phpcsFile, | ||
| T_WHITESPACE, | ||
| $typeHint->getStartPointer(), | ||
| $typeHint->getEndPointer(), | ||
| ) as $whitespacePointer) { | ||
| if ($tokens[$whitespacePointer - 1]['code'] === T_TYPE_OPEN_PARENTHESIS) { | ||
| $error = true; | ||
| break; | ||
| } | ||
| if ($tokens[$whitespacePointer + 1]['code'] === T_TYPE_CLOSE_PARENTHESIS) { | ||
| $error = true; | ||
| break; | ||
| } | ||
| } | ||
|
|
||
| if ($error) { | ||
| $originalTypeHint = TokenHelper::getContent($phpcsFile, $typeHint->getStartPointer(), $typeHint->getEndPointer()); | ||
| $fix = $phpcsFile->addFixableError( | ||
| sprintf('Spaces inside parentheses in type hint "%s" are disallowed.', $originalTypeHint), | ||
| $typeHint->getStartPointer(), | ||
| self::CODE_DISALLOWED_WHITESPACE_INSIDE_PARENTHESES, | ||
| ); | ||
| if ($fix) { | ||
| $fixedTypeHint = preg_replace('~\s+\)~', ')', preg_replace('~\(\s+~', '(', $originalTypeHint)); | ||
| $this->fixTypeHint($phpcsFile, $typeHint, $fixedTypeHint); | ||
| } | ||
| } | ||
| } elseif ($this->withSpacesInsideParentheses === self::YES) { | ||
| $error = false; | ||
| foreach (TokenHelper::findNextAll( | ||
| $phpcsFile, | ||
| [T_TYPE_OPEN_PARENTHESIS, T_TYPE_CLOSE_PARENTHESIS], | ||
| $typeHint->getStartPointer(), | ||
| $typeHint->getEndPointer() + 1, | ||
| ) as $paranthesisPointer) { | ||
| if ( | ||
| $tokens[$paranthesisPointer]['code'] === T_TYPE_OPEN_PARENTHESIS | ||
| && $tokens[$paranthesisPointer + 1]['content'] !== ' ' | ||
| ) { | ||
| $error = true; | ||
| break; | ||
| } | ||
| if ( | ||
| $tokens[$paranthesisPointer]['code'] === T_TYPE_CLOSE_PARENTHESIS | ||
| && $tokens[$paranthesisPointer - 1]['content'] !== ' ' | ||
| ) { | ||
| $error = true; | ||
| break; | ||
| } | ||
| } | ||
|
|
||
| if ($error) { | ||
| $originalTypeHint = TokenHelper::getContent($phpcsFile, $typeHint->getStartPointer(), $typeHint->getEndPointer()); | ||
| $fix = $phpcsFile->addFixableError( | ||
| sprintf('One space required around expression inside parentheses in type hint "%s".', $originalTypeHint), | ||
| $typeHint->getStartPointer(), | ||
| self::CODE_REQUIRED_WHITESPACE_INSIDE_PARENTHESES, | ||
| ); | ||
| if ($fix) { | ||
| $fixedTypeHint = preg_replace('~\s*\)~', ' )', preg_replace('~\(\s*~', '( ', $originalTypeHint)); | ||
| $this->fixTypeHint($phpcsFile, $typeHint, $fixedTypeHint); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| if (substr_count($typeHint->getTypeHint(), '&') > 0) { | ||
| return; | ||
| } | ||
|
|
||
| if (!$typeHint->isNullable()) { | ||
| return; | ||
| } | ||
|
|
||
| $hasShortNullable = strpos($typeHint->getTypeHint(), '?') === 0; | ||
|
|
||
| if ($this->shortNullable === self::YES && $typeHintsCount === 2 && !$hasShortNullable) { | ||
| $fix = $phpcsFile->addFixableError( | ||
| sprintf('Short nullable type hint in "%s" is required.', $typeHint->getTypeHint()), | ||
| $typeHint->getStartPointer(), | ||
| self::CODE_REQUIRED_SHORT_NULLABLE, | ||
| ); | ||
| if ($fix) { | ||
| $typeHintWithoutNull = self::getTypeHintContentWithoutNull($phpcsFile, $typeHint); | ||
| $this->fixTypeHint($phpcsFile, $typeHint, '?' . $typeHintWithoutNull); | ||
| } | ||
| } elseif ($this->shortNullable === self::NO && $hasShortNullable) { | ||
| $fix = $phpcsFile->addFixableError( | ||
| sprintf('Usage of short nullable type hint in "%s" is disallowed.', $typeHint->getTypeHint()), | ||
| $typeHint->getStartPointer(), | ||
| self::CODE_DISALLOWED_SHORT_NULLABLE, | ||
| ); | ||
| if ($fix) { | ||
| $this->fixTypeHint($phpcsFile, $typeHint, substr($typeHint->getTypeHint(), 1) . '|null'); | ||
| } | ||
| } | ||
|
|
||
| if ($hasShortNullable || ($this->shortNullable === self::YES && $typeHintsCount === 2)) { | ||
| return; | ||
| } | ||
|
|
||
| if ($this->nullPosition === self::FIRST && strtolower($tokens[$typeHint->getStartPointer()]['content']) !== 'null') { | ||
| $fix = $phpcsFile->addFixableError( | ||
| sprintf('Null type hint should be on first position in "%s".', $typeHint->getTypeHint()), | ||
| $typeHint->getStartPointer(), | ||
| self::CODE_NULL_TYPE_HINT_NOT_ON_FIRST_POSITION, | ||
| ); | ||
| if ($fix) { | ||
| $this->fixTypeHint($phpcsFile, $typeHint, 'null|' . self::getTypeHintContentWithoutNull($phpcsFile, $typeHint)); | ||
| } | ||
| } elseif ($this->nullPosition === self::LAST && strtolower($tokens[$typeHint->getEndPointer()]['content']) !== 'null') { | ||
| $fix = $phpcsFile->addFixableError( | ||
| sprintf('Null type hint should be on last position in "%s".', $typeHint->getTypeHint()), | ||
| $typeHint->getStartPointer(), | ||
| self::CODE_NULL_TYPE_HINT_NOT_ON_LAST_POSITION, | ||
| ); | ||
| if ($fix) { | ||
| $this->fixTypeHint($phpcsFile, $typeHint, self::getTypeHintContentWithoutNull($phpcsFile, $typeHint) . '|null'); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private function getTypeHintContentWithoutNull(File $phpcsFile, TypeHint $typeHint): string | ||
| { | ||
| $tokens = $phpcsFile->getTokens(); | ||
|
|
||
| if (strtolower($tokens[$typeHint->getEndPointer()]['content']) === 'null') { | ||
| $previousTypeHintPointer = TokenHelper::findPrevious( | ||
| $phpcsFile, | ||
| TokenHelper::getOnlyTypeHintTokenCodes(), | ||
| $typeHint->getEndPointer() - 1, | ||
| ); | ||
| return TokenHelper::getContent($phpcsFile, $typeHint->getStartPointer(), $previousTypeHintPointer); | ||
| } | ||
|
|
||
| $content = ''; | ||
|
|
||
| for ($i = $typeHint->getStartPointer(); $i <= $typeHint->getEndPointer(); $i++) { | ||
| if (strtolower($tokens[$i]['content']) === 'null') { | ||
| $i = TokenHelper::findNext($phpcsFile, TokenHelper::getOnlyTypeHintTokenCodes(), $i + 1); | ||
| } | ||
|
|
||
| $content .= $tokens[$i]['content']; | ||
| } | ||
|
|
||
| return $content; | ||
| } | ||
|
|
||
| private function fixTypeHint(File $phpcsFile, TypeHint $typeHint, string $fixedTypeHint): void | ||
| { | ||
| $phpcsFile->fixer->beginChangeset(); | ||
|
|
||
| FixerHelper::change($phpcsFile, $typeHint->getStartPointer(), $typeHint->getEndPointer(), $fixedTypeHint); | ||
|
|
||
| $phpcsFile->fixer->endChangeset(); | ||
| } | ||
|
|
||
| } | ||
Oops, something went wrong.