Deprecate NumericLiteralSeparatorFixer (#949)

Author: kubawerlos

CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG for PHP CS Fixer: custom fixers
 
+## v3.19.0
+- Deprecate NumericLiteralSeparatorFixer - use "numeric_literal_separator "
+- Update minimum PHP CS Fixer version to 3.47.0
+
 ## v3.18.0
 - Add PhpdocTypeListFixer
 

README.md

@@ -5,7 +5,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-3525-brightgreen.svg)
+![Tests](https://img.shields.io/badge/tests-3526-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/actions/workflows/ci.yaml/badge.svg)](https://github.com/kubawerlos/php-cs-fixer-custom-fixers/actions/workflows/ci.yaml)
@@ -385,6 +385,7 @@ Functions `strlen` and `mb_strlen` must not be compared to 0.
 
 #### NumericLiteralSeparatorFixer
 Numeric literals must have configured separators.
+  DEPRECATED: use `numeric_literal_separator` instead.
 Configuration options:
 - `binary` (`bool`, `null`): whether add, remove or ignore separators in binary numbers.; defaults to `false`
 - `decimal` (`bool`, `null`): whether add, remove or ignore separators in decimal numbers.; defaults to `false`

composer.json

@@ -13,7 +13,7 @@
         "php": "^7.4 || ^8.0",
         "ext-filter": "*",
         "ext-tokenizer": "*",
-        "friendsofphp/php-cs-fixer": "^3.22"
+        "friendsofphp/php-cs-fixer": "^3.47"
     },
     "require-dev": {
         "phpunit/phpunit": "^9.6.4 || ^10.0.14"

src/Fixer/NumericLiteralSeparatorFixer.php

@@ -11,7 +11,9 @@
 
 namespace PhpCsFixerCustomFixers\Fixer;
 
+use PhpCsFixer\Fixer\Basic\NumericLiteralSeparatorFixer as NLSFixer;
 use PhpCsFixer\Fixer\ConfigurableFixerInterface;
+use PhpCsFixer\Fixer\DeprecatedFixerInterface;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolver;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolverInterface;
 use PhpCsFixer\FixerConfiguration\FixerOptionBuilder;
@@ -23,7 +25,10 @@
 use PhpCsFixer\Tokenizer\Token;
 use PhpCsFixer\Tokenizer\Tokens;
 
-final class NumericLiteralSeparatorFixer extends AbstractFixer implements ConfigurableFixerInterface
+/**
+ * @deprecated
+ */
+final class NumericLiteralSeparatorFixer extends AbstractFixer implements ConfigurableFixerInterface, DeprecatedFixerInterface
 {
     private ?bool $binarySeparator = false;
     private ?bool $decimalSeparator = false;
@@ -121,6 +126,14 @@ public function fix(\SplFileInfo $file, Tokens $tokens): void
         }
     }
 
+    /**
+     * @return list<string>
+     */
+    public function getSuccessorsNames(): array
+    {
+        return [(new NLSFixer())->getName()];
+    }
+
     private function getNewContent(string $content): string
     {
         if (\strpos($content, '.') !== false) {

tests/Fixer/NumericLiteralSeparatorFixerTest.php

@@ -40,6 +40,11 @@ public function testConfiguration(): void
         self::assertSame('octal', $options[4]->getName());
     }
 
+    public function testSuccessorName(): void
+    {
+        self::assertSuccessorName('numeric_literal_separator');
+    }
+
     public function testReversingCodeSample(): void
     {
         $fixer = self::getFixer();