Merge pull request #5 from simonschaufi/upgrade

[TASK] Upgrade to friendsofphp/php-cs-fixer 3.0

Author: bmack

.gitignore

@@ -1,4 +1,5 @@
+/.idea/
 /.build/
 /vendor/
 /composer.lock
-/.php_cs.cache
+/.php-cs-fixer.cache

README.md

@@ -44,7 +44,7 @@ or if you want to update the rules, add `-f` option to the end.
 
 Have a look at the newly created files in your root folder:
 
-- .php_cs
+- .php-cs-fixer.php
 - .editorconfig
 
 For projects, the folder `src/extensions` is configured by default, but you can

composer.json

@@ -11,7 +11,7 @@
 	],
 	"require": {
 		"php": "^7.2 || ^8.0",
-		"friendsofphp/php-cs-fixer": "^2.19"
+		"friendsofphp/php-cs-fixer": "^3.0"
 	},
 	"config": {
 		"sort-packages": true

setup.php

@@ -2,7 +2,7 @@
 <?php
 declare(strict_types = 1);
 
-$setup = function($scriptPath, string $type = null, $forceOption = null) {
+$setup = static function($scriptPath, string $type = null, $forceOption = null) {
     $rootPath = getcwd();
 
     $dir = __DIR__ . '/vendor';

src/CsFixerConfig.php

@@ -11,6 +11,7 @@
  */
 
 use PhpCsFixer\Config;
+use PhpCsFixer\ConfigInterface;
 
 class CsFixerConfig extends Config
 {
@@ -83,25 +84,26 @@ public function __construct($name = 'TYPO3')
         parent::__construct($name);
     }
 
-    public static function create()
+    public static function create(): ConfigInterface
     {
-        /** @var self $obj */
-        $obj = parent::create();
-        $obj->setRiskyAllowed(true);
-        // Apply our rules
-        $obj->setRules(static::$typo3Rules);
-        $obj->getFinder()->exclude(['vendor', 'typo3temp', 'var', '.build']);
-        return $obj;
+        $config = (new self())
+            ->setRiskyAllowed(true)
+            ->setRules(static::$typo3Rules);
+
+        $config->getFinder()->exclude(['vendor', 'typo3temp', 'var', '.build']);
+        return $config;
     }
 
-    public function addRules(array $rules)
+    public function addRules(array $rules): ConfigInterface
     {
         $rules = array_replace_recursive($this->getRules(), $rules);
-        $this->setRules($rules);
+        return $this->setRules($rules);
     }
 
-    public function setHeader(string $header = 'This file is part of the TYPO3 CMS project.', $replaceAll = false)
-    {
+    public function setHeader(
+        string $header = 'This file is part of the TYPO3 CMS project.',
+        bool $replaceAll = false
+    ): ConfigInterface {
         if (!$replaceAll) {
             $header = str_replace('{header}', $header, static::$defaultHeader);
         }
@@ -112,6 +114,6 @@ public function setHeader(string $header = 'This file is part of the TYPO3 CMS p
             'location' => 'after_declare_strict',
             'separate' => 'both'
         ];
-        return parent::setRules($rules);
+        return $this->setRules($rules);
     }
 }

src/Setup.php

@@ -32,11 +32,13 @@ public function forProject(bool $force): int
     {
         $errors = $this->copyEditorConfig($force);
         // copy php-cs-fixer configuration
-        if (file_exists($this->rootPath . '/.php_cs') && !$force) {
-            echo "A .php_cs file already exists in your main folder, but the -f option was not set. Nothing copied.\n";
+        if (!$force
+            && (file_exists($this->rootPath . '/.php_cs') || file_exists($this->rootPath . '/.php-cs-fixer.php'))
+        ) {
+            echo "A .php-cs-fixer.php or .php_cs file already exists in your main folder, but the -f option was not set. Nothing copied.\n";
             $errors = true;
         } else {
-            copy($this->templatesPath . '/project_php_cs.dist', $this->rootPath . '/.php_cs');
+            copy($this->templatesPath . '/project_php-cs-fixer.dist.php', $this->rootPath . '/.php-cs-fixer.php');
         }
         return $errors ? 1 : 0;
     }
@@ -45,11 +47,13 @@ public function forExtension(bool $force): int
     {
         $errors = $this->copyEditorConfig($force);
         // copy php-cs-fixer configuration
-        if (file_exists($this->rootPath . '/.php_cs') && !$force) {
-            echo "A .php_cs file already exists in your main folder, but the -f option was not set. Nothing copied.\n";
+        if (!$force
+            && (file_exists($this->rootPath . '/.php_cs') || file_exists($this->rootPath . '/.php-cs-fixer.php'))
+        ) {
+            echo "A .php-cs-fixer.php or .php_cs file already exists in your main folder, but the -f option was not set. Nothing copied.\n";
             $errors = true;
         } else {
-            copy($this->templatesPath . '/extension_php_cs.dist', $this->rootPath . '/.php_cs');
+            copy($this->templatesPath . '/extension_php-cs-fixer.dist.php', $this->rootPath . '/.php-cs-fixer.php');
         }
         return $errors ? 1 : 0;
     }
@@ -58,7 +62,7 @@ private function copyEditorConfig(bool $force): bool
     {
         $errors = false;
         // copy editorconfig
-        if (file_exists($this->rootPath . '/.editorconfig') && !$force) {
+        if (!$force && file_exists($this->rootPath . '/.editorconfig')) {
             echo "A .editorconfig file already exists in your main folder, but the -f option was not set. Nothing copied.\n";
             $errors = true;
         } else {