realm/SwiftLint

Feature request: Add an option that changes behavior depending on whether attributes have arguments

Open

#5,011 opened on May 15, 2023

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

Description

New Issue Checklist

New feature request

The attributes_with_arguments_always_on_line_above option which has added to the attributes rule in version 0.52.0 is only working for variables and imports. I think it would be nice if there was a way to work for functions and types as well.

In the current version, variables and imports can change the behavior of the attributes rule depending on whether their attributes have arguments, but functions and types cannot. I think it would be nice if they had a way to do the same.

An use case:

@objc(Foo)
class Foo: NSObject {
    @objc func foo() {}
}

ref. Google's Swift Style Guide

Contributor guide

Tech stack
swift
Domain
tooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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.
mostly clear
Prerequisites
Swift programmingbasic SwiftLint rule structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
The issue requests extending the `attributes with arguments always on line above` option to functions and types in the `attributes` rule. Currently, the option only works for variables and imports. The implementation likely involves modifying the rule's logic in the SwiftLint source code to handle function and type declarations similarly. Refer to the existing implementation of the `attributes` rule, specifically how it checks for attribute arguments and enforces line placement. The change should be localized to the rule's file, possibly `AttributesRule.swift`.
Feature request: Add an option that changes behavior depending on whether attributes have arguments · realm/SwiftLint#5011 | Good First Issue