Back to Php Cs Fixer

Rule ``no_trailing_comma_in_singleline``

doc/rules/basic/no_trailing_comma_in_singleline.rst

3.95.11.7 KB
Original Source

======================================== 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.

Warning

This rule is CONFIGURABLE


You can configure this rule using the following option: ``elements``.

Configuration
-------------

``elements``
~~~~~~~~~~~~

Which elements to fix.

Allowed values: a subset of ``['arguments', 'array', 'array_destructuring', 'group_import']``

Default value: ``['arguments', 'array', 'array_destructuring', '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 <./../../ruleSets/PhpCsFixer.rst>`_
- `@Symfony <./../../ruleSets/Symfony.rst>`_

References
----------

- Fixer class: `PhpCsFixer\\Fixer\\Basic\\NoTrailingCommaInSinglelineFixer <./../../../src/Fixer/Basic/NoTrailingCommaInSinglelineFixer.php>`_
- Test class: `PhpCsFixer\\Tests\\Fixer\\Basic\\NoTrailingCommaInSinglelineFixerTest <./../../../tests/Fixer/Basic/NoTrailingCommaInSinglelineFixerTest.php>`_

The test class defines officially supported behaviour. Each test case is a part of our backward compatibility promise.