MultipleEmptyLinesSniff.php

<?php

/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */

namespace Magento2\Sniffs\Whitespace;

use PHP_CodeSniffer\Files\File;
use PHP_CodeSniffer\Sniffs\Sniff;

/**
 * Detects possible usage of multiple blank lines in a row.
 */
class MultipleEmptyLinesSniff implements Sniff
{
    /**
     * String representation of warning.
     *
     * @var string
     */
    protected $warningMessage = 'Code must not contain multiple empty lines in a row; found %s empty lines.';

    /**
     * Warning violation code.
     *
     * @var string
     */
    protected $warningCode = 'MultipleEmptyLines';

    /**
     * @inheritdoc
     */
    public function register()
    {
        return [T_WHITESPACE];
    }

    /**
     * @inheritdoc
     */
    public function process(File $phpcsFile, $stackPtr)
    {
        $tokens = $phpcsFile->getTokens();
        if ($phpcsFile->hasCondition($stackPtr, T_FUNCTION)
            || $phpcsFile->hasCondition($stackPtr, T_CLASS)
            || $phpcsFile->hasCondition($stackPtr, T_INTERFACE)
        ) {
            if ($tokens[$stackPtr - 1]['line'] < $tokens[$stackPtr]['line']
                && $tokens[$stackPtr - 2]['line'] === $tokens[$stackPtr - 1]['line']
            ) {
                // This is an empty line and the line before this one is not
                // empty, so this could be the start of a multiple empty line block
                $next = $phpcsFile->findNext(T_WHITESPACE, $stackPtr, null, true);
                $lines = $tokens[$next]['line'] - $tokens[$stackPtr]['line'];
                if ($lines > 1) {
                    $fix = $phpcsFile->addFixableWarning(
                        $this->warningMessage,
                        $stackPtr,
                        $this->warningCode,
                        [$lines]
                    );

                    if ($fix) {
                        // $stackPtr + 1 to keep one empty line.
                        // $next - 1 to keep the indentation
                        for ($i = $stackPtr + 1; $i < $next - 1; $i++) {
                            $phpcsFile->fixer->replaceToken($i, '');
                        }

                        // Handle case where the next line isn't indented
                        if ($tokens[$next - 1]['content'] === PHP_EOL) {
                            $phpcsFile->fixer->replaceToken($next - 1, '');
                        }
                    }
                }
            }
        }
    }
}