|
| 1 | +<?php |
| 2 | + |
| 3 | +namespace PSR2R\Sniffs\PHP; |
| 4 | + |
| 5 | +use PHP_CodeSniffer\Files\File; |
| 6 | +use PHP_CodeSniffer\Util\Tokens; |
| 7 | +use PSR2R\Tools\AbstractSniff; |
| 8 | + |
| 9 | +/** |
| 10 | + * Adds trailing commas in multiline arrays. |
| 11 | + * |
| 12 | + * Heredoc patch taken from slevomat/coding-standard project. |
| 13 | + * |
| 14 | + * @author Mark Scherer |
| 15 | + * @license MIT |
| 16 | + */ |
| 17 | +class CommaAfterArrayItemSniff extends AbstractSniff { |
| 18 | + |
| 19 | + /** |
| 20 | + * @var bool |
| 21 | + */ |
| 22 | + public $enableAfterHeredoc = PHP_VERSION_ID >= 70300; |
| 23 | + |
| 24 | + /** |
| 25 | + * @inheritDoc |
| 26 | + */ |
| 27 | + public function register() { |
| 28 | + return [ |
| 29 | + T_OPEN_SHORT_ARRAY, |
| 30 | + ]; |
| 31 | + } |
| 32 | + |
| 33 | + /** |
| 34 | + * @inheritDoc |
| 35 | + */ |
| 36 | + public function process(File $phpcsFile, $stackPtr) { |
| 37 | + $tokens = $phpcsFile->getTokens(); |
| 38 | + $arrayToken = $tokens[$stackPtr]; |
| 39 | + $closeParenthesisPointer = $arrayToken['bracket_closer']; |
| 40 | + $openParenthesisToken = $tokens[$arrayToken['bracket_opener']]; |
| 41 | + $closeParenthesisToken = $tokens[$closeParenthesisPointer]; |
| 42 | + if ($openParenthesisToken['line'] === $closeParenthesisToken['line']) { |
| 43 | + return; |
| 44 | + } |
| 45 | + |
| 46 | + $previousToCloseParenthesisPointer = $phpcsFile->findPrevious(Tokens::$emptyTokens, $closeParenthesisPointer - 1, 0, true); |
| 47 | + $previousToCloseParenthesisToken = $tokens[$previousToCloseParenthesisPointer]; |
| 48 | + if ( |
| 49 | + $previousToCloseParenthesisPointer === $arrayToken['bracket_opener'] |
| 50 | + || $previousToCloseParenthesisToken['code'] === T_COMMA |
| 51 | + || $closeParenthesisToken['line'] === $previousToCloseParenthesisToken['line'] |
| 52 | + ) { |
| 53 | + return; |
| 54 | + } |
| 55 | + if (!$this->enableAfterHeredoc && in_array($previousToCloseParenthesisToken['code'], [T_END_HEREDOC, T_END_NOWDOC], true)) { |
| 56 | + return; |
| 57 | + } |
| 58 | + $fix = $phpcsFile->addFixableError( |
| 59 | + 'Multi-line arrays must have a trailing comma after the last element.', |
| 60 | + $previousToCloseParenthesisPointer, |
| 61 | + 'MissingTrailingComma' |
| 62 | + ); |
| 63 | + if (!$fix) { |
| 64 | + return; |
| 65 | + } |
| 66 | + |
| 67 | + $phpcsFile->fixer->beginChangeset(); |
| 68 | + $phpcsFile->fixer->addContent($previousToCloseParenthesisPointer, ','); |
| 69 | + $phpcsFile->fixer->endChangeset(); |
| 70 | + } |
| 71 | + |
| 72 | +} |
0 commit comments