realm/SwiftLint

Adding a TypeContent case of `type_contents_order`

Open

#5,461 opened on Feb 7, 2024

View on GitHub
 (7 comments) (0 reactions) (0 assignees)Swift (19,570 stars) (2,295 forks)batch import
enhancementgood first issue

Description

Currently the TypeContent of type_contents_order is:

enum TypeContent: String {
    case `case` = "case"
    case typeAlias = "type_alias"
    case associatedType = "associated_type"
    case subtype = "subtype"
    case typeProperty = "type_property"
    case instanceProperty = "instance_property"
    case ibOutlet = "ib_outlet"
    case ibInspectable = "ib_inspectable"
    case initializer = "initializer"
    case typeMethod = "type_method"
    case viewLifeCycleMethod = "view_life_cycle_method"
    case ibAction = "ib_action"
    case otherMethod = "other_method"
    case `subscript` = "subscript"
    case deinitializer = "deinitializer"
}

It distinguishes between ib_outlet and instance_property, ib_action and other_method.

Would it be nice to have ib_segue_action as a case?

Contributor guide

Tech stack
swift
Domain
developer experiencetooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic Swift knowledgeFamiliarity with SwiftLint codebase
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Add a new case `ibSegueAction` to the `TypeContent` enum in the `type contents order` rule. The enum is defined in the file `Source/SwiftLintBuiltInRules/Rules/TypeContentOrderRule.swift`. After adding the case, update the corresponding tests in `Tests/SwiftLintBuiltInRulesTests/TypeContentOrderRuleTests.swift` to include this new case in the expected order. Ensure the new case is placed appropriately in the enum's ordering, likely near `ibAction`.