realm / realm/SwiftLint

Rule Request: Protocol conformance order

Open
#2,751 0 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.

Similar to the modified_order rule, it would be useful to be able to enforce the order of built-in protocols in a conformance. And also enforce that built-in protocols come first.

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

Would trigger:

struct Foo: RawRepresentable, Hashable {}
struct Foo: CustomProtocol, Hashable {}

Would not trigger:

struct Foo: Hashable, RawRepresentable {}
struct Foo: Hashable, CustomProtocol {}
  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.

Enabled by default

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 comparing the requested behavior with the linked modified_order rule and its documentation in Rules.md. Read README.md's opt-in-rule guidance, then define the built-in protocol ordering and verify the supplied triggering and non-triggering examples. Done means the new rule enforces that ordering and places built-in protocols before custom protocols.

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.