Rule Request: Prefer CGRect over NSRect
Nobody has claimed this yet.
- Dominant language
- Swift
- Stars
- 19.7k
- Forks
- 2.3k
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 11
Description
New Issue Checklist
- Updated SwiftLint to the latest version
- I searched for existing GitHub issues
Rule Request
- 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=>CGRectNSSize=>CGSizeNSPoint=>CGPoint
- 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()
- Should the rule be configurable, if so what parameters should be configurable?
No, there's nothing to configure.
- 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
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- 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