ShortListSniff.php

<?php

declare (strict_types=1);
namespace SlevomatCodingStandard\Sniffs\PHP;

use PHP_CodeSniffer\Files\File;
use PHP_CodeSniffer\Sniffs\Sniff;
use SlevomatCodingStandard\Helpers\FixerHelper;
use SlevomatCodingStandard\Helpers\TokenHelper;
use const T_LIST;
use const T_OPEN_PARENTHESIS;
class ShortListSniff implements Sniff {
    public const CODE_LONG_LIST_USED = 'LongListUsed';
    
    /**
     * @return array<int, (int|string)>
     */
    public function register() : array {
        return [
            T_LIST,
        ];
    }
    
    /**
     * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint
     * @param int $pointer
     */
    public function process(File $phpcsFile, $pointer) : void {
        $fix = $phpcsFile->addFixableError('list(...) is forbidden, use [...] instead.', $pointer, self::CODE_LONG_LIST_USED);
        if (!$fix) {
            return;
        }
        $tokens = $phpcsFile->getTokens();
        
        /** @var int $startPointer */
        $startPointer = TokenHelper::findNext($phpcsFile, [
            T_OPEN_PARENTHESIS,
        ], $pointer + 1);
        $endPointer = $tokens[$startPointer]['parenthesis_closer'];
        $phpcsFile->fixer
            ->beginChangeset();
        FixerHelper::removeBetweenIncluding($phpcsFile, $pointer, $startPointer - 1);
        $phpcsFile->fixer
            ->replaceToken($startPointer, '[');
        $phpcsFile->fixer
            ->replaceToken($endPointer, ']');
        $phpcsFile->fixer
            ->endChangeset();
    }

}