Allow unused function arguments as regexp #22
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sirbrillig
force-pushed
the
update/allow-unused-args
branch
3 times, most recently
from
66813c2 to
2f14ecb
Compare
sirbrillig
changed the title
sirbrillig
force-pushed
the
update/allow-unused-args
branch
2 times, most recently
from
76d448a to
2e59460
Compare
Previously the property was converted to an array when the Sniff was registered. This could cause issues if the property was changed (I know it's unlikely but it can happen in tests pretty easily) after registration. Furthermore, it was convered to an array and then used to replace the original string property, which introduces risk by both mutating a property during an object lifecycle and even changing its type. With this change, we never change the property from a string, and instead we convert it to an array just before it is used.
sirbrillig
force-pushed
the
update/allow-unused-args
branch
from
2e59460 to
3976667
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There are already three options for ignoring unused variables. This PR adds documentation for those options and also adds a new option to allow ignoring variables by regular expression. This will bring the available options to the following:
allowUnusedFunctionParameters(bool, defaultfalse): if set to true, function arguments will never be marked as unused.allowUnusedCaughtExceptions(bool, defaultfalse): if set to true, caught Exception variables will never be marked as unused.validUnusedVariableNames(string, defaultnull): a space-separated list of names of placeholder variables that you want to ignore from unused variable warnings. For example, to ignore the variables$junkand$unused, this could be set to'junk unused'.ignoreUnusedRegexp(string, defaultnull): a PHP regexp string (note that this requires explicit delimiters) for variables that you want to ignore from unused variable warnings. For example, to ignore the variables$_junkand$_unused, this could be set to'/^_/'.Fixes #21.
To do
validUnusedVariableNamesvalidUnusedVariableNamesto array lateignoreUnusedRegexpoption to allow unused arguments regexpallowUnusedFunctionParameters,validUnusedVariableNames,allowUnusedCaughtExceptionsandignoreUnusedRegexp