realm / realm/SwiftLint

[Rule request] Implicitly unwrapped function parameters

Open
#3,774 0 comments 0 reactions 0 assignees View on GitHub

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
New rule request

Sometimes I use implicitly unwrapped optionals for function parameters to signal that it shouldn't be called with nil but in case you do, the error will be handled inside. (In case I know that handling nil outside of the function would be the same in all use cases)
I'd like to request a rule to warn me whenever I use an implicitly unwrapped function parameter and it gets force unwrapped in the code but not when I use it safely.

Non triggering examples:

func foo(bar: URL!) {
    guard let bar = bar else { return }
    print(bar.path)
}
func foo(bar: URL!) {
    print(bar?.path ?? "null")
}

Triggering example:

func foo(bar: URL!) {
    print(bar.path)
}

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files or tests are named in the issue. Start by locating SwiftLint's existing rule implementations and test conventions, then compare the requested triggering and non-triggering examples. Done means the rule warns for implicitly unwrapped function parameters accessed forcefully while allowing the safe handling shown.

Written by the indexing model from the issue text.

Assessment

Tech stack
swift
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.