realm / realm/SwiftLint

Rule request: Enforce whether or not parentheses should be wrapped around closures

Open
#1,176 1 comment 2 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

Currently closures can be written one of two ways:
myCollection.filter{ $0 == 1 }
or
myCollection.filter({ $0 == 1 })

These two different ways are identical and will run exactly the same way. Further more, this also extends to closures with multiple lines:

let newCollection = myCollection.map{ 
  2*$0 + 5
}

or

let newCollection = myCollection.map({ 
  2*$0 + 5
})

For this, I propose a new rule which allows the presence of parentheses to be required, or disallowed depending on the configuration. Furthermore, I think the rule should allow you to differentiate between inline closures and multi line closures. For instance, with a particular configuration this would be allowed:

myCollection.filter({ $0 == 1 })
let newCollection = myCollection.map {
    2*$0 + 5
}

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

The issue names no implementation files, tests, or entry points. Start by reviewing SwiftLint's existing rule and configuration patterns, then determine how inline and multiline closures should be distinguished and how both required and disallowed parentheses should be validated; done means the rule and its configuration behavior are covered by tests.

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
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.