Fix false positive in multiline_parameters rule when parameter is a closure has default value
#1913
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
Generated by 🚫 Danger |
| @@ -40,6 +40,7 @@ public struct MultilineParametersRule: ASTRule, OptInRule, ConfigurationProvider | |||
| for structure in dictionary.substructure { | |||
| guard | |||
| let structureOffset = structure.offset, | |||
| structure.typeName != nil, | |||
There was a problem hiding this comment.
I don't think this is enough to fix the issue, as you can explicit use a type for the closure parameter:
func foo(param1: Int,
param2: Bool,
param3: @escaping (Int) -> Void = { (x: Int) in }) { }There was a problem hiding this comment.
Yep. You're right. :'-( Do you see a not-so-dirty way to filter out these parameters within parameters?
There was a problem hiding this comment.
Can’t think about anything right now, but I vaguely remind dealing with this before. Maybe one or the rules has this implemented?
There was a problem hiding this comment.
I'll take a look. Thanks :-)
There was a problem hiding this comment.
I can check if the offset of the parameter isn't in the range of other parameters.
There was a problem hiding this comment.
Done. I've pushed another commit that checks the range of the parameter. If the parameter is in the bounds of another parameter, it rejects it. Something like this: a 1, a 2, and a 3 would be filtered out since they're inside parameter 3.
dictionary.substructure varParameters
----------------------------------------------------------------|
| |---------| |---------| |----------------------------| |
| | param 1 | | param 2 | | param 3: |a 1| |a 2| |a 3| | |
| |---------| |---------| |----------------------------| |
----------------------------------------------------------------|
ornithocoder
force-pushed
the
issue_multiline_closure
branch
from
8c95209
to
a4a1297
Compare
when parameter is a closure has default value. Fixes realm#1912.
For a function that takes a closure as default value, the array of
parameter reported by sourcekit also includes the parameters of that
closure.
In other words, a function like
func foo(param1: Int,
param2: Bool,
param3: (Int) -> Void = { (x: Int) in }) { }
reports 4 parameters (param 1, param2, param3, and x).
This commit uses the bounds of the method/function parameters to filter
out parameters within parameters. Below, a 1, a 2, and a 3 would be
filtered out since they're inside parameter 3.
----------------------------------------------------------------|
| |---------| |---------| |----------------------------| |
| | param 1 | | param 2 | | param 3: |a 1| |a 2| |a 3| | |
| |---------| |---------| |----------------------------| |
----------------------------------------------------------------|
ornithocoder
force-pushed
the
issue_multiline_closure
branch
from
a4a1297
to
d387532
Compare
marcelofabri
approved these changes
Oct 23, 2017
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.
Fixes #1912.