realm / realm/SwiftLint

Rule Request: Enforce `Double` for function arguments instead of `CGFloat`

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

I prefer to only use Double for floats in my own functions, for consistency and ease of use, never CGFloat. I only support 64-bit systems, so CGFloat has no practical benefit for me. However, I often get PRs on my open source projects where they use CGFloat. Would be nice to be able to enforce using Double.

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

Would trigger:

func foo(number: CGFloat) {}

Would not trigger:

func foo(number: Double) {}
  1. Should the rule be configurable, if so what parameters should be configurable?

No

  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

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 review how the requested rule should fit SwiftLint's rule conventions. Use the examples in the issue as the initial behavior checks: a function argument typed as CGFloat should trigger, while one typed as Double should not; the rule should be opt-in and have no 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
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.