realm / realm/SwiftLint

Rule Request: [order_of_properties]

Open
#2,410 5 comments 7 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

Please describe the rule idea, format
this issue's title as Rule Request: [Rule Name] and describe:

  1. Why should this rule be added? Share links to existing discussion about what
    the community thinks about this.
  2. Provide several examples of what would and wouldn't trigger violations.
  3. Should the rule be configurable, if so what parameters should be configurable?
  4. 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 need rule to control properties groups order to keep file neat
All properties should be divided on several groups in order:

public let
public var

internal let
internal var

private let
private var

IBOutlet private var

The rule should triggering on mixing up this groups and on incorrect order
The rule should be configurable, I need to set desired order, or maybe order written above will bw enough
The rule should be 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 the rule-request requirements in the issue and the linked README.md opt-in-rules guidance. Clarify the property groups, ordering configuration, and examples of violations before implementing. Done means an opt-in order_of_properties rule can consistently detect mixed or incorrectly ordered groups and has documented behavior.

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
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.