Add PHP CS Fixer v3 support (#499)

kubawerlos · web-flow · commit 6709431a0640 · 2021-05-04T02:56:29.000+02:00
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -36,6 +36,12 @@ jobs:
         os: [ macos-latest, ubuntu-latest, windows-latest ]
         php-version: [ '7.4', '8.0' ]
         include:
+          - os: ubuntu-18.04
+            php-version: '8.0'
+            php-cs-fixer-version: '^2'
+          - os: ubuntu-18.04
+            php-version: '7.4'
+            php-cs-fixer-version: '^2'
           - os: ubuntu-latest
             php-version: '7.3'
           - os: ubuntu-latest
@@ -89,6 +95,10 @@ jobs:
           key: ${{ runner.os }}-composer-cache-${{ hashFiles('**/composer.json') }}
           restore-keys: ${{ runner.os }}-composer-cache-
 
+      - name: Configure PHP CS Fixer version
+        if: matrix.php-cs-fixer-version
+        run: composer require friendsofphp/php-cs-fixer:${{ matrix.php-cs-fixer-version }} --no-update
+
       - name: Install dependencies
         run: composer update --no-progress ${{ matrix.composer_flags }}
 
diff --git a/.php-cs-fixer.php b/.php-cs-fixer.php
diff --git a/composer.json b/composer.json
@@ -12,7 +12,7 @@
     "require": {
         "php": "^7.2 || ^8.0",
         "ext-tokenizer": "*",
-        "friendsofphp/php-cs-fixer": "^2.17",
+        "friendsofphp/php-cs-fixer": "^2.17 || ^3.0.0",
         "symfony/finder": "^3.0 || ^4.0 || ^5.0"
     },
     "require-dev": {
diff --git a/dev-tools/composer.json b/dev-tools/composer.json
@@ -3,7 +3,7 @@
         "ergebnis/composer-normalize": "^2.13.3",
         "infection/infection": "^0.22.0",
         "kubawerlos/composer-smaller-lock": "^0.1.1",
-        "kubawerlos/php-cs-fixer-config": "dev-master",
+        "kubawerlos/php-cs-fixer-config": "dev-main",
         "kubawerlos/types-checker": "^2.1.0",
         "maglnet/composer-require-checker": "^3.2.0",
         "mi-schi/phpmd-extension": "^4.3.0",
diff --git a/dev-tools/composer.lock b/dev-tools/composer.lock
diff --git a/dev-tools/phpcs.xml b/dev-tools/phpcs.xml
@@ -9,7 +9,7 @@
     <file>./src</file>
     <file>../src</file>
     <file>../tests</file>
-    <file>../.php_cs</file>
+    <file>../.php-cs-fixer.php</file>
     <exclude-pattern>./src/Readme/php-cs-fixer.config.*.php</exclude-pattern>
 
     <rule ref='PSR12'>
diff --git a/dev-tools/phpstan.neon b/dev-tools/phpstan.neon
@@ -4,7 +4,7 @@ parameters:
   excludes_analyse:
     - ./src/Readme
   ignoreErrors:
-    - message: '#^Call to an undefined method PhpCsFixer\\Fixer\\DefinedFixerInterface::#'
+    - message: '#^Call to an undefined method PhpCsFixer\\Fixer\\FixerInterface::[a-zA-Z]+\(\)\.$#'
       path: ../tests
     - message: '#^Call to function method_exists\(\) with ''Tests\\\\.*'' and ''.*'' will always evaluate to true\.$#'
       path: ../tests
diff --git a/dev-tools/psalm.xml b/dev-tools/psalm.xml
@@ -39,6 +39,7 @@
                 <file name='./src/Fixer/OrderedClassElementsInternalFixer.php' />
                 <file name='../src/Analyzer/Analysis/ArrayElementAnalysis.php' />
                 <file name='../src/Fixer/DeprecatingFixerInterface.php' />
+                <file name='../src/Fixer/NoLeadingSlashInGlobalNamespaceFixer.php' />
             </errorLevel>
         </PossiblyUnusedMethod>
         <UnnecessaryVarAnnotation errorLevel='suppress' />
diff --git a/dev-tools/src/Readme/ReadmeCommand.php b/dev-tools/src/Readme/ReadmeCommand.php
@@ -15,7 +15,6 @@
 
 use PhpCsFixer\Console\Command\HelpCommand;
 use PhpCsFixer\Fixer\ConfigurableFixerInterface;
-use PhpCsFixer\Fixer\ConfigurationDefinitionFixerInterface;
 use PhpCsFixer\Fixer\DeprecatedFixerInterface;
 use PhpCsFixer\FixerDefinition\CodeSample;
 use PhpCsFixer\StdinFileInfo;
@@ -195,7 +194,7 @@ private function fixers(): string
                 );
             }
 
