Skip to content

Skip RemoveUselessVarTagRector Rector rule to satisfy PHPCS #514

@nikkifurls

Description

@nikkifurls

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;
  1. Notice that the presence of @var REST_API breaks Rector, and removing @var REST_API breaks PHPCS

Additional Information

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions