realm / realm/SwiftLint

Rule Request: [GuardIfSwitchReturnOnSameLine]

Open
#2,651 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

Please describe the rule idea, format
this issue's title as Rule Request: [Rule Name] and describe:

  1. Why should this rule be added? Share links to existing discussion about what
    the community thinks about this.

Conditionals and switch returning in same line, when the line is short enough, are more readable. This is a rule implementing the opposite as SwitchCaseOnNewlineRule and ConditionalsReturnOnNewLine.

  1. Provide several examples of what would and wouldn't trigger violations.

wouldn't:

        guard parameter1.isEmpty else { return }
        
        switch parameter1 {
        case "option1": return
        default: break
        }

would:

        guard parameter1.isEmpty else {
            return
        }
        
        switch parameter1 {
        case "option1":
            return
        default:
            break
        }
  1. Should the rule be configurable, if so what parameters should be configurable?

Yes. The length of the line, to distinguish when it should be on the same line as de conditional.
Also, is should provide an option to select when the rule applies: if, guard or switch. Something like:

guard_if_switch_return_on_same_line:
  lineLengthThreshold: 40
  error: 
    - if
    - guard
    - switch
  1. 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.

Opt-in, as ConditionalsReturnOnNewLine.

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

Start with README.md's opt-in rules guidance and inspect the existing ConditionalsReturnOnNewLine and SwitchCaseOnNewlineRule implementations. Define the requested line-length threshold and if/guard/switch selection from the examples, then verify that short single-line forms pass and expanded forms are reported according to the configuration.

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.