feat: Add custom DeclareStrictTypesFixer to handle LK copyrights comment

Author: MasterRO94

Dockerfile

@@ -22,14 +22,22 @@ RUN cd ~ \
     && php /tmp/composer-setup.php --install-dir=/usr/local/bin --filename=composer \
     && composer
 
-RUN composer global config --no-plugins allow-plugins.dealerdirect/phpcodesniffer-composer-installer true
-RUN composer global require -W symplify/coding-standard:^12.0 symplify/easy-coding-standard:^12.0 friendsofphp/php-cs-fixer:^3.41 kubawerlos/php-cs-fixer-custom-fixers:^3.17 squizlabs/php_codesniffer:^3.8 slevomat/coding-standard:^8.14
-
 ENV PATH="~/.composer/vendor/bin:${PATH}"
 
 RUN mkdir -p /app
 RUN mkdir -p /codebase
-COPY ecs.php /app
+COPY ./src /app
+
+RUN composer global config --no-plugins allow-plugins.dealerdirect/phpcodesniffer-composer-installer true
+RUN composer global config repositories.justcoded/php-code-analysis-tool path /app
+RUN composer global require -W \
+    justcoded/php-code-analysis-tool:* \
+    symplify/coding-standard:^12.0 \
+    symplify/easy-coding-standard:^12.0 \
+    friendsofphp/php-cs-fixer:^3.41 \
+    kubawerlos/php-cs-fixer-custom-fixers:^3.17 \
+    squizlabs/php_codesniffer:^3.8 \
+    slevomat/coding-standard:^8.14
 
 WORKDIR /codebase
 

bin/code.mk

@@ -1,6 +1,6 @@
 .PHONY: code.check code.check.dirty code.fix code.fix.dirty code.check.diff code.fix.diff
 
-version ?= 0.3.0
+version ?= 0.4.1
 branch ?= develop
 
 ECS_IMAGE := hub.jcdev.net:24000/php-code-analysis-tool:${version}

composer.json

@@ -5,10 +5,10 @@
     "require": {
         "symplify/coding-standard": "^12.0",
         "symplify/easy-coding-standard": "^12.0",
-        "friendsofphp/php-cs-fixer": "^3.26",
-        "kubawerlos/php-cs-fixer-custom-fixers": "^3.16",
-        "squizlabs/php_codesniffer": "^3.7",
-        "slevomat/coding-standard": "^8.13"
+        "friendsofphp/php-cs-fixer": "^3.41",
+        "kubawerlos/php-cs-fixer-custom-fixers": "^3.17",
+        "squizlabs/php_codesniffer": "^3.8",
+        "slevomat/coding-standard": "^8.14"
     },
     "license": "MIT",
     "authors": [
@@ -17,12 +17,17 @@
             "email": "igoshin18@gmail.com"
         }
     ],
+    "autoload": {
+        "psr-4": {
+            "JustCoded\\PhpCodeAnalysisTool\\": "/src"
+        }
+    },
     "minimum-stability": "dev",
     "prefer-stable": true,
     "config": {
         "allow-plugins": {
             "dealerdirect/phpcodesniffer-composer-installer": true
         }
     },
-    "version": "v0.2.1"
+    "version": "v0.4.0"
 }

composer.lock

