realm / realm/SwiftLint

Rule Request: Prefer CGRect over NSRect

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

CGRect and NSRect are the same. NSRect is just a typealias of CGRect. I would like to enforce CGRect for consistency with iOS code.

This would apply to:

  • NSRect => CGRect
  • NSSize => CGSize
  • NSPoint => CGPoint
  1. Provide several examples of what would and wouldn't trigger violations.

Would trigger:

NSSize(width: 100, height: 100)

let foo: NSSize = bar()

Would not trigger:

CGSize(width: 100, height: 100)

let foo: CGSize = bar()
  1. Should the rule be configurable, if so what parameters should be configurable?

No, there's nothing to configure.

  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 it should be enabled by default as there's really no good reason to use the NS versions. They're just type aliases to the CG versions and most people use them inconsistently anyway.

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 the opt-in rule guidance in README.md and the requested examples in this issue. The change is complete when NSRect, NSSize, and NSPoint usages are reported as their CGRect, CGSize, and CGPoint counterparts, while the CG forms do not trigger violations.

Written by the indexing model from the issue text.

Assessment

Tech stack
swift
Domain
tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.