* Dariusz Rumiński * * This source file is subject to the MIT license that is bundled * with this source code in the file LICENSE. */ namespace PhpCsFixer\Fixer\NamespaceNotation; use PhpCsFixer\AbstractFixer; use PhpCsFixer\Fixer\WhitespacesAwareFixerInterface; use PhpCsFixer\FixerDefinition\CodeSample; use PhpCsFixer\FixerDefinition\FixerDefinition; use PhpCsFixer\FixerDefinition\FixerDefinitionInterface; use PhpCsFixer\Preg; use PhpCsFixer\Tokenizer\Token; use PhpCsFixer\Tokenizer\Tokens; /** * Fixer for rules defined in PSR2 ¶3. * * @author Dariusz Rumiński */ final class BlankLineAfterNamespaceFixer extends AbstractFixer implements WhitespacesAwareFixerInterface { public function getDefinition(): FixerDefinitionInterface { return new FixerDefinition( 'There MUST be one blank line after the namespace declaration.', [ new CodeSample("isTokenKindFound(T_NAMESPACE); } protected function applyFix(\SplFileInfo $file, Tokens $tokens): void { $lastIndex = $tokens->count() - 1; for ($index = $lastIndex; $index >= 0; --$index) { $token = $tokens[$index]; if (!$token->isGivenKind(T_NAMESPACE)) { continue; } $semicolonIndex = $tokens->getNextTokenOfKind($index, [';', '{', [T_CLOSE_TAG]]); $semicolonToken = $tokens[$semicolonIndex]; if (!$semicolonToken->equals(';')) { continue; } $indexToEnsureBlankLineAfter = $this->getIndexToEnsureBlankLineAfter($tokens, $semicolonIndex); $indexToEnsureBlankLine = $tokens->getNonEmptySibling($indexToEnsureBlankLineAfter, 1); if (null !== $indexToEnsureBlankLine && $tokens[$indexToEnsureBlankLine]->isWhitespace()) { $tokens[$indexToEnsureBlankLine] = $this->getTokenToInsert($tokens[$indexToEnsureBlankLine]->getContent(), $indexToEnsureBlankLine === $lastIndex); } else { $tokens->insertAt($indexToEnsureBlankLineAfter + 1, $this->getTokenToInsert('', $indexToEnsureBlankLineAfter === $lastIndex)); } } } private function getIndexToEnsureBlankLineAfter(Tokens $tokens, int $index): int { $indexToEnsureBlankLine = $index; $nextIndex = $tokens->getNonEmptySibling($indexToEnsureBlankLine, 1); while (null !== $nextIndex) { $token = $tokens[$nextIndex]; if ($token->isWhitespace()) { if (Preg::match('/\R/', $token->getContent())) { break; } $nextNextIndex = $tokens->getNonEmptySibling($nextIndex, 1); if (!$tokens[$nextNextIndex]->isComment()) { break; } } if (!$token->isWhitespace() && !$token->isComment()) { break; } $indexToEnsureBlankLine = $nextIndex; $nextIndex = $tokens->getNonEmptySibling($indexToEnsureBlankLine, 1); } return $indexToEnsureBlankLine; } private function getTokenToInsert(string $currentContent, bool $isLastIndex): Token { $ending = $this->whitespacesConfig->getLineEnding(); $emptyLines = $isLastIndex ? $ending : $ending.$ending; $indent = Preg::match('/^.*\R( *)$/s', $currentContent, $matches) ? $matches[1] : ''; return new Token([T_WHITESPACE, $emptyLines.$indent]); } }