Add PhpdocTagNoNamedArgumentsFixer (#1032)

Author: kubawerlos

.php-cs-fixer.php

@@ -19,6 +19,7 @@
 use PhpCsFixerConfig\Rules\LibraryRules;
 use PhpCsFixerCustomFixers\Fixer\NoSuperfluousConcatenationFixer;
 use PhpCsFixerCustomFixers\Fixer\PhpdocOnlyAllowedAnnotationsFixer;
+use PhpCsFixerCustomFixers\Fixer\PhpdocTagNoNamedArgumentsFixer;
 use PhpCsFixerCustomFixers\Fixer\PromotedConstructorPropertyFixer;
 use PhpCsFixerCustomFixers\Fixer\TypedClassConstantFixer;
 use PhpCsFixerCustomFixers\Fixers;
@@ -57,6 +58,7 @@
 unset($rules[PromotedConstructorPropertyFixer::name()]); // TODO: remove when dropping support to PHP <8.0
 unset($rules[TypedClassConstantFixer::name()]); // TODO: remove when dropping support to PHP <8.3
 $rules['trailing_comma_in_multiline'] = ['after_heredoc' => true, 'elements' => ['arguments', 'arrays']]; // TODO: remove when dropping support to PHP <8.0
+$rules[PhpdocTagNoNamedArgumentsFixer::name()] = ['directory' => __DIR__ . '/src/'];
 
 $rules[PhpdocOnlyAllowedAnnotationsFixer::name()]['elements'][] = 'phpstan-type';
 

CHANGELOG.md

@@ -1,5 +1,8 @@
 # CHANGELOG for PHP CS Fixer: custom fixers
 
+## v3.27.0
+- Add PhpdocTagNoNamedArgumentsFixer
+
 ## v3.26.0
 - Add TypedClassConstantFixer
 

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-3750-brightgreen.svg)
+![Tests](https://img.shields.io/badge/tests-3788-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)
@@ -610,6 +610,23 @@ The `@var` annotation must be on a single line if it is the only content.
  }
 ```
 
+#### PhpdocTagNoNamedArgumentsFixer
+There must be `@no-named-arguments` tag in PHPDoc of a class/enum/interface/trait.
+Configuration options:
+- `description` (`string`): description of the tag; defaults to `''`
+- `directory` (`string`): directory in which apply the changes, empty value will result with current working directory (result of `getcwd` call); defaults to `''`
+```diff
+ <?php
++
++/**
++ * @no-named-arguments
++ */
+ class Foo
+ {
+     public function bar(string $s) {}
+ }
+```
+
 #### PhpdocTypeListFixer
 PHPDoc type `list` must be used instead of `array` without a key type.
   DEPRECATED: use `phpdoc_list_type` instead.

src/Fixer/AbstractFixer.php

@@ -14,6 +14,9 @@
 use PhpCsFixer\Fixer\FixerInterface;
 use PhpCsFixer\Preg;
 
+/**
+ * @no-named-arguments
+ */
 abstract class AbstractFixer implements FixerInterface
 {
     final public static function name(): string

src/Fixer/AbstractTypesFixer.php

@@ -15,6 +15,9 @@
 use PhpCsFixer\Tokenizer\Token;
 use PhpCsFixer\Tokenizer\Tokens;
 
+/**
+ * @no-named-arguments
+ */
 abstract class AbstractTypesFixer extends AbstractFixer
 {
     final public function isCandidate(Tokens $tokens): bool

src/Fixer/ClassConstantUsageFixer.php

@@ -17,6 +17,9 @@
 use PhpCsFixer\Tokenizer\Token;
 use PhpCsFixer\Tokenizer\Tokens;
 
+/**
+ * @no-named-arguments
+ */
 final class ClassConstantUsageFixer extends AbstractFixer
 {
     public function getDefinition(): FixerDefinitionInterface

src/Fixer/CommentSurroundedBySpacesFixer.php

@@ -18,6 +18,9 @@
 use PhpCsFixer\Tokenizer\Token;
 use PhpCsFixer\Tokenizer\Tokens;
 
+/**
+ * @no-named-arguments
+ */
 final class CommentSurroundedBySpacesFixer extends AbstractFixer
 {
     public function getDefinition(): FixerDefinitionInterface

src/Fixer/CommentedOutFunctionFixer.php

@@ -29,6 +29,8 @@
  *
  * @phpstan-type _InputConfig array{functions?: list<string>}
  * @phpstan-type _Config array{functions: list<string>}
+ *
+ * @no-named-arguments
  */
 final class CommentedOutFunctionFixer extends AbstractFixer implements ConfigurableFixerInterface
 {

src/Fixer/ConstructorEmptyBracesFixer.php

@@ -17,6 +17,9 @@
 use PhpCsFixer\Tokenizer\Tokens;
 use PhpCsFixerCustomFixers\Analyzer\ConstructorAnalyzer;
 
+/**
+ * @no-named-arguments
+ */
 final class ConstructorEmptyBracesFixer extends AbstractFixer
 {
     public function getDefinition(): FixerDefinitionInterface

src/Fixer/DataProviderNameFixer.php

@@ -29,6 +29,8 @@
  *
  * @phpstan-type _InputConfig array{prefix?: string, suffix?: string}
  * @phpstan-type _Config array{prefix: string, suffix: string}
+ *
+ * @no-named-arguments
  */
 final class DataProviderNameFixer extends AbstractFixer implements ConfigurableFixerInterface, DeprecatedFixerInterface
 {