Array sniffs: ignore short lists #1780
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
New utility method to determine whether a _short array_ token is in actual fact representing a PHP 7.1+ short list. This method will be short-lived in WPCS as it will be introduced in WPCS 3.5.0 and can be deprecated once the minimum required PHPCS version goes up.
While we should probably define rules for long/short list constructs, WPCS at this time, does not have a opinion on the formatting of these. The `Arrays` sniffs, however, would all treat _short lists_ as if they were _short arrays_ and apply the array rules on them. This PR fixes this by bowing out early if a short array is in actual fact a short list. Includes unit tests in each of the sniffs in the `Arrays` category affected by this issue. Fixes 1692
Closed
GaryJones
approved these changes
Jul 27, 2019
dingo-d
approved these changes
Jul 28, 2019
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.
While we should probably define rules for long/short list constructs, WPCS at this time, does not have an opinion on the formatting of these.
The
Arrayssniffs, however, would all treat short lists as if they were short arrays and apply the array rules on them.This PR fixes this by bowing out early if a short array is in actual fact a short list.
Includes unit tests in each of the sniffs in the
Arrayscategory affected by this issue.Fixes #1692
This PR also adds a new
Sniff::is_short_list()utility method to determine whether a short array token is in actual fact representing a PHP 7.1+ short list.This method will be short-lived in WPCS as it will be introduced in WPCS 3.5.0 and can be deprecated/removed once the minimum required PHPCS version goes up.