realm / realm/SwiftLint

Rule Request: `explicit_view_spacing`

Open
#4,962 2 comments 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

Having migrated to SwiftUI, a major issue we encountered was not understanding (and subsequently remembering to account for) the fact that Spacer, and V/HStack variants had a non-zero default spacing. We've added a rule locally to enforce that spacing should be explicit to avoid unexpected behaviour.

Triggering examples:

Spacer()
VStack {
    Text("Hello World")
}
LazyHStack(
    alignment: .leading
) {
    Text("Hello World")
}

Non-triggering examples:

Spacer(minLength: 8)
Spacer(minLength: .zero)
VStack(spacing: 8) {
    Text("Hello World")
}
LazyHStack(
    alignment: .leading,
    spacing: .zero
) {
    Text("Hello World")
}

This should not be enabled by default as the default behaviour is desired in some applications.

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

Use the triggering and non-triggering SwiftUI snippets in the issue as acceptance cases, and locate SwiftLint’s existing rule registration and rule-test patterns first. The work is complete when the new rule detects implicit Spacer and stack spacing, accepts explicit spacing, and is not enabled by default.

Written by the indexing model from the issue text.

Assessment

Tech stack
swift
Domain
tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 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.