Adds opt-in rule discouraged_optional_collection #2001
Conversation
ornithocoder
force-pushed
the
optional_collection
branch
from
d39fa8b to
369c07f
Compare
Codecov Report
@@ Coverage Diff @@
## master #2001 +/- ##
==========================================
+ Coverage 89.81% 89.85% +0.03%
==========================================
Files 264 266 +2
Lines 15275 15362 +87
Branches 997 1012 +15
==========================================
+ Hits 13719 13803 +84
- Misses 1537 1539 +2
- Partials 19 20 +1
Continue to review full report at Codecov.
|
ornithocoder
force-pushed
the
optional_collection
branch
from
500428d to
fbffdb3
Compare
CHANGELOG.md
Outdated
|
|
||
| #### Enhancements | ||
|
|
||
| * Adds `discouraged_optional_collection` opt-in rule to encourages the return |
There was a problem hiding this comment.
s/encourages the return/encourage the use/
There was a problem hiding this comment.
Thanks, @jpsim!
I'll have to refactor/rewrite this rule. There are some cases that are really hard to cover using regular expression. For instance:
fun foo(param: [String: ↓[String: String]?])vs.
fun foo(param: ↓[String: [String: String]]?)But thanks, I'll update the changelog entry.
ornithocoder
force-pushed
the
optional_collection
branch
3 times, most recently
from
64aace1 to
19c01bb
Compare
ornithocoder
changed the title
ornithocoder
force-pushed
the
optional_collection
branch
2 times, most recently
from
afd92a5 to
a9c2a44
Compare
|
Hi @marcelofabri / @jpsim. Did you have a chance to look into this one? I added comments to the code to illustrate it better; for "developers of the future" that might need to interact with the code. Thanks! |
|
I created a gist with the String extension (w/ examples) from this rule. It can be copied and pasted on a Playground. |
ornithocoder
force-pushed
the
optional_collection
branch
2 times, most recently
from
f8ae195 to
21be5ba
Compare
and adds more examples.
ornithocoder
force-pushed
the
optional_collection
branch
from
21be5ba to
90d6399
Compare
|
Hi @marcelofabri, I am sorry to bother you with this but can you take a look on this PR? I've been using it on my project at work for weeks now and it seems solid. I'd love to see it merged into SwiftLint's master. Thanks! |
|
Thanks @ornithocoder 💯 |
Implements #1885.
I tried to use regular expressions to match collections, but soon realized I would need recursion support -
?R- to find and match nested collections, something Foundation doesn't offer.So I decided to re-implement the rule as an
ASTRule, looking for balanced optional collections in functions and variables declarations.Example:
[String: [Int]?]Example:
[String: [Int]?]?Example:
var x = Set<Int>?I've added similar examples to the private
Stringextension used by the rule to illustrate the code.