alleyinteractive / alleyinteractive/create-wordpress-plugin

Skip `RemoveUselessVarTagRector` Rector rule to satisfy PHPCS

Offen
#514 2 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
PHP
Sterne
35
Forks
2
Ø Merge
1 T. 11 Std.
Gemergte PRs (30 T.)
3

Beschreibung

### 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_

Beitragsleitfaden

Beitragsleitfaden öffnen

Bewertung

Dieses Issue wurde noch nicht bewertet.

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.