@@ -0,0 +1,149 @@
+<?php
+
+declare(strict_types=1);
+
+namespace JustCoded\PhpCodeAnalysisTool\Fixers;
+
+use PhpCsFixer\AbstractFixer;
+use PhpCsFixer\DocBlock\DocBlock;
+use PhpCsFixer\Fixer\WhitespacesAwareFixerInterface;
+use PhpCsFixer\FixerDefinition\CodeSample;
+use PhpCsFixer\FixerDefinition\FixerDefinition;
+use PhpCsFixer\FixerDefinition\FixerDefinitionInterface;
+use PhpCsFixer\Tokenizer\Token;
+use PhpCsFixer\Tokenizer\Tokens;
+use SplFileInfo;
+
+final class DeclareStrictTypesFixer extends AbstractFixer implements WhitespacesAwareFixerInterface
+{
+    public function getDefinition(): FixerDefinitionInterface
+    {
+        return new FixerDefinition(
+            'Force strict types declaration in all files. Requires PHP >= 7.0.',
+            [
+                new CodeSample(
+                    "<?php\n",
+                ),
+            ],
+            null,
+            'Forcing strict types will stop non strict code from working.',
+        );
+    }
+
+    public function getPriority(): int
+    {
+        return 2;
+    }
+
+    public function isCandidate(Tokens $tokens): bool
+    {
+        return isset($tokens[0]) && $tokens[0]->isGivenKind(T_OPEN_TAG);
+    }
+
+    public function isRisky(): bool
+    {
+        return true;
+    }
+
+    protected function applyFix(SplFileInfo $file, Tokens $tokens): void
+    {
+        // check if the declaration is already done
+        $searchIndex = $tokens->getNextMeaningfulToken(0);
+        if (null === $searchIndex) {
+            $this->insertSequence($tokens); // declaration not found, insert one
+
+            return;
+        }
+
+        $sequenceLocation = $tokens->findSequence([[T_DECLARE, 'declare'],
+            '(',
+            [T_STRING, 'strict_types'],
+            '=',
+            [T_LNUMBER],
+            ')'], $searchIndex, null, false);
+        if (null === $sequenceLocation) {
+            $this->insertSequence($tokens); // declaration not found, insert one
+
+            return;
+        }
+
+        $this->fixStrictTypesCasingAndValue($tokens, $sequenceLocation);
+    }
+
+    /**
+     * @param array<int, Token> $sequence
+     */
+    private function fixStrictTypesCasingAndValue(Tokens $tokens, array $sequence): void
+    {
+        /** @var int $index */
+        /** @var Token $token */
+        foreach ($sequence as $index => $token) {
+            if ($token->isGivenKind(T_STRING)) {
+                $tokens[$index] = new Token([T_STRING, strtolower($token->getContent())]);
+
+                continue;
+            }
+            if ($token->isGivenKind(T_LNUMBER)) {
+                $tokens[$index] = new Token([T_LNUMBER, '1']);
+
+                break;
+            }
+        }
+    }
+
+    private function insertSequence(Tokens $tokens): void
+    {
+        $sequence = [
+            new Token([T_DECLARE, 'declare']),
+            new Token('('),
+            new Token([T_STRING, 'strict_types']),
+            new Token('='),
+            new Token([T_LNUMBER, '1']),
+            new Token(')'),
+            new Token(';'),
+        ];
+        $endIndex = count($sequence);
+
+        $insertIndex = 1;
+
+        foreach ($tokens as $index => $token) {
+            if (!$token->isGivenKind(T_DOC_COMMENT)) {
+                continue;
+            }
+
+            $doc = new DocBlock($token->getContent());
+
+            if (!count($doc->getAnnotationsOfType(['copyright']))) {
+                break;
+            }
+
+            $insertIndex = $tokens->getNextMeaningfulToken($index);
+
+            if (!$insertIndex) {
+                return;
+            }
+        }
+
+        $tokens->insertAt($insertIndex, $sequence);
+
+        // start index of the sequence is always 1 here, 0 is always open tag
+        // transform "<?php\n" to "<?php " if needed
+        if (str_contains($tokens[0]->getContent(), "\n")) {
+            $tokens[0] = new Token([$tokens[0]->getId(), trim($tokens[0]->getContent()) . ' ']);
+        }
+
+        if ($endIndex === count($tokens) - 1) {
+            return; // no more tokens after sequence, single_blank_line_at_eof might add a line
+        }
+
+        $lineEnding = $this->whitespacesConfig->getLineEnding();
+        if (!$tokens[1 + $endIndex]->isWhitespace()) {
+            $tokens->insertAt($insertIndex + $endIndex, new Token([T_WHITESPACE, $lineEnding]));
+
+            return;
+        }
+
+        $content = $tokens[$insertIndex + $endIndex]->getContent();
+        $tokens[$insertIndex + $endIndex] = new Token([T_WHITESPACE, $lineEnding . ltrim($content, " \t")]);
+    }
+}

src/Fixers/DeclareStrictTypesFixer.php

@@ -0,0 +1,18 @@
+{
+    "name": "justcoded/php-code-analysis-tool",
+    "description": "Automatically check and fix PHP code. We need composer.json to install dependencies and allow IDE to help us with maintaining ecs.php",
+    "type": "package",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Roman Ihoshyn",
+            "email": "igoshin18@gmail.com"
+        }
+    ],
+    "autoload": {
+        "psr-4": {
+            "JustCoded\\PhpCodeAnalysisTool\\": "./"
+        }
+    },
+    "version": "v0.4.0"
+}

src/composer.json

@@ -2,6 +2,7 @@
 
 declare(strict_types=1);
 
+use JustCoded\PhpCodeAnalysisTool\Fixers\DeclareStrictTypesFixer;
 use PhpCsFixer\Fixer\Alias\NoAliasFunctionsFixer;
 use PhpCsFixer\Fixer\Alias\NoAliasLanguageConstructCallFixer;
 use PhpCsFixer\Fixer\Alias\NoMixedEchoPrintFixer;
@@ -84,7 +85,6 @@
 use PhpCsFixer\Fixer\Semicolon\MultilineWhitespaceBeforeSemicolonsFixer;
 use PhpCsFixer\Fixer\Semicolon\NoEmptyStatementFixer;
 use PhpCsFixer\Fixer\Semicolon\NoSinglelineWhitespaceBeforeSemicolonsFixer;
-use PhpCsFixer\Fixer\Strict\DeclareStrictTypesFixer;
 use PhpCsFixer\Fixer\StringNotation\ExplicitStringVariableFixer;
 use PhpCsFixer\Fixer\StringNotation\HeredocToNowdocFixer;
 use PhpCsFixer\Fixer\StringNotation\NoBinaryStringFixer;