-            if ($fixer instanceof ConfigurationDefinitionFixerInterface) {
+            if ($fixer instanceof ConfigurableFixerInterface) {
                 $output .= "\nConfiguration options:";
 
                 foreach ($fixer->getConfigurationDefinition()->getOptions() as $option) {
diff --git a/src/Fixer/AbstractFixer.php b/src/Fixer/AbstractFixer.php
@@ -13,10 +13,10 @@
 
 namespace PhpCsFixerCustomFixers\Fixer;
 
-use PhpCsFixer\Fixer\DefinedFixerInterface;
+use PhpCsFixer\Fixer\FixerInterface;
 use PhpCsFixer\Preg;
 
-abstract class AbstractFixer implements DefinedFixerInterface
+abstract class AbstractFixer implements FixerInterface
 {
     final public static function name(): string
     {
diff --git a/src/Fixer/CommentedOutFunctionFixer.php b/src/Fixer/CommentedOutFunctionFixer.php
@@ -13,7 +13,7 @@
 
 namespace PhpCsFixerCustomFixers\Fixer;
 
-use PhpCsFixer\Fixer\ConfigurationDefinitionFixerInterface;
+use PhpCsFixer\Fixer\ConfigurableFixerInterface;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolver;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolverInterface;
 use PhpCsFixer\FixerConfiguration\FixerOptionBuilder;
@@ -26,7 +26,7 @@
 use PhpCsFixer\Tokenizer\Token;
 use PhpCsFixer\Tokenizer\Tokens;
 
-final class CommentedOutFunctionFixer extends AbstractFixer implements ConfigurationDefinitionFixerInterface
+final class CommentedOutFunctionFixer extends AbstractFixer implements ConfigurableFixerInterface
 {
     /** @var string[] */
     private $functions = ['print_r', 'var_dump', 'var_export'];
diff --git a/src/Fixer/DataProviderNameFixer.php b/src/Fixer/DataProviderNameFixer.php
@@ -13,7 +13,7 @@
 
 namespace PhpCsFixerCustomFixers\Fixer;
 
-use PhpCsFixer\Fixer\ConfigurationDefinitionFixerInterface;
+use PhpCsFixer\Fixer\ConfigurableFixerInterface;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolver;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolverInterface;
 use PhpCsFixer\FixerConfiguration\FixerOptionBuilder;
@@ -26,7 +26,7 @@
 use PhpCsFixer\Tokenizer\Tokens;
 use PhpCsFixerCustomFixers\Analyzer\DataProviderAnalyzer;
 
-final class DataProviderNameFixer extends AbstractFixer implements ConfigurationDefinitionFixerInterface
+final class DataProviderNameFixer extends AbstractFixer implements ConfigurableFixerInterface
 {
     /** @var string */
     private $prefix = 'provide';
diff --git a/src/Fixer/NoSuperfluousConcatenationFixer.php b/src/Fixer/NoSuperfluousConcatenationFixer.php
@@ -13,7 +13,7 @@
 
 namespace PhpCsFixerCustomFixers\Fixer;
 
-use PhpCsFixer\Fixer\ConfigurationDefinitionFixerInterface;
+use PhpCsFixer\Fixer\ConfigurableFixerInterface;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolver;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolverInterface;
 use PhpCsFixer\FixerConfiguration\FixerOptionBuilder;
@@ -24,7 +24,7 @@
 use PhpCsFixer\Tokenizer\Token;
 use PhpCsFixer\Tokenizer\Tokens;
 
-final class NoSuperfluousConcatenationFixer extends AbstractFixer implements ConfigurationDefinitionFixerInterface
+final class NoSuperfluousConcatenationFixer extends AbstractFixer implements ConfigurableFixerInterface
 {
     /** @var bool */
     private $allowPreventingTrailingSpaces = false;
diff --git a/src/Fixer/NumericLiteralSeparatorFixer.php b/src/Fixer/NumericLiteralSeparatorFixer.php
@@ -13,7 +13,7 @@
 
 namespace PhpCsFixerCustomFixers\Fixer;
 
-use PhpCsFixer\Fixer\ConfigurationDefinitionFixerInterface;
+use PhpCsFixer\Fixer\ConfigurableFixerInterface;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolver;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolverInterface;
 use PhpCsFixer\FixerConfiguration\FixerOptionBuilder;
@@ -25,7 +25,7 @@
 use PhpCsFixer\Tokenizer\Token;
 use PhpCsFixer\Tokenizer\Tokens;
 
-final class NumericLiteralSeparatorFixer extends AbstractFixer implements ConfigurationDefinitionFixerInterface
+final class NumericLiteralSeparatorFixer extends AbstractFixer implements ConfigurableFixerInterface
 {
     /** @var null|bool */
     private $binarySeparator = false;
diff --git a/src/Fixer/OperatorLinebreakFixer.php b/src/Fixer/OperatorLinebreakFixer.php
@@ -13,7 +13,7 @@
 
 namespace PhpCsFixerCustomFixers\Fixer;
 
-use PhpCsFixer\Fixer\ConfigurationDefinitionFixerInterface;
+use PhpCsFixer\Fixer\ConfigurableFixerInterface;
 use PhpCsFixer\Fixer\DeprecatedFixerInterface;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolverInterface;
 use PhpCsFixer\FixerDefinition\FixerDefinitionInterface;
@@ -22,7 +22,7 @@
 /**
  * @deprecated
  */
-final class OperatorLinebreakFixer extends AbstractFixer implements ConfigurationDefinitionFixerInterface, DeprecatedFixerInterface
+final class OperatorLinebreakFixer extends AbstractFixer implements ConfigurableFixerInterface, DeprecatedFixerInterface
 {
     /** @var \PhpCsFixer\Fixer\Operator\OperatorLinebreakFixer */
     private $fixer;
diff --git a/src/Fixer/PhpdocOnlyAllowedAnnotationsFixer.php b/src/Fixer/PhpdocOnlyAllowedAnnotationsFixer.php
@@ -14,7 +14,7 @@
 namespace PhpCsFixerCustomFixers\Fixer;
 
 use PhpCsFixer\DocBlock\DocBlock;
-use PhpCsFixer\Fixer\ConfigurationDefinitionFixerInterface;
+use PhpCsFixer\Fixer\ConfigurableFixerInterface;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolver;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolverInterface;
 use PhpCsFixer\FixerConfiguration\FixerOptionBuilder;
@@ -25,7 +25,7 @@
 use PhpCsFixer\Tokenizer\Token;
 use PhpCsFixer\Tokenizer\Tokens;
 
-final class PhpdocOnlyAllowedAnnotationsFixer extends AbstractFixer implements ConfigurationDefinitionFixerInterface
+final class PhpdocOnlyAllowedAnnotationsFixer extends AbstractFixer implements ConfigurableFixerInterface
 {
     /** @var string[] */
     private $elements = [];
diff --git a/src/Fixer/SingleSpaceAfterStatementFixer.php b/src/Fixer/SingleSpaceAfterStatementFixer.php
@@ -13,7 +13,7 @@
 
 namespace PhpCsFixerCustomFixers\Fixer;
 
-use PhpCsFixer\Fixer\ConfigurationDefinitionFixerInterface;
+use PhpCsFixer\Fixer\ConfigurableFixerInterface;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolver;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolverInterface;
 use PhpCsFixer\FixerConfiguration\FixerOptionBuilder;
@@ -25,7 +25,7 @@
 use PhpCsFixer\Tokenizer\Token;
 use PhpCsFixer\Tokenizer\Tokens;
 
-final class SingleSpaceAfterStatementFixer extends AbstractFixer implements ConfigurationDefinitionFixerInterface
+final class SingleSpaceAfterStatementFixer extends AbstractFixer implements ConfigurableFixerInterface
 {
     /** @var int[] */
     private $tokens = [
diff --git a/tests/Fixer/AbstractFixerTestCase.php b/tests/Fixer/AbstractFixerTestCase.php
@@ -14,8 +14,8 @@
 namespace Tests\Fixer;
 
 use PhpCsFixer\Fixer\ConfigurableFixerInterface;
-use PhpCsFixer\Fixer\DefinedFixerInterface;
 use PhpCsFixer\Fixer\DeprecatedFixerInterface;
+use PhpCsFixer\Fixer\FixerInterface;
 use PhpCsFixer\Linter\Linter;
 use PhpCsFixer\Tokenizer\Tokens;
 use PHPUnit\Framework\TestCase;
@@ -30,7 +30,7 @@ abstract class AbstractFixerTestCase extends TestCase
     use AssertRegExpTrait;
     use AssertSameTokensTrait;
 
-    /** @var DefinedFixerInterface */
+    /** @var FixerInterface */
     protected $fixer;
 
     final protected function setUp(): void
@@ -39,7 +39,7 @@ final protected function setUp(): void
 
         $className = 'PhpCsFixerCustomFixers\\Fixer\\' . \substr($reflectionClass->getShortName(), 0, -4);
 
-        /** @var DefinedFixerInterface $fixer */
+        /** @var FixerInterface $fixer */
         $fixer = new $className();
 
         $this->fixer = $fixer;

Original file line number	Diff line number	Diff line change
`@@ -13,10 +13,10 @@`
`13`	`13`
`14`	`14`	`namespace PhpCsFixerCustomFixers\Fixer;`
`15`	`15`
`16`		`-use PhpCsFixer\Fixer\DefinedFixerInterface;`
	`16`	`+use PhpCsFixer\Fixer\FixerInterface;`
`17`	`17`	`use PhpCsFixer\Preg;`
`18`	`18`
`19`		`-abstract class AbstractFixer implements DefinedFixerInterface`
	`19`	`+abstract class AbstractFixer implements FixerInterface`
`20`	`20`	`{`
`21`	`21`	`final public static function name(): string`
`22`	`22`	`{`