Add DeclareAfterOpeningTagFixer (#656)

Author: kubawerlos

.php-cs-fixer.php

@@ -33,6 +33,7 @@
 unset($rules['modernize_strpos']); // TODO: remove when dropping support to PHP <8.0
 unset($rules['use_arrow_functions']); // TODO: remove when dropping support to PHP <7.4
 unset($rules[PhpCsFixerCustomFixers\Fixer\PromotedConstructorPropertyFixer::name()]); // TODO: remove when dropping support to PHP <8.0
+unset($rules[PhpCsFixerCustomFixers\Fixer\DeclareAfterOpeningTagFixer::name()]); // Only to have PR with this fixer smaller
 
 foreach (new PhpCsFixerCustomFixersDev\Fixers() as $fixer) {
     $rules[$fixer->getName()] = true;

CHANGELOG.md

@@ -1,5 +1,8 @@
 # CHANGELOG for PHP CS Fixer: custom fixers
 
+## v3.4.0
+- Add DeclareAfterOpeningTagFixer
+
 ## v3.3.0
 - Add ConstructorEmptyBracesFixer
 - PhpdocNoIncorrectVarAnnotationFixer - remove more incorrect annotations

README.md

@@ -3,7 +3,7 @@
 [![Latest stable version](https://img.shields.io/packagist/v/kubawerlos/php-cs-fixer-custom-fixers.svg?label=current%20version)](https://packagist.org/packages/kubawerlos/php-cs-fixer-custom-fixers)
 [![PHP version](https://img.shields.io/packagist/php-v/kubawerlos/php-cs-fixer-custom-fixers.svg)](https://php.net)
 [![License](https://img.shields.io/github/license/kubawerlos/php-cs-fixer-custom-fixers.svg)](LICENSE)
-![Tests](https://img.shields.io/badge/tests-3029-brightgreen.svg)
+![Tests](https://img.shields.io/badge/tests-3058-brightgreen.svg)
 [![Downloads](https://img.shields.io/packagist/dt/kubawerlos/php-cs-fixer-custom-fixers.svg)](https://packagist.org/packages/kubawerlos/php-cs-fixer-custom-fixers)
 
 [![CI Status](https://github.com/kubawerlos/php-cs-fixer-custom-fixers/workflows/CI/badge.svg?branch=main&event=push)](https://github.com/kubawerlos/php-cs-fixer-custom-fixers/actions)
@@ -117,6 +117,16 @@ Data providers must be static.
  }
 ```
 
+#### DeclareAfterOpeningTagFixer
+Declare statement must be placed in the same line, after opening tag.
+```diff
+-<?php
++<?php declare(strict_types=1);
+ $foo;
+-declare(strict_types=1);
+ $bar;
+```
+
 #### InternalClassCasingFixer
 Classes defined internally by extension or core must be referenced with the correct case.
 ```diff

src/Fixer/DeclareAfterOpeningTagFixer.php

@@ -0,0 +1,97 @@
+<?php
+
+/*
+ * This file is part of PHP CS Fixer: custom fixers.
+ *
+ * (c) 2018 Kuba Werłos
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace PhpCsFixerCustomFixers\Fixer;
+
+use PhpCsFixer\FixerDefinition\CodeSample;
+use PhpCsFixer\FixerDefinition\FixerDefinition;
+use PhpCsFixer\FixerDefinition\FixerDefinitionInterface;
+use PhpCsFixer\Preg;
+use PhpCsFixer\Tokenizer\Token;
+use PhpCsFixer\Tokenizer\Tokens;
+use PhpCsFixerCustomFixers\TokenRemover;
+
+final class DeclareAfterOpeningTagFixer extends AbstractFixer
+{
+    public function getDefinition(): FixerDefinitionInterface
+    {
+        return new FixerDefinition(
+            'Declare statement must be placed in the same line, after opening tag.',
+            [new CodeSample("<?php\n\$foo;\ndeclare(strict_types=1);\n\$bar;\n")]
+        );
+    }
+
+    /**
+     * Must run after BlankLineAfterOpeningTagFixer, HeaderCommentFixer.
+     */
+    public function getPriority(): int
+    {
+        return -31;
+    }
+
+    public function isCandidate(Tokens $tokens): bool
+    {
+        return $tokens->isTokenKindFound(\T_DECLARE);
+    }
+
+    public function isRisky(): bool
+    {
+        return false;
+    }
+
+    public function fix(\SplFileInfo $file, Tokens $tokens): void
+    {
+        if (!$tokens[0]->isGivenKind(\T_OPEN_TAG)) {
+            return;
+        }
+
+        $openingTagTokenContent = $tokens[0]->getContent();
+        if ($openingTagTokenContent === '<?php ' && $tokens[1]->isGivenKind(\T_DECLARE)) {
+            return;
+        }
+
+        $tokens[0] = new Token([\T_OPEN_TAG, \substr($openingTagTokenContent, 0, 5) . ' ']);
+        if ($tokens[1]->isGivenKind(\T_WHITESPACE)) {
+            $tokens[1] = new Token([\T_WHITESPACE, \substr($openingTagTokenContent, 5) . $tokens[1]->getContent()]);
+        } else {
+            $tokens->insertAt(1, new Token([\T_WHITESPACE, \substr($openingTagTokenContent, 5)]));
+        }
+
+        /** @var int $declareIndex */
+        $declareIndex = $tokens->getNextTokenOfKind(0, [[\T_DECLARE]]);
+
+        /** @var int $openParenthesisIndex */
+        $openParenthesisIndex = $tokens->getNextMeaningfulToken($declareIndex);
+        $closeParenthesisIndex = $tokens->findBlockEnd(Tokens::BLOCK_TYPE_PARENTHESIS_BRACE, $openParenthesisIndex);
+
+        /** @var int $semicolonIndex */
+        $semicolonIndex = $tokens->getNextMeaningfulToken($closeParenthesisIndex);
+
+        $tokensToInsert = [];
+        for ($index = $declareIndex; $index <= $semicolonIndex; $index++) {
+            $tokensToInsert[] = $tokens[$index];
+        }
+
+        if ($tokens[$semicolonIndex + 1]->isGivenKind(\T_WHITESPACE)) {
+            /** @var string $content */
+            $content = Preg::replace('/^(\R?)(?=\R)/', '', $tokens[$semicolonIndex + 1]->getContent());
+
+            $tokens->ensureWhitespaceAtIndex($semicolonIndex + 1, 0, $content);
+        }
+
+        $tokens->clearRange($declareIndex + 1, $semicolonIndex);
+        TokenRemover::removeWithLinesIfPossible($tokens, $declareIndex);
+
+        $tokens->insertAt(1, $tokensToInsert);
+    }
+}

tests/Fixer/DeclareAfterOpeningTagFixerTest.php

@@ -0,0 +1,76 @@
+<?php
+
+/*
+ * This file is part of PHP CS Fixer: custom fixers.
+ *
+ * (c) 2018 Kuba Werłos
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Tests\Fixer;
+
+/**
+ * @internal
+ *
+ * @covers \PhpCsFixerCustomFixers\Fixer\DeclareAfterOpeningTagFixer
+ */
+final class DeclareAfterOpeningTagFixerTest extends AbstractFixerTestCase
+{
+    public function testIsRisky(): void
+    {
+        self::assertFalse($this->fixer->isRisky());
+    }
+
+    /**
+     * @dataProvider provideFixCases
+     */
+    public function testFix(string $expected, ?string $input = null): void
+    {
+        $this->doTest($expected, $input);
+    }
+
+    /**
+     * @return iterable<array{0: string, 1?: string}>
+     */
+    public static function provideFixCases(): iterable
+    {
+        yield 'skip files not starting with PHP opening tag' => ['<html></html>'];
+
+        yield 'fix inside comments' => [
+            '<?php declare(strict_types=1);
+// Foo
+// Bar
+            ',
+            '<?php
+// Foo
+declare(strict_types=1);
+// Bar
+            ',
+        ];
+
+        yield 'fix and clean up empty lines' => [
+            '<?php declare(strict_types=1);
+
+/*
+ * Header comment
+ */
+
+// code starts here
+            ',
+            '<?php
+
+/*
+ * Header comment
+ */
+
+declare(strict_types=1);
+
+// code starts here
+            ',
+        ];
+    }
+}

tests/priority_fixtures/blank_line_after_opening_tag,Custom_declare_after_opening_tag.test

@@ -0,0 +1,11 @@
+--CONFIGURATION--
+{ "blank_line_after_opening_tag": true, "PhpCsFixerCustomFixers/declare_after_opening_tag": true }
+--EXPECTED--
+<?php declare(strict_types=1);
+
+class Foo {}
+
+--INPUT--
+<?php
+declare(strict_types=1);
+class Foo {}

tests/priority_fixtures/header_comment,Custom_declare_after_opening_tag.test

@@ -0,0 +1,14 @@
+--CONFIGURATION--
+{ "header_comment": { "header": "The header", "location": "after_open" }, "PhpCsFixerCustomFixers/declare_after_opening_tag": true }
+--EXPECTED--
+<?php declare(strict_types=1);
+
+/*
+ * The header
+ */
+
+
+--INPUT--
+<?php
+
+declare(strict_types=1);