MultilinePromotedPropertiesFixer - add option "keep_blank_lines" (#874)

Author: gharlan

README.md

@@ -3,7 +3,7 @@
 [![Latest stable version](https://img.shields.io/packagist/v/kubawerlos/php-cs-fixer-custom-fixers.svg?label=current%20version)](https://packagist.org/packages/kubawerlos/php-cs-fixer-custom-fixers)
 [![PHP version](https://img.shields.io/packagist/php-v/kubawerlos/php-cs-fixer-custom-fixers.svg)](https://php.net)
 [![License](https://img.shields.io/github/license/kubawerlos/php-cs-fixer-custom-fixers.svg)](LICENSE)
-![Tests](https://img.shields.io/badge/tests-3409-brightgreen.svg)
+![Tests](https://img.shields.io/badge/tests-3411-brightgreen.svg)
 [![Downloads](https://img.shields.io/packagist/dt/kubawerlos/php-cs-fixer-custom-fixers.svg)](https://packagist.org/packages/kubawerlos/php-cs-fixer-custom-fixers)
 
 [![CI Status](https://github.com/kubawerlos/php-cs-fixer-custom-fixers/workflows/CI/badge.svg?branch=main)](https://github.com/kubawerlos/php-cs-fixer-custom-fixers/actions)
@@ -170,6 +170,7 @@ Multiline comments or PHPDocs must contain an opening and closing line with no a
 A constructor with promoted properties must have them in separate lines.
 Configuration options:
 - `minimum_number_of_parameters` (`int`): minimum number of parameters in the constructor to fix; defaults to `1`
+- `keep_blank_lines` (`bool`): whether to keep blank lines between properties; defaults to `false`
 ```diff
  <?php class Foo {
 -    public function __construct(private array $a, private bool $b, private int $i) {}

src/Fixer/MultilinePromotedPropertiesFixer.php

@@ -29,6 +29,7 @@
 final class MultilinePromotedPropertiesFixer extends AbstractFixer implements ConfigurableFixerInterface, WhitespacesAwareFixerInterface
 {
     private int $minimumNumberOfParameters = 1;
+    private bool $keepBlankLines = false;
     private WhitespacesFixerConfig $whitespacesConfig;
 
     public function getDefinition(): FixerDefinitionInterface
@@ -54,17 +55,24 @@ public function getConfigurationDefinition(): FixerConfigurationResolverInterfac
                 ->setAllowedTypes(['int'])
                 ->setDefault($this->minimumNumberOfParameters)
                 ->getOption(),
+            (new FixerOptionBuilder('keep_blank_lines', 'whether to keep blank lines between properties'))
+                ->setAllowedTypes(['bool'])
+                ->setDefault($this->keepBlankLines)
+                ->getOption(),
         ]);
     }
 
     /**
-     * @param array<string, int> $configuration
+     * @param array{minimum_number_of_parameters?: int, keep_blank_lines?: bool} $configuration
      */
     public function configure(array $configuration): void
     {
         if (\array_key_exists('minimum_number_of_parameters', $configuration)) {
             $this->minimumNumberOfParameters = $configuration['minimum_number_of_parameters'];
         }
+        if (\array_key_exists('keep_blank_lines', $configuration)) {
+            $this->keepBlankLines = $configuration['keep_blank_lines'];
+        }
     }
 
     public function setWhitespacesConfig(WhitespacesFixerConfig $config): void
@@ -170,11 +178,20 @@ private function fixParameters(Tokens $tokens, int $openParenthesis, int $closeP
                 continue;
             }
 
-            $tokens->ensureWhitespaceAtIndex(
-                $index + 1,
-                0,
-                $this->whitespacesConfig->getLineEnding() . $indent . $this->whitespacesConfig->getIndent(),
-            );
+            $this->fixParameter($tokens, $index + 1, $indent);
         }
     }
+
+    private function fixParameter(Tokens $tokens, int $index, string $indent): void
+    {
+        if ($this->keepBlankLines && $tokens[$index]->isWhitespace() && \str_contains($tokens[$index]->getContent(), "\n")) {
+            return;
+        }
+
+        $tokens->ensureWhitespaceAtIndex(
+            $index,
+            0,
+            $this->whitespacesConfig->getLineEnding() . $indent . $this->whitespacesConfig->getIndent(),
+        );
+    }
 }

tests/Fixer/MultilinePromotedPropertiesFixerTest.php

@@ -33,6 +33,8 @@ public function testConfiguration(): void
         self::assertArrayHasKey(0, $options);
         self::assertSame('minimum_number_of_parameters', $options[0]->getName());
         self::assertSame(1, $options[0]->getDefault());
+        self::assertSame('keep_blank_lines', $options[1]->getName());
+        self::assertFalse($options[1]->getDefault());
     }
 
     public function testIsRisky(): void
@@ -51,7 +53,7 @@ public function testFix(string $expected, ?string $input = null, array $configur
     }
 
     /**
-     * @return iterable<array{0: string, 1: null|string, 2?: array<string, int>}>
+     * @return iterable<array{0: string, 1: null|string, 2?: array<string, bool|int>}>
      */
     public static function provideFixCases(): iterable
     {
@@ -219,5 +221,43 @@ public function __construct(int $x, int $y) {}
                 ['minimum_number_of_parameters' => $numberOfParameters],
             ];
         }
+
+        yield 'blank lines removed' => [
+            '<?php class Foo {
+                public function __construct(
+                    private int $x,
+                    private int $y,
+                    private int $z
+                ) {}
+            }',
+            '<?php class Foo {
+                public function __construct(
+                    private int $x,
+
+                    private int $y,
+
+                    private int $z
+                ) {}
+            }',
+        ];
+
+        yield 'blank lines kept' => [
+            '<?php class Foo {
+                public function __construct(
+                    private int $x,
+                    private int $y,
+
+                    private int $z
+                ) {}
+            }',
+            '<?php class Foo {
+                public function __construct(
+                    private int $x, private int $y,
+
+                    private int $z
+                ) {}
+            }',
+            ['keep_blank_lines' => true],
+        ];
     }
 }