realm / realm/SwiftLint

Rule Request: Don't add ACL modifiers when they're already the default

Open
#5,828 1 comment 1 reaction 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 Rule Request

Avoid redundant access-level modifiers such as internal on top-level declarations.

  1. Why should this rule be added? Share links to existing discussion about what
    the community thinks about this.

    See header.

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

    Triggering:

    internal struct S {
      internal let a = 1
    }
    
    public extension E {
      public func f() {}
    }
    

    Not triggering:

    public struct S {
      internal let a = 1
    }
    
  3. Should the rule be configurable, if so what parameters should be configurable?

    Nothing to configure.

  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.

    Opt-in. It will conflict with the explicit_acl rule which is also 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 inspect the existing explicit_acl rule, since this request must coexist with it. Use the Swift examples in the issue as acceptance cases: redundant default access modifiers should trigger, while the non-redundant example should not.

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
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.