realm / realm/SwiftLint

[Rule Request] Superfluous Swift Version Check Rule

Open
#4,042 0 comments 3 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

Similar to deployment_target, we could have a rule to catch code that is always executed given the current Swift version.

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

It's common to add #if swift(>=X.Y) checks during migration periods, but after a certain point, codebases drop old Swift versions, but these checks are rarely cleaned.

This rule would help with that.

  1. Provide several examples of what would and wouldn't trigger violations.
// triggers if our minimum supported version is 5.3
#if swift(>=4.2)
// do something
#endif 

// don't trigger if our current version is 5.3
#if swift(>=5.7)
// do something
#endif 
  1. Should the rule be configurable, if so what parameters should be configurable?

The min Swift version should be configurable (and the default value would be the current Swift version)

  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.

Probably opt-in since people need to set the min Swift version properly for it to be useful.

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 by reading README.md's opt-in rule guidance and examining the existing deployment_target rule for a comparable design. Clarify how the configurable minimum Swift version should work and how the provided #if swift examples map to violations. Done means an opt-in rule with the requested configuration and coverage for triggering and non-triggering cases.

Written by the indexing model from the issue text.

Assessment

Tech stack
swift
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.