feature: NoTrailingCommaInSinglelineFixer - Introduction (#6529)

Author: SpacePossum

doc/list.rst

@@ -1601,21 +1601,36 @@ List of Available Rules
 
    Remove trailing commas in list function calls.
 
-   Part of rule sets `@PhpCsFixer <./ruleSets/PhpCsFixer.rst>`_ `@Symfony <./ruleSets/Symfony.rst>`_
+   *warning deprecated*   Use ``no_trailing_comma_in_singleline`` instead.
 
    `Source PhpCsFixer\\Fixer\\ControlStructure\\NoTrailingCommaInListCallFixer <./../src/Fixer/ControlStructure/NoTrailingCommaInListCallFixer.php>`_
+-  `no_trailing_comma_in_singleline <./rules/basic/no_trailing_comma_in_singleline.rst>`_
+
+   If a list of values separated by a comma is contained on a single line, then the last item MUST NOT have a trailing comma.
+
+   Configuration options:
+
+   - | ``elements``
+     | Which elements to fix.
+     | Allowed values: a subset of ``['arguments', 'array_destructuring', 'array', 'group_import']``
+     | Default value: ``['arguments', 'array_destructuring', 'array', 'group_import']``
+
+
+   Part of rule sets `@PhpCsFixer <./ruleSets/PhpCsFixer.rst>`_ `@Symfony <./ruleSets/Symfony.rst>`_
+
+   `Source PhpCsFixer\\Fixer\\Basic\\NoTrailingCommaInSinglelineFixer <./../src/Fixer/Basic/NoTrailingCommaInSinglelineFixer.php>`_
 -  `no_trailing_comma_in_singleline_array <./rules/array_notation/no_trailing_comma_in_singleline_array.rst>`_
 
    PHP single-line arrays should not have trailing comma.
 
-   Part of rule sets `@PhpCsFixer <./ruleSets/PhpCsFixer.rst>`_ `@Symfony <./ruleSets/Symfony.rst>`_
+   *warning deprecated*   Use ``no_trailing_comma_in_singleline`` instead.
 
    `Source PhpCsFixer\\Fixer\\ArrayNotation\\NoTrailingCommaInSinglelineArrayFixer <./../src/Fixer/ArrayNotation/NoTrailingCommaInSinglelineArrayFixer.php>`_
 -  `no_trailing_comma_in_singleline_function_call <./rules/function_notation/no_trailing_comma_in_singleline_function_call.rst>`_
 
    When making a method or function call on a single line there MUST NOT be a trailing comma after the last argument.
 
-   Part of rule sets `@PhpCsFixer <./ruleSets/PhpCsFixer.rst>`_ `@Symfony <./ruleSets/Symfony.rst>`_
+   *warning deprecated*   Use ``no_trailing_comma_in_singleline`` instead.
 
    `Source PhpCsFixer\\Fixer\\FunctionNotation\\NoTrailingCommaInSinglelineFunctionCallFixer <./../src/Fixer/FunctionNotation/NoTrailingCommaInSinglelineFunctionCallFixer.php>`_
 -  `no_trailing_whitespace <./rules/whitespace/no_trailing_whitespace.rst>`_

doc/ruleSets/Symfony.rst

@@ -68,9 +68,7 @@ Rules
 - `no_superfluous_phpdoc_tags <./../rules/phpdoc/no_superfluous_phpdoc_tags.rst>`_
   config:
   ``['allow_mixed' => true, 'allow_unused_params' => true]``
-- `no_trailing_comma_in_list_call <./../rules/control_structure/no_trailing_comma_in_list_call.rst>`_
-- `no_trailing_comma_in_singleline_array <./../rules/array_notation/no_trailing_comma_in_singleline_array.rst>`_
-- `no_trailing_comma_in_singleline_function_call <./../rules/function_notation/no_trailing_comma_in_singleline_function_call.rst>`_
+- `no_trailing_comma_in_singleline <./../rules/basic/no_trailing_comma_in_singleline.rst>`_
 - `no_unneeded_control_parentheses <./../rules/control_structure/no_unneeded_control_parentheses.rst>`_
   config:
   ``['statements' => ['break', 'clone', 'continue', 'echo_print', 'others', 'return', 'switch_case', 'yield', 'yield_from']]``

doc/rules/array_notation/no_trailing_comma_in_singleline_array.rst

@@ -4,6 +4,14 @@ Rule ``no_trailing_comma_in_singleline_array``
 
 PHP single-line arrays should not have trailing comma.
 
+Warning
+-------
+
+This rule is deprecated and will be removed on next major version
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+You should use ``no_trailing_comma_in_singleline`` instead.
+
 Examples
 --------
 
@@ -17,14 +25,3 @@ Example #1
     <?php
    -$a = array('sample',  );
    +$a = array('sample');
-
-Rule sets
----------
-
-The rule is part of the following rule sets:
-
-@PhpCsFixer
-  Using the `@PhpCsFixer <./../../ruleSets/PhpCsFixer.rst>`_ rule set will enable the ``no_trailing_comma_in_singleline_array`` rule.
-
-@Symfony
-  Using the `@Symfony <./../../ruleSets/Symfony.rst>`_ rule set will enable the ``no_trailing_comma_in_singleline_array`` rule.

doc/rules/basic/no_trailing_comma_in_singleline.rst

@@ -0,0 +1,65 @@
+========================================
+Rule ``no_trailing_comma_in_singleline``
+========================================
+
+If a list of values separated by a comma is contained on a single line, then the
+last item MUST NOT have a trailing comma.
+
+Configuration
+-------------
+
+``elements``
+~~~~~~~~~~~~
+
+Which elements to fix.
+
+Allowed values: a subset of ``['arguments', 'array_destructuring', 'array', 'group_import']``
+
+Default value: ``['arguments', 'array_destructuring', 'array', 'group_import']``
+
+Examples
+--------
+
+Example #1
+~~~~~~~~~~
+
+*Default* configuration.
+
+.. code-block:: diff
+
+   --- Original
+   +++ New
+    <?php
+   -foo($a,);
+   -$foo = array(1,);
+   -[$foo, $bar,] = $array;
+   -use a\{ClassA, ClassB,};
+   +foo($a);
+   +$foo = array(1);
+   +[$foo, $bar] = $array;
+   +use a\{ClassA, ClassB};
+
+Example #2
+~~~~~~~~~~
+
+With configuration: ``['elements' => ['array_destructuring']]``.
+
+.. code-block:: diff
+
+   --- Original
+   +++ New
+    <?php
+    foo($a,);
+   -[$foo, $bar,] = $array;
+   +[$foo, $bar] = $array;
+
+Rule sets
+---------
+
+The rule is part of the following rule sets:
+
+@PhpCsFixer
+  Using the `@PhpCsFixer <./../../ruleSets/PhpCsFixer.rst>`_ rule set will enable the ``no_trailing_comma_in_singleline`` rule with the default config.
+
+@Symfony
+  Using the `@Symfony <./../../ruleSets/Symfony.rst>`_ rule set will enable the ``no_trailing_comma_in_singleline`` rule with the default config.

doc/rules/control_structure/no_trailing_comma_in_list_call.rst

@@ -4,6 +4,14 @@ Rule ``no_trailing_comma_in_list_call``
 
 Remove trailing commas in list function calls.
 
+Warning
+-------
+
+This rule is deprecated and will be removed on next major version
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+You should use ``no_trailing_comma_in_singleline`` instead.
+
 Examples
 --------
 
@@ -17,14 +25,3 @@ Example #1
     <?php
    -list($a, $b,) = foo();
    +list($a, $b) = foo();
-
-Rule sets
----------
-
-The rule is part of the following rule sets:
-
-@PhpCsFixer
-  Using the `@PhpCsFixer <./../../ruleSets/PhpCsFixer.rst>`_ rule set will enable the ``no_trailing_comma_in_list_call`` rule.
-
-@Symfony
-  Using the `@Symfony <./../../ruleSets/Symfony.rst>`_ rule set will enable the ``no_trailing_comma_in_list_call`` rule.

doc/rules/function_notation/no_trailing_comma_in_singleline_function_call.rst

@@ -5,6 +5,14 @@ Rule ``no_trailing_comma_in_singleline_function_call``
 When making a method or function call on a single line there MUST NOT be a
 trailing comma after the last argument.
 
+Warning
+-------
+
+This rule is deprecated and will be removed on next major version
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+You should use ``no_trailing_comma_in_singleline`` instead.
+
 Examples
 --------
 
@@ -18,14 +26,3 @@ Example #1
     <?php
    -foo($a,);
    +foo($a);
-
-Rule sets
----------
-
-The rule is part of the following rule sets:
-
-@PhpCsFixer
-  Using the `@PhpCsFixer <./../../ruleSets/PhpCsFixer.rst>`_ rule set will enable the ``no_trailing_comma_in_singleline_function_call`` rule.
-
-@Symfony
-  Using the `@Symfony <./../../ruleSets/Symfony.rst>`_ rule set will enable the ``no_trailing_comma_in_singleline_function_call`` rule.

doc/rules/index.rst

@@ -48,7 +48,7 @@ Array Notation
 - `no_multiline_whitespace_around_double_arrow <./array_notation/no_multiline_whitespace_around_double_arrow.rst>`_
 
   Operator ``=>`` should not be surrounded by multi-line whitespaces.
-- `no_trailing_comma_in_singleline_array <./array_notation/no_trailing_comma_in_singleline_array.rst>`_
+- `no_trailing_comma_in_singleline_array <./array_notation/no_trailing_comma_in_singleline_array.rst>`_ *(deprecated)*
 
   PHP single-line arrays should not have trailing comma.
 - `no_whitespace_before_comma_in_array <./array_notation/no_whitespace_before_comma_in_array.rst>`_
@@ -79,6 +79,9 @@ Basic
 - `no_multiple_statements_per_line <./basic/no_multiple_statements_per_line.rst>`_
 
   There must not be more than one statement per line.
+- `no_trailing_comma_in_singleline <./basic/no_trailing_comma_in_singleline.rst>`_
+
+  If a list of values separated by a comma is contained on a single line, then the last item MUST NOT have a trailing comma.
 - `non_printable_character <./basic/non_printable_character.rst>`_ *(risky)*
 
   Remove Zero-width space (ZWSP), Non-breaking space (NBSP) and other invisible unicode symbols.
@@ -269,7 +272,7 @@ Control Structure
 - `no_superfluous_elseif <./control_structure/no_superfluous_elseif.rst>`_
 
   Replaces superfluous ``elseif`` with ``if``.
-- `no_trailing_comma_in_list_call <./control_structure/no_trailing_comma_in_list_call.rst>`_
+- `no_trailing_comma_in_list_call <./control_structure/no_trailing_comma_in_list_call.rst>`_ *(deprecated)*
 
   Remove trailing commas in list function calls.
 - `no_unneeded_control_parentheses <./control_structure/no_unneeded_control_parentheses.rst>`_
@@ -352,7 +355,7 @@ Function Notation
 - `no_spaces_after_function_name <./function_notation/no_spaces_after_function_name.rst>`_
 
   When making a method or function call, there MUST NOT be a space between the method or function name and the opening parenthesis.
-- `no_trailing_comma_in_singleline_function_call <./function_notation/no_trailing_comma_in_singleline_function_call.rst>`_
+- `no_trailing_comma_in_singleline_function_call <./function_notation/no_trailing_comma_in_singleline_function_call.rst>`_ *(deprecated)*
 
   When making a method or function call on a single line there MUST NOT be a trailing comma after the last argument.
 - `no_unreachable_default_argument_value <./function_notation/no_unreachable_default_argument_value.rst>`_ *(risky)*

src/Fixer/ArrayNotation/NoTrailingCommaInSinglelineArrayFixer.php

@@ -14,19 +14,20 @@
 
 namespace PhpCsFixer\Fixer\ArrayNotation;
 
-use PhpCsFixer\AbstractFixer;
+use PhpCsFixer\AbstractProxyFixer;
+use PhpCsFixer\Fixer\Basic\NoTrailingCommaInSinglelineFixer;
+use PhpCsFixer\Fixer\DeprecatedFixerInterface;
 use PhpCsFixer\FixerDefinition\CodeSample;
 use PhpCsFixer\FixerDefinition\FixerDefinition;
 use PhpCsFixer\FixerDefinition\FixerDefinitionInterface;
-use PhpCsFixer\Tokenizer\CT;
-use PhpCsFixer\Tokenizer\Tokens;
-use PhpCsFixer\Tokenizer\TokensAnalyzer;
 
 /**
+ * @deprecated
+ *
  * @author Dariusz Rumiński <[email protected]>
  * @author Sebastiaan Stok <[email protected]>
  */
-final class NoTrailingCommaInSinglelineArrayFixer extends AbstractFixer
+final class NoTrailingCommaInSinglelineArrayFixer extends AbstractProxyFixer implements DeprecatedFixerInterface
 {
     /**
      * {@inheritdoc}
@@ -42,48 +43,19 @@ public function getDefinition(): FixerDefinitionInterface
     /**
      * {@inheritdoc}
      */
-    public function isCandidate(Tokens $tokens): bool
+    public function getSuccessorsNames(): array
     {
-        return $tokens->isAnyTokenKindsFound([T_ARRAY, CT::T_ARRAY_SQUARE_BRACE_OPEN]);
+        return array_keys($this->proxyFixers);
     }
 
     /**
      * {@inheritdoc}
      */
-    protected function applyFix(\SplFileInfo $file, Tokens $tokens): void
-    {
-        $tokensAnalyzer = new TokensAnalyzer($tokens);
-
-        for ($index = 0, $c = $tokens->count(); $index < $c; ++$index) {
-            if ($tokensAnalyzer->isArray($index)) {
-                $this->fixArray($tokens, $index);
-            }
-        }
-    }
-
-    private function fixArray(Tokens $tokens, int $index): void
+    protected function createProxyFixers(): array
     {
-        $tokensAnalyzer = new TokensAnalyzer($tokens);
-
-        if ($tokensAnalyzer->isArrayMultiLine($index)) {
-            return;
-        }
-
-        $startIndex = $index;
-
-        if ($tokens[$startIndex]->isGivenKind(T_ARRAY)) {
-            $startIndex = $tokens->getNextTokenOfKind($startIndex, ['(']);
-            $endIndex = $tokens->findBlockEnd(Tokens::BLOCK_TYPE_PARENTHESIS_BRACE, $startIndex);
-        } else {
-            $endIndex = $tokens->findBlockEnd(Tokens::BLOCK_TYPE_ARRAY_SQUARE_BRACE, $startIndex);
-        }
-
-        $beforeEndIndex = $tokens->getPrevMeaningfulToken($endIndex);
-        $beforeEndToken = $tokens[$beforeEndIndex];
+        $fixer = new NoTrailingCommaInSinglelineFixer();
+        $fixer->configure(['elements' => ['array']]);
 
-        if ($beforeEndToken->equals(',')) {
-            $tokens->removeTrailingWhitespace($beforeEndIndex);
-            $tokens->clearAt($beforeEndIndex);
-        }
+        return [$fixer];
     }
 }