Add phpcs rule to detect unused variables; Fix existing issues #17300
Conversation
jorgefilipecosta
added
the
[Type] Code Quality
jorgefilipecosta
force-pushed
the
add/phpcs-rule-to-detect-unused-variable-fix-existing-problems
branch
3 times, most recently
from
c7c3977
to
d316a00
Compare
jorgefilipecosta
changed the title
phpcs.xml.dist
Outdated
| @@ -10,6 +10,11 @@ | |||
| <rule ref="WordPress.WP.I18n"/> | |||
| <config name="text_domain" value="gutenberg,default"/> | |||
|
|
|||
| <rule ref="VariableAnalysis.CodeAnalysis.VariableAnalysis"> | |||
| <properties> | |||
| <property name="allowUnusedFunctionParameters" value="true"/> | |||
There was a problem hiding this comment.
What about using allowUnusedParametersBeforeUsed instead?
There was a problem hiding this comment.
Hi @swissspidy, the rule was causing problems when we need in a class to overload a function defined in the base class without necessarily using all the parameters.
But on second thought these cases are rare and we should not optimize for them, so I followed your suggestion and disabled the rule on the specific cases where it was problematic.
jorgefilipecosta
force-pushed
the
add/phpcs-rule-to-detect-unused-variable-fix-existing-problems
branch
2 times, most recently
from
0bb31b0
to
af896cb
Compare
| * @return WP_Error|bool True if the request has permission, WP_Error object otherwise. | ||
| * | ||
| * This function is overloading a function defined in WP_REST_Controller so it should have the same parameters. |
There was a problem hiding this comment.
Little confused by the comment as the $request param has been removed in the pr.
I also couldn't see permissions_check defined in WP_REST_Controller. Instead there are individual methods (get_items_permissions_check, get_item_permissions_check, create_item_permissions_check ... ).
There was a problem hiding this comment.
Nice catch the disable is not needed here I removed it 👍
jorgefilipecosta
force-pushed
the
add/phpcs-rule-to-detect-unused-variable-fix-existing-problems
branch
from
af896cb
to
36188a8
Compare
jorgefilipecosta
force-pushed
the
add/phpcs-rule-to-detect-unused-variable-fix-existing-problems
branch
from
36188a8
to
06e606b
Compare
jorgefilipecosta
changed the title
jorgefilipecosta
deleted the
add/phpcs-rule-to-detect-unused-variable-fix-existing-problems
branch
Description
This PR adds a PHP rule to detect unused PHP variables. And fixes the problems detected by this rule.
The fact we have many existing problems is a small proof that this rule is useful.
How has this been tested?
I executed
composer lint.I verified no lint error were detected.