work

PHP-CS-Fixer · May 6, 2024 · e17c999 · e17c999
1 parent 5780cb7
commit e17c999
Show file tree

Hide file tree

Showing 131 changed files with 880 additions and 143 deletions.
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -55,6 +55,6 @@
     <php>
         <ini name="zend.enable_gc" value="0"/>
         <ini name="memory_limit" value="10G"/>
-        <env name="FAST_LINT_TEST_CASES" value="0"/>
+        <env name="FAST_LINT_TEST_CASES" value="1"/>
     </php>
 </phpunit>
diff --git a/src/AbstractDoctrineAnnotationFixer.php b/src/AbstractDoctrineAnnotationFixer.php
@@ -16,6 +16,7 @@
 
 use PhpCsFixer\Doctrine\Annotation\Tokens as DoctrineAnnotationTokens;
 use PhpCsFixer\Fixer\ConfigurableFixerInterface;
+use PhpCsFixer\Fixer\ConfigurableFixerTrait;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolver;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolverInterface;
 use PhpCsFixer\FixerConfiguration\FixerOptionBuilder;
@@ -29,6 +30,9 @@
  */
 abstract class AbstractDoctrineAnnotationFixer extends AbstractFixer implements ConfigurableFixerInterface
 {
+    /** @use ConfigurableFixerTrait<_Configuration> */
+    use ConfigurableFixerTrait;
+
     /**
      * @var array<int, array{classIndex: int, token: Token, type: string}>
      */

diff --git a/src/AbstractPhpdocToTypeDeclarationFixer.php b/src/AbstractPhpdocToTypeDeclarationFixer.php
@@ -18,6 +18,7 @@
 use PhpCsFixer\DocBlock\DocBlock;
 use PhpCsFixer\DocBlock\TypeExpression;
 use PhpCsFixer\Fixer\ConfigurableFixerInterface;
+use PhpCsFixer\Fixer\ConfigurableFixerTrait;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolver;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolverInterface;
 use PhpCsFixer\FixerConfiguration\FixerOptionBuilder;
@@ -34,6 +35,9 @@
  */
 abstract class AbstractPhpdocToTypeDeclarationFixer extends AbstractFixer implements ConfigurableFixerInterface
 {
+    /** @use ConfigurableFixerTrait<_Configuration> */
+    use ConfigurableFixerTrait;
+
     private const REGEX_CLASS = '(?:\\\?+'.TypeExpression::REGEX_IDENTIFIER
         .'(\\\\'.TypeExpression::REGEX_IDENTIFIER.')*+)';
 

diff --git a/src/Console/Command/DescribeCommand.php b/src/Console/Command/DescribeCommand.php
@@ -21,6 +21,7 @@
 use PhpCsFixer\Differ\FullDiffer;
 use PhpCsFixer\Documentation\FixerDocumentGenerator;
 use PhpCsFixer\Fixer\ConfigurableFixerInterface;
+use PhpCsFixer\Fixer\ConfigurableFixerTrait;
 use PhpCsFixer\Fixer\DeprecatedFixerInterface;
 use PhpCsFixer\Fixer\ExperimentalFixerInterface;
 use PhpCsFixer\Fixer\FixerInterface;

diff --git a/src/Documentation/FixerDocumentGenerator.php b/src/Documentation/FixerDocumentGenerator.php
@@ -17,6 +17,7 @@
 use PhpCsFixer\Console\Command\HelpCommand;
 use PhpCsFixer\Differ\FullDiffer;
 use PhpCsFixer\Fixer\ConfigurableFixerInterface;
+use PhpCsFixer\Fixer\ConfigurableFixerTrait;
 use PhpCsFixer\Fixer\DeprecatedFixerInterface;
 use PhpCsFixer\Fixer\ExperimentalFixerInterface;
 use PhpCsFixer\Fixer\FixerInterface;

diff --git a/src/Fixer/Alias/NoAliasFunctionsFixer.php b/src/Fixer/Alias/NoAliasFunctionsFixer.php
@@ -16,6 +16,7 @@
 
 use PhpCsFixer\AbstractFixer;
 use PhpCsFixer\Fixer\ConfigurableFixerInterface;
+use PhpCsFixer\Fixer\ConfigurableFixerTrait;
 use PhpCsFixer\FixerConfiguration\AllowedValueSubset;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolver;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolverInterface;
@@ -34,6 +35,9 @@
  */
 final class NoAliasFunctionsFixer extends AbstractFixer implements ConfigurableFixerInterface
 {
+    /** @use ConfigurableFixerTrait<_Configuration> */
+    use ConfigurableFixerTrait;
+
     private const SETS = [
         '@internal' => [
             'diskfreespace' => 'disk_free_space',
@@ -160,10 +164,8 @@ final class NoAliasFunctionsFixer extends AbstractFixer implements ConfigurableF
      */
     private array $aliases = [];
 
-    public function configure(array $configuration): void
+    protected function configurePostNormalisation(): void
     {
-        parent::configure($configuration);
-
         $this->aliases = [];
 
         foreach ($this->configuration['sets'] as $set) {

diff --git a/src/Fixer/Alias/NoMixedEchoPrintFixer.php b/src/Fixer/Alias/NoMixedEchoPrintFixer.php
@@ -16,6 +16,7 @@
 
 use PhpCsFixer\AbstractFixer;
 use PhpCsFixer\Fixer\ConfigurableFixerInterface;
+use PhpCsFixer\Fixer\ConfigurableFixerTrait;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolver;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolverInterface;
 use PhpCsFixer\FixerConfiguration\FixerOptionBuilder;
@@ -31,14 +32,16 @@
  */
 final class NoMixedEchoPrintFixer extends AbstractFixer implements ConfigurableFixerInterface
 {
+    /** @use ConfigurableFixerTrait<_Configuration> */
+    use ConfigurableFixerTrait;
+
     /**
      * @var T_ECHO|T_PRINT
      */
     private int $candidateTokenType;
 
-    public function configure(array $configuration): void
+    protected function configurePostNormalisation(): void
     {
-        parent::configure($configuration);
 
         $this->candidateTokenType = 'echo' === $this->configuration['use'] ? T_PRINT : T_ECHO;
     }

diff --git a/src/Fixer/Alias/RandomApiMigrationFixer.php b/src/Fixer/Alias/RandomApiMigrationFixer.php
@@ -16,6 +16,7 @@
 
 use PhpCsFixer\AbstractFunctionReferenceFixer;
 use PhpCsFixer\Fixer\ConfigurableFixerInterface;
+use PhpCsFixer\Fixer\ConfigurableFixerTrait;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolver;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolverInterface;
 use PhpCsFixer\FixerConfiguration\FixerOptionBuilder;
@@ -32,6 +33,9 @@
  */
 final class RandomApiMigrationFixer extends AbstractFunctionReferenceFixer implements ConfigurableFixerInterface
 {
+    /** @use ConfigurableFixerTrait<_Configuration> */
+    use ConfigurableFixerTrait;
+
     /**
      * @var array<string, array<int, int>>
      */
@@ -43,9 +47,8 @@ final class RandomApiMigrationFixer extends AbstractFunctionReferenceFixer imple
         'random_int' => [0, 2],
     ];
 
-    public function configure(array $configuration): void
+    protected function configurePostNormalisation(): void
     {
-        parent::configure($configuration);
 
         foreach ($this->configuration['replacements'] as $functionName => $replacement) {
             $this->configuration['replacements'][$functionName] = [

diff --git a/src/Fixer/ArrayNotation/ArraySyntaxFixer.php b/src/Fixer/ArrayNotation/ArraySyntaxFixer.php
@@ -16,6 +16,7 @@
 
 use PhpCsFixer\AbstractFixer;
 use PhpCsFixer\Fixer\ConfigurableFixerInterface;
+use PhpCsFixer\Fixer\ConfigurableFixerTrait;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolver;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolverInterface;
 use PhpCsFixer\FixerConfiguration\FixerOptionBuilder;
@@ -33,14 +34,16 @@
  */
 final class ArraySyntaxFixer extends AbstractFixer implements ConfigurableFixerInterface
 {
+    /** @use ConfigurableFixerTrait<_Configuration> */
+    use ConfigurableFixerTrait;
+
     /**
      * @var CT::T_ARRAY_SQUARE_BRACE_OPEN|T_ARRAY
      */
     private $candidateTokenKind;
 
-    public function configure(array $configuration): void
+    protected function configurePostNormalisation(): void
     {
-        parent::configure($configuration);
 
         $this->resolveCandidateTokenKind();
     }

diff --git a/src/Fixer/ArrayNotation/NoWhitespaceBeforeCommaInArrayFixer.php b/src/Fixer/ArrayNotation/NoWhitespaceBeforeCommaInArrayFixer.php
@@ -16,6 +16,7 @@
 
 use PhpCsFixer\AbstractFixer;
 use PhpCsFixer\Fixer\ConfigurableFixerInterface;
+use PhpCsFixer\Fixer\ConfigurableFixerTrait;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolver;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolverInterface;
 use PhpCsFixer\FixerConfiguration\FixerOptionBuilder;
@@ -30,6 +31,9 @@
  */
 final class NoWhitespaceBeforeCommaInArrayFixer extends AbstractFixer implements ConfigurableFixerInterface
 {
+    /** @use ConfigurableFixerTrait<_Configuration> */
+    use ConfigurableFixerTrait;
+
     public function getDefinition(): FixerDefinitionInterface
     {
         return new FixerDefinition(

diff --git a/src/Fixer/ArrayNotation/WhitespaceAfterCommaInArrayFixer.php b/src/Fixer/ArrayNotation/WhitespaceAfterCommaInArrayFixer.php
@@ -16,6 +16,7 @@
 
 use PhpCsFixer\AbstractFixer;
 use PhpCsFixer\Fixer\ConfigurableFixerInterface;
+use PhpCsFixer\Fixer\ConfigurableFixerTrait;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolver;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolverInterface;
 use PhpCsFixer\FixerConfiguration\FixerOptionBuilder;
@@ -32,6 +33,9 @@
  */
 final class WhitespaceAfterCommaInArrayFixer extends AbstractFixer implements ConfigurableFixerInterface
 {
+    /** @use ConfigurableFixerTrait<_Configuration> */
+    use ConfigurableFixerTrait;
+
     public function getDefinition(): FixerDefinitionInterface
     {
         return new FixerDefinition(

diff --git a/src/Fixer/AttributeNotation/AttributeEmptyParenthesesFixer.php b/src/Fixer/AttributeNotation/AttributeEmptyParenthesesFixer.php
@@ -16,6 +16,7 @@
 
 use PhpCsFixer\AbstractFixer;
 use PhpCsFixer\Fixer\ConfigurableFixerInterface;
+use PhpCsFixer\Fixer\ConfigurableFixerTrait;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolver;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolverInterface;
 use PhpCsFixer\FixerConfiguration\FixerOptionBuilder;
@@ -31,6 +32,9 @@
  */
 final class AttributeEmptyParenthesesFixer extends AbstractFixer implements ConfigurableFixerInterface
 {
+    /** @use ConfigurableFixerTrait<_Configuration> */
+    use ConfigurableFixerTrait;
+
     public function getDefinition(): FixerDefinitionInterface
     {
         return new FixerDefinition(

diff --git a/src/Fixer/AttributeNotation/OrderedAttributesFixer.php b/src/Fixer/AttributeNotation/OrderedAttributesFixer.php
@@ -17,6 +17,7 @@
 use PhpCsFixer\AbstractFixer;
 use PhpCsFixer\ConfigurationException\InvalidFixerConfigurationException;
 use PhpCsFixer\Fixer\ConfigurableFixerInterface;
+use PhpCsFixer\Fixer\ConfigurableFixerTrait;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolver;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolverInterface;
 use PhpCsFixer\FixerConfiguration\FixerOptionBuilder;
@@ -41,6 +42,9 @@
  */
 final class OrderedAttributesFixer extends AbstractFixer implements ConfigurableFixerInterface
 {
+    /** @use ConfigurableFixerTrait<_Configuration> */
+    use ConfigurableFixerTrait;
+
     public const ORDER_ALPHA = 'alpha';
     public const ORDER_CUSTOM = 'custom';
 

diff --git a/src/Fixer/Basic/BracesFixer.php b/src/Fixer/Basic/BracesFixer.php
@@ -16,6 +16,7 @@
 
 use PhpCsFixer\AbstractProxyFixer;
 use PhpCsFixer\Fixer\ConfigurableFixerInterface;
+use PhpCsFixer\Fixer\ConfigurableFixerTrait;
 use PhpCsFixer\Fixer\ControlStructure\ControlStructureBracesFixer;
 use PhpCsFixer\Fixer\ControlStructure\ControlStructureContinuationPositionFixer;
 use PhpCsFixer\Fixer\DeprecatedFixerInterface;
@@ -40,6 +41,9 @@
  */
 final class BracesFixer extends AbstractProxyFixer implements ConfigurableFixerInterface, WhitespacesAwareFixerInterface, DeprecatedFixerInterface
 {
+    /** @use ConfigurableFixerTrait<_Configuration> */
+    use ConfigurableFixerTrait;
+
     /**
      * @internal
      */
@@ -152,10 +156,8 @@ public function getSuccessorsNames(): array
         return array_keys($this->proxyFixers);
     }
 
-    public function configure(array $configuration): void
+    protected function configurePostNormalisation(): void
     {
-        parent::configure($configuration);
-
         $this->getBracesPositionFixer()->configure([
             'control_structures_opening_brace' => $this->translatePositionOption($this->configuration['position_after_control_structures']),
             'functions_opening_brace' => $this->translatePositionOption($this->configuration['position_after_functions_and_oop_constructs']),

diff --git a/src/Fixer/Basic/BracesPositionFixer.php b/src/Fixer/Basic/BracesPositionFixer.php
@@ -16,6 +16,7 @@
 
 use PhpCsFixer\AbstractFixer;
 use PhpCsFixer\Fixer\ConfigurableFixerInterface;
+use PhpCsFixer\Fixer\ConfigurableFixerTrait;
 use PhpCsFixer\Fixer\Indentation;
 use PhpCsFixer\Fixer\WhitespacesAwareFixerInterface;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolver;
@@ -30,8 +31,25 @@
 use PhpCsFixer\Tokenizer\Tokens;
 use PhpCsFixer\Tokenizer\TokensAnalyzer;
 
+/**
+ * @phpstan-type _Configuration array{
+ *  control_structures_opening_brace: 'next_line_unless_newline_at_signature_end'|'same_line'
+ *  functions_opening_brace: 'next_line_unless_newline_at_signature_end'|'same_line'
+ *  anonymous_functions_opening_brace: 'next_line_unless_newline_at_signature_end'|'same_line'
+ *  classes_opening_brace: 'next_line_unless_newline_at_signature_end'|'same_line'
+ *  anonymous_classes_opening_brace: 'next_line_unless_newline_at_signature_end'|'same_line'
+ *  allow_single_line_empty_anonymous_classes: bool,
+ *  allow_single_line_anonymous_functions: bool,
+ * }
+ * @implements ConfigurableFixerInterface<_Configuration>
+ */
 final class BracesPositionFixer extends AbstractFixer implements ConfigurableFixerInterface, WhitespacesAwareFixerInterface
 {
+    /** @use ConfigurableFixerTrait<_Configuration> */
+    use ConfigurableFixerTrait;
+        /** @use ConfigurableFixerTrait<_Configuration> */
+        use ConfigurableFixerTrait;
+
     use Indentation;
 
     /**
@@ -338,7 +356,8 @@ protected function applyFix(\SplFileInfo $file, Tokens $tokens): void
         }
     }
 
-    protected function createConfigurationDefinition(): FixerConfigurationResolverInterface
+    /** @protected */
+    public function createConfigurationDefinition(): FixerConfigurationResolverInterface
     {
         return new FixerConfigurationResolver([
             (new FixerOptionBuilder('control_structures_opening_brace', 'The position of the opening brace of control structures‘ body.'))

diff --git a/src/Fixer/Basic/CurlyBracesPositionFixer.php b/src/Fixer/Basic/CurlyBracesPositionFixer.php
@@ -16,6 +16,7 @@
 
 use PhpCsFixer\AbstractProxyFixer;
 use PhpCsFixer\Fixer\ConfigurableFixerInterface;
+use PhpCsFixer\Fixer\ConfigurableFixerTrait;
 use PhpCsFixer\Fixer\DeprecatedFixerInterface;
 use PhpCsFixer\Fixer\Indentation;
 use PhpCsFixer\Fixer\WhitespacesAwareFixerInterface;
@@ -25,9 +26,23 @@
 
 /**
  * @deprecated
+ * 
+ * @phpstan-type _Configuration array{
+ *  control_structures_opening_brace: 'next_line_unless_newline_at_signature_end'|'same_line'
+ *  functions_opening_brace: 'next_line_unless_newline_at_signature_end'|'same_line'
+ *  anonymous_functions_opening_brace: 'next_line_unless_newline_at_signature_end'|'same_line'
+ *  classes_opening_brace: 'next_line_unless_newline_at_signature_end'|'same_line'
+ *  anonymous_classes_opening_brace: 'next_line_unless_newline_at_signature_end'|'same_line'
+ *  allow_single_line_empty_anonymous_classes: bool,
+ *  allow_single_line_anonymous_functions: bool,
+ * }
+ * @implements ConfigurableFixerInterface<_Configuration>
  */
 final class CurlyBracesPositionFixer extends AbstractProxyFixer implements ConfigurableFixerInterface, DeprecatedFixerInterface, WhitespacesAwareFixerInterface
 {
+    /** @use ConfigurableFixerTrait<_Configuration> */
+    use ConfigurableFixerTrait;
+
     use Indentation;
 
     /**
@@ -61,11 +76,9 @@ public function getDefinition(): FixerDefinitionInterface
         );
     }
 
-    public function configure(array $configuration): void
+    protected function configurePreNormalisation(array $configuration): void
     {
         $this->bracesPositionFixer->configure($configuration);
-
-        parent::configure($configuration);
     }
 
     /**

diff --git a/src/Fixer/Basic/NoTrailingCommaInSinglelineFixer.php b/src/Fixer/Basic/NoTrailingCommaInSinglelineFixer.php
@@ -16,6 +16,7 @@
 
 use PhpCsFixer\AbstractFixer;
 use PhpCsFixer\Fixer\ConfigurableFixerInterface;
+use PhpCsFixer\Fixer\ConfigurableFixerTrait;
 use PhpCsFixer\FixerConfiguration\AllowedValueSubset;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolver;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolverInterface;
@@ -29,6 +30,9 @@
 
 final class NoTrailingCommaInSinglelineFixer extends AbstractFixer implements ConfigurableFixerInterface
 {
+    /** @use ConfigurableFixerTrait<_Configuration> */
+    use ConfigurableFixerTrait;
+
     public function getDefinition(): FixerDefinitionInterface
     {
         return new FixerDefinition(

diff --git a/src/Fixer/Basic/NonPrintableCharacterFixer.php b/src/Fixer/Basic/NonPrintableCharacterFixer.php
@@ -16,6 +16,7 @@
 
 use PhpCsFixer\AbstractFixer;
 use PhpCsFixer\Fixer\ConfigurableFixerInterface;
+use PhpCsFixer\Fixer\ConfigurableFixerTrait;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolver;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolverInterface;
 use PhpCsFixer\FixerConfiguration\FixerOptionBuilder;
@@ -33,6 +34,9 @@
  */
 final class NonPrintableCharacterFixer extends AbstractFixer implements ConfigurableFixerInterface
 {
+    /** @use ConfigurableFixerTrait<_Configuration> */
+    use ConfigurableFixerTrait;
+
     /**
      * @var array<string, array{string, string}>
      */