Add new fixers

README.md

@@ -82,8 +82,10 @@ return ECSConfig::configure()
         [
             // PHPUnit attributes must be used over their respective PHPDoc-based annotations. (Use with PHPUnit 10+.)
             PhpUnitAttributesFixer::class,
-            // Single-line comments must have proper spacing.
+            // Single-line comments must have proper spacing (one space after `//`).
             SingleLineCommentSpacingFixer::class,
+            // Convert multiline string to heredoc or nowdoc.
+            MultilineStringToHeredocFixer::class,
         ]
     )
     // Enforce line-length to 120 characters.

UPGRADE-4.0.md

@@ -85,6 +85,11 @@ $ vendor/bin/ecs check --ansi src/ tests/ # old
 $ vendor/bin/ecs check --ansi # new
 ```
 
+### 6. Add some optional rules
+On top of default rules included in ecs.php, there are some more opinionated ones you may want to add.
+
+These suggested rules are listed in [README.md](https://github.com/lmc-eu/php-coding-standard?tab=readme-ov-file#add-custom-checks-or-override-default-settings).
+
 ### 5. BE CAREFUL WITH SUGGESTED CHANGES! ⚠️
 
 Some of the new default fixers introduced in php-coding-standard 4.0 and 4.1 suggest changes, which - if not

composer.json

@@ -11,10 +11,10 @@
     ],
     "require": {
         "php": "^8.0",
-        "friendsofphp/php-cs-fixer": "^3.0",
-        "slevomat/coding-standard": "^8.0",
+        "friendsofphp/php-cs-fixer": "^3.47.1",
+        "slevomat/coding-standard": "^8.6",
         "squizlabs/php_codesniffer": "^3.9",
-        "symplify/easy-coding-standard": "^12.1.5"
+        "symplify/easy-coding-standard": "^12.1.9"
     },
     "require-dev": {
         "ergebnis/composer-normalize": "^2.42.0",

ecs-internal.php

@@ -6,7 +6,7 @@
 use Symplify\CodingStandard\Fixer\LineLength\LineLengthFixer;
 use Symplify\EasyCodingStandard\Config\ECSConfig;
 
-/**
+/*
  * Internal rules configuration for the lmc/coding-standard project itself
  */
 return ECSConfig::configure()

src/Helper/SniffClassWrapper.php

@@ -33,9 +33,7 @@
 
 final class SniffClassWrapper
 {
-    public function __construct(private File $file, private int $position, private Naming $naming)
-    {
-    }
+    public function __construct(private File $file, private int $position, private Naming $naming) {}
 
     public function getClassName(): ?string
     {

tests/Integration/CodingStandardTest.php

@@ -9,25 +9,23 @@
  */
 class CodingStandardTest extends TestCase
 {
+    private string $tempFixtureFile;
+
+    /** @after */
+    protected function cleanUpTempFixtureFile(): void
+    {
+        unlink($this->tempFixtureFile);
+    }
+
     /**
      * @test
      * @dataProvider provideFilesToFix
      */
     public function shouldFixFile(string $wrongFile, string $correctFile): void
     {
-        // copy wrongFile to a new temporary file
-        $fixtureFile = tempnam(sys_get_temp_dir(), 'ecs-test');
-        if ($fixtureFile === false) {
-            $this->fail('Could not create temporary file');
-        }
-        copy($wrongFile, $fixtureFile);
-
-        shell_exec(
-            __DIR__ . '/../../vendor/bin/ecs check --no-progress-bar --no-ansi --no-interaction --fix ' . $fixtureFile,
-        );
+        $fixedFile = $this->runEcsCheckOnFile($wrongFile);
 
-        $this->assertStringEqualsFile($correctFile, file_get_contents($fixtureFile));
-        unlink($fixtureFile);
+        $this->assertStringEqualsFile($correctFile, file_get_contents($fixedFile));
     }
 
     public function provideFilesToFix(): array
@@ -38,6 +36,66 @@ public function provideFilesToFix(): array
                 __DIR__ . '/Fixtures/NewPhpFeatures.wrong.php.inc',
                 __DIR__ . '/Fixtures/NewPhpFeatures.correct.php.inc',
             ],
+            'PhpDoc' => [__DIR__ . '/Fixtures/PhpDoc.wrong.php.inc', __DIR__ . '/Fixtures/PhpDoc.correct.php.inc'],
+            'PhpUnit' => [__DIR__ . '/Fixtures/PhpUnit.wrong.php.inc', __DIR__ . '/Fixtures/PhpUnit.correct.php.inc'],
         ];
     }
+
+    /**
+     * @test
+     * @requires PHP >= 8.1
+     */
+    public function shouldFixPhp81(): void
+    {
+        $fixedFile = $this->runEcsCheckOnFile(__DIR__ . '/Fixtures/Php81.wrong.php.inc');
+
+        $this->assertStringEqualsFile(
+            __DIR__ . '/Fixtures/Php81.correct.php.inc',
+            file_get_contents($fixedFile),
+        );
+    }
+
+    /**
+     * @test
+     * @requires PHP >= 8.2
+     */
+    public function shouldFixPhp82(): void
+    {
+        $fixedFile = $this->runEcsCheckOnFile(__DIR__ . '/Fixtures/Php82.wrong.php.inc');
+
+        $this->assertStringEqualsFile(
+            __DIR__ . '/Fixtures/Php82.correct.php.inc',
+            file_get_contents($fixedFile),
+        );
+    }
+
+    private function runEcsCheckOnFile(string $file): string
+    {
+        $fixtureFile = $this->initTempFixtureFile();
+
+        // copy source of wrongFile to a temporary file which will be modified by ECS
+        copy($file, $fixtureFile);
+
+        shell_exec(
+            sprintf(
+                '%s/../../vendor/bin/ecs check --no-progress-bar --no-ansi --no-interaction --fix %s',
+                __DIR__,
+                $fixtureFile,
+            ),
+        );
+
+        return $fixtureFile;
+    }
+
+    private function initTempFixtureFile(): string
+    {
+        // Create new file in temporary directory
+        $fixtureFile = tempnam(sys_get_temp_dir(), 'ecs-test');
+        if ($fixtureFile === false) {
+            $this->fail('Could not create temporary file');
+        }
+        $this->tempFixtureFile = $fixtureFile; // store to be able to remove it later
+
+        return $fixtureFile;
+    }
 }

tests/Integration/Fixtures/Basic.correct.php.inc

@@ -1,13 +1,32 @@
 <?php declare(strict_types=1);
 
-class Basic
+namespace Lmc\CodingStandard\Integration\Fixtures;
+
+// NoUnneededImportAliasFixer
+use Bar\Foo;
+use Some\Other\Namespace\AbstractBasic;
+
+class Basic extends AbstractBasic implements InterfaceFromThisNamespace // FullyQualifiedStrictTypesFixer
 {
+    use SomeUsefulTrait; // OrderedClassElementsFixer
     public const FOO = 'foo'; // ClassAttributesSeparationFixer
 
-    public function isEqual($a, $b) // VisibilityRequiredFixer
+    public const MY_PUBLIC_CONST = 333; // OrderedClassElementsFixer
+
+    protected int $myProperty = 666; // OrderedClassElementsFixer
+
+    // MagicMethodCasingFixer, OrderedClassElementsFixer
+    public function __toString(): string
+    {
+        return '';
+    }
+
+    public function isEqual($a, ?string $b): ?bool // VisibilityRequiredFixer, CompactNullableTypeDeclarationFixer
     {
         // TrimArraySpacesFixer
         $fooBar = ['a', 'b'];
+        // NoTrailingCommaInSinglelineFixer
+        mb_strlen('foobar');
         // MbStrFunctionsFixer
         $bazLength = mb_strlen('baz');
         // LambdaNotUsedImportFixer
@@ -16,6 +35,13 @@ class Basic
         $uselessSprintf = 'bar';
         // StrictParamFixer
         $useStrictParam = in_array(1337, $fooBar, true);
+        // NoSpaceAroundDoubleColonFixer
+        $className = DateTime::class;
+        // ClassReferenceNameCasingFixer
+        $date = new \DateTime();
+
+        $aliasedClass = new Foo();
+
         // SingleSpaceAfterConstructFixer, StrictComparisonFixer
         if ($a === $b || $bazLength !== 3) {
             return true;
@@ -24,9 +50,116 @@ class Basic
         return false; // BlankLineBeforeStatementFixer
     }
 
-    public function fooBar(mixed $foo): mixed
+    public function fooBar(mixed $foo): mixed // FunctionDeclarationFixer
     {
+        // MagicConstantCasingFixer
+        $magicConstant = __DIR__;
+        $value = 5;
+        // FunctionDeclarationFixer
+        $function = function ($foo) use ($value) {
+            return $foo + $value;
+        };
+        // FunctionDeclarationFixer
+        $fn = fn($foo) => $foo + $value;
+
+        // PhpdocToCommentFixer
+        /*
+         * Phpdoc used instead of plain comment
+         */
+        if ($foo === 'bar') {
+            // NoAliasFunctionsFixer
+            $baz = implode(',', ['foo', 'bar']);
+        }
+
+        $i = 3;
+        $i += 6; // LongToShorthandOperatorFixer
+        $i *= 2; // LongToShorthandOperatorFixer
+        $text = 'foo';
+        $text .= 'bar'; // LongToShorthandOperatorFixer
+
+        switch ($i) {
+            case 1: // NoUnneededControlParenthesesFixer
+                $i++;
+                break;
+            default:
+                break;
+        }
+
+        // HeredocIndentationFixer
+        $heredoc = <<<HEREDOC
+            This is a
+            multiline heredoc string. It contains $foo.
+            It should be indented, though.
+            HEREDOC;
+        // HeredocIndentationFixer
+        $newdoc = <<<'NEWDOC'
+            This is a $newdoc, where variables are not expanded.
+            NEWDOC;
+
         // TernaryToElvisOperatorFixer
         return ($foo ?: 'not true');
     }
+
+    public function arrayDeclarations(): void
+    {
+        $empty = [];
+
+        $singleLineArray = ['foo', 'bar', 'baz'];
+        $singleLineArray2 = [1, 2, 3];
+
+        $multiLineAssociative1 = [
+            'foo' => 'bar',
+            'baz' => 'bat',
+        ];
+
+        $multiLineAssociative2 = [
+            'foo' => 'bar',
+            'baz' => 'bat',
+            'bak' => 'baz',
+        ];
+
+        $multiLineAssociative3 = [
+            'firstKey' => 'bar',
+            'thisIsSecondKey' => 'bat',
+            'third' => 'bat',
+        ];
+    }
+
+    public function emptyFunction1(): void {} // SingleLineEmptyBodyFixer
+
+    public function emptyFunction2(
+        $arg,
+    ): void {} // SingleLineEmptyBodyFixer
+
+    // TrailingCommaInMultilineFixer
+    public function multiline(
+        $arg1,
+        $arg2,
+        $arg3,
+    ): void {
+        // TrailingCommaInMultilineFixer
+        $isSet = isset(
+            $arg1,
+            $arg2,
+            $arg3,
+        );
+
+        $sprintf = sprintf(
+            '%s%s',
+            'bar',
+            'baz',
+        );
+
+        foo(
+            1,
+            2,
+        );
+    }
+
+    public function withParameters(
+        // NullableTypeDeclarationFixer
+        ?string $nullableValue,
+        // NullableTypeDeclarationForDefaultNullValueFixer
+        ?string $anotherNullableValue = null,
+    ): void {}
 }