public function EndFileNewlineSniff::process in Coder 8.3.x

Same name and namespace in other branches

1. 8.3 coder_sniffer/Drupal/Sniffs/Files/EndFileNewlineSniff.php \Drupal\Sniffs\Files\EndFileNewlineSniff::process()
2. 8.2 coder_sniffer/Drupal/Sniffs/Files/EndFileNewlineSniff.php \Drupal\Sniffs\Files\EndFileNewlineSniff::process()

Processes this sniff, when one of its tokens is encountered.

Parameters

\PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.:

int $stackPtr The position of the current token in: the stack passed in $tokens.

Return value

int|void

File

coder_sniffer/Drupal/Sniffs/Files/EndFileNewlineSniff.php, line 65

Class

EndFileNewlineSniff

Ensures the file ends with a newline character.

Namespace

Drupal\Sniffs\Files

Code

public function process(File $phpcsFile, $stackPtr) {

  // Skip to the end of the file.
  $tokens = $phpcsFile
    ->getTokens();
  if ($phpcsFile->tokenizerType === 'PHP') {
    $lastToken = $phpcsFile->numTokens - 1;
  }
  else {

    // JS and CSS have an artificial token at the end which we have to
    // ignore.
    $lastToken = $phpcsFile->numTokens - 2;
  }

  // Hard-coding the expected \n in this sniff as it is PSR-2 specific and
  // PSR-2 enforces the use of unix style newlines.
  if (substr($tokens[$lastToken]['content'], -1) !== "\n") {
    $error = 'Expected 1 newline at end of file; 0 found';
    $fix = $phpcsFile
      ->addFixableError($error, $lastToken, 'NoneFound');
    if ($fix === true) {
      $phpcsFile->fixer
        ->addNewline($lastToken);
    }
    $phpcsFile
      ->recordMetric($stackPtr, 'Number of newlines at EOF', '0');
    return $phpcsFile->numTokens + 1;
  }

  // Go looking for the last non-empty line.
  $lastLine = $tokens[$lastToken]['line'];
  if ($tokens[$lastToken]['code'] === T_WHITESPACE) {
    $lastCode = $phpcsFile
      ->findPrevious(T_WHITESPACE, $lastToken - 1, null, true);
  }
  else {
    if ($tokens[$lastToken]['code'] === T_INLINE_HTML) {
      $lastCode = $lastToken;
      while ($lastCode > 0 && trim($tokens[$lastCode]['content']) === '') {
        $lastCode--;
      }
    }
    else {
      $lastCode = $lastToken;
    }
  }
  $lastCodeLine = $tokens[$lastCode]['line'];
  $blankLines = (string) ($lastLine - $lastCodeLine + 1);
  $phpcsFile
    ->recordMetric($stackPtr, 'Number of newlines at EOF', $blankLines);
  if ($blankLines > 1) {
    $error = 'Expected 1 newline at end of file; %s found';
    $data = [
      $blankLines,
    ];
    $fix = $phpcsFile
      ->addFixableError($error, $lastCode, 'TooMany', $data);
    if ($fix === true) {
      $phpcsFile->fixer
        ->beginChangeset();
      $phpcsFile->fixer
        ->replaceToken($lastCode, rtrim($tokens[$lastCode]['content']));
      for ($i = $lastCode + 1; $i < $lastToken; $i++) {
        $phpcsFile->fixer
          ->replaceToken($i, '');
      }
      $phpcsFile->fixer
        ->replaceToken($lastToken, $phpcsFile->eolChar);
      $phpcsFile->fixer
        ->endChangeset();
    }
  }

  // Skip the rest of the file.
  return $phpcsFile->numTokens + 1;
}