alleyinteractive / alleyinteractive/create-wordpress-plugin

Skip `RemoveUselessVarTagRector` Rector rule to satisfy PHPCS

Ouverte
#514 2 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
Langage dominant
PHP
Étoiles
35
Forks
2
Merge moyen
1 j 11 h
PR mergées (30 j)
3

Description

### Description of the bug

PHPCS and Rector are in disagreement about variable comments in classes.

In Rector, the rule is `RemoveUselessVarTagRector`

In PHPCS, the rule is `Squiz.Commenting.VariableComment.MissingVar`

We should skip `Rector\DeadCode\Rector\Property\RemoveUselessVarTagRector::class` in `rector` to satisfy PHPCS and ensure maximum tooling compatibility.

### Steps To Reproduce

1. Create a new plugin with `create-wordpress-plugin`
2. Create a class with a variable, e.g.
```
/**
* REST_API instance.
*
* @var REST_API
*/
private REST_API $api;
```
3. Notice that the presence of `@var REST_API` breaks Rector, and removing `@var REST_API` breaks PHPCS

### Additional Information

_No response_

Guide de contribution

Ouvrir le guide de contribution

Évaluation

Cette issue n'a pas encore été évaluée.

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.