Rule Request: Prevent moot unwrapped variable in guard/if-let
Open
Nobody has claimed this yet.
rule-request
- Dominant language
- Swift
- Stars
- 19.7k
- Forks
- 2.3k
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 11
Description
New Issue Checklist
- Updated SwiftLint to the latest version
- I searched for existing GitHub issues
New rule request
I countered some cases in my codebase where I unwrap a variable in a guard/if-let, but then don't use it directly.
- Why should this rule be added? Share links to existing discussion about what
the community thinks about this.
It prevents moot code.
- Provide several examples of what would and wouldn't trigger violations.
This:
guard
let asset = asset, // asset is not used
let date = asset.creationDate
else {
return
}
search(withQuery: date)
Could simply be:
guard
let date = asset?.creationDate
else {
return
}
search(withQuery: date)
- Should the rule be configurable, if so what parameters should be configurable?
No
- Should the rule be opt-in or enabled by default? Why?
See README.md for guidelines on when to mark a rule as opt-in.
Having moot code is not harmful, so I guess it could be opt-in.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the proposed guard and if-let examples in this issue, then review README.md's opt-in rules guidance. The work is complete when SwiftLint can identify the described moot unwrapped variables and the rule's opt-in status is defined.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- swift
- Domain
- devtools
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100