Improvements (#554)

Author: kubawerlos

.github/workflows/ci.yaml

@@ -36,15 +36,15 @@ jobs:
  os: [ macos-latest, ubuntu-latest, windows-latest ]
  php-version: [ '7.4', '8.0' ]
  include:
- - os: ubuntu-18.04
+ - os: ubuntu-latest
  php-version: '8.0'
  php-cs-fixer-version: '^2'
- - os: ubuntu-18.04
+ - os: ubuntu-latest
  php-version: '7.4'
  php-cs-fixer-version: '^2'
- - os: ubuntu-latest
+ - os: ubuntu-20.04
  php-version: '7.3'
- - os: ubuntu-latest
+ - os: ubuntu-18.04
  php-version: '7.2'
  - os: ubuntu-latest
  php-version: '7.2'

.php-cs-fixer.php

@@ -22,6 +22,13 @@
 unset($rules['phpdoc_tag_type']); // TODO: remove when fixer: https://github.com/FriendsOfPHP/PHP-CS-Fixer/pull/5395
 unset($rules['use_arrow_functions']); // TODO: remove when dropping support to PHP <7.4
 
+// add new fixers that are not in PhpCsFixerConfig yet
+foreach (new PhpCsFixerCustomFixers\Fixers() as $fixer) {
+ if (!isset($rules[$fixer->getName()])) {
+ $rules[$fixer->getName()] = true;
+ }
+}
+
 foreach (new PhpCsFixerCustomFixersDev\Fixers() as $fixer) {
  $rules[$fixer->getName()] = true;
 }

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-2832-brightgreen.svg)
+![Tests](https://img.shields.io/badge/tests-2831-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&event=push)](https://github.com/kubawerlos/php-cs-fixer-custom-fixers/actions)

tests/Fixer/PhpdocNoIncorrectVarAnnotationFixerTest.php

@@ -38,28 +38,24 @@ public function testFix(string $expected, ?string $input = null): void
  */
  public static function provideFixCases(): iterable
  {
- yield [
- '<?php
+ yield 'keep correct PHPDoc' => ['<?php
 /** @var Foo $foo */
 $foo = new Foo();
-',
- ];
+'];
 
- yield [
+ yield 'keep correct PHPDoc with leading slash' => [
  '<?php
 /** @var \Foo $foo */
 $foo = new Foo();
-',
- ];
+', ];
 
- yield [
+ yield 'keep correct PHPDoc with nullable' => [
  '<?php
 /** @var ?Foo $foo */
 $foo = new Foo();
-',
- ];
+', ];
 
- yield [
+ yield 'remove PHPDoc when variable name is different' => [
  '<?php
 $bar = new Logger();
 ',
@@ -69,7 +65,7 @@ public static function provideFixCases(): iterable
 ',
  ];
 
- yield [
+ yield 'remove PHPDoc when annotation hs no type' => [
  '<?php
 $bar = new Logger();
 ',
@@ -79,7 +75,7 @@ public static function provideFixCases(): iterable
 ',
  ];
 
- yield [
+ yield 'remove PHPDoc when variable name is different in "for" loop' => [
  '<?php
 for ($i = 0; $i < 100; $i++) {}
 ',
@@ -89,14 +85,12 @@ public static function provideFixCases(): iterable
 ',
  ];
 
- yield [
- '<?php
+ yield 'keep correct PHPDoc for "for" loop' => ['<?php
 /** @var int $i */
 for ($i = 0; $i < 100; $i++) {}
-',
- ];
+'];
 
- yield [
+ yield 'remove PHPDoc when variable name is different in "foreach" loop' => [
  '<?php
 foreach ($foo as $v) {}
 ',
@@ -106,14 +100,17 @@ public static function provideFixCases(): iterable
 ',
  ];
 
- yield [
- '<?php
-/** @var int $value */
-foreach ($foo as $value) {}
+ yield 'keep correct PHPDoc for array in "foreach" loop' => ['<?php
+/** @var int[] $foo */
+foreach ($foo as $bar) {}
 ',
  ];
+ yield 'keep correct PHPDoc for element in "foreach" loop' => ['<?php
+/** @var int $value */
+foreach ($foo as $value) {}
+'];
 
- yield [
+ yield 'remove PHPDoc when variable name is different in "if" condition' => [
  '<?php
 if (($v = getValue()) !== null) {}
 ',
@@ -123,14 +120,12 @@ public static function provideFixCases(): iterable
 ',
  ];
 
- yield [
- '<?php
+ yield 'keep correct PHPDoc for "if" condition' => ['<?php
 /** @var int $value */
 if (($value = getValue()) !== null) {}
-',
- ];
+'];
 
- yield [
+ yield 'remove PHPDoc when variable name is different in "switch" condition' => [
  '<?php
 switch ($v = getValue()) { default: break; }
 ',
@@ -140,14 +135,12 @@ public static function provideFixCases(): iterable
 ',
  ];
 
- yield [
- '<?php
+ yield 'keep correct PHPDoc for "switch" condition' => ['<?php
 /** @var int $value */
 switch ($value = getValue()) { default: break; }
-',
- ];
+'];
 
- yield [
+ yield 'remove PHPDoc when variable name is different in "while" loop' => [
  '<?php
 while ($i < 0) { $i++; }
 ',
@@ -157,14 +150,13 @@ public static function provideFixCases(): iterable
 ',
  ];
 
- yield [
- '<?php
+ yield 'keep correct PHPDoc for "while" loop' => ['<?php
 /** @var int $index */
 while ($index < 0) { $i++; }
 ',
  ];
 
- yield [
+ yield 'remove PHPDoc when variable name is different, but keep the rest of PHPDoc' => [
  '<?php
 /**
  * We create here new instance here
@@ -180,7 +172,7 @@ public static function provideFixCases(): iterable
 ',
  ];
 
- yield [
+ yield 'remove PHPDoc from before "return"' => [
  '<?php
 return true;
 ',
@@ -190,43 +182,25 @@ public static function provideFixCases(): iterable
 ',
  ];
 
- yield [
+ yield 'remove PHPDoc from end of file' => [
  '<?php
 ',
  '<?php
 /** @var LoggerInterface $foo */
 ',
  ];
 
- yield [
- '<?php
+ yield 'ignore other annotations' => ['<?php
 /** @see LoggerInterface $foo */
 $bar = new Logger();
-',
- ];
-
- yield [
- '<?php
-/** @var LoggerInterface[] $foo */
-foreach ($foo as $bar) {}
-',
- ];
-
- yield [
- '<?php
-/** @var LoggerInterface $bar */
-foreach ($foo as $bar) {}
-',
- ];
+'];
 
- yield [
- '<?php
+ yield 'ignore different variable name case' => ['<?php
 /** @var LoggerInterface $bar */
 $Bar = 2;
-',
- ];
+'];
 
- yield [
+ yield 'keep correct PHPDoc for class properties' => [
  '<?php
 class Foo
 {
@@ -254,7 +228,7 @@ class Foo
 ',
  ];
 
- yield [
+ yield 'remove PHPDoc for class properties' => [
  '<?php
 class Foo
 {
@@ -306,7 +280,7 @@ class Foo
 ',
  ];
 
- yield [
+ yield 'remove PHPDoc from inside of function' => [
  '<?php
 /** Class Foo */
 class Foo
@@ -345,7 +319,7 @@ public function hello()
 ',
  ];
 
- yield [
+ yield 'incorrect PHPDoc at the end of the file' => [
  '<?php
 $x = 0;
 ',