realm / realm/SwiftLint

Rule Request: prefer_else_if

Open
#4,667 0 comments 1 reaction 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
  1. Why should this rule be added? Share links to existing discussion about what
    the community thinks about this.

When an else branch has only one child statement which is either an if or if-else statement, this could be refactored to an else-if statement.

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

Violating Examples:

if foo {
  bar()
} else {
  if baz {
    qux()
  }
}

if foo {
  bar()
} else {
  if baz {
    qux()
  } else {
    quux()
  }
}

Non-Violating Examples:

if foo {
  bar()
} else {
  if baz {
    qux()
  }
  somethingElse()
}

if foo {
  bar()
} else if baz {
  qux()
}

if foo {
  bar()
} else if {
  qux()
} else {
  quux()
}
  1. Should the rule be configurable, if so what parameters should be configurable?

This rule doesn’t need to be configurable.

  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.

I think this should be an opt-in rule, because it is more like a stylistic rule to recommends to avoid unnecessary nesting.

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

Read README.md's opt-in-rules guidance, then compare the supplied violating and non-violating Swift examples with existing SwiftLint rule implementations and tests. The finished rule should flag an else branch containing only one if or if-else statement, while leaving multi-statement branches and existing else-if chains unchanged.

Written by the indexing model from the issue text.

Assessment

Tech stack
swift
Domain
devtools, 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.