Wrap long generic requirement clauses by davdroman · Pull Request #2684 · nicklockwood/SwiftFormat

davdroman · 2026-09-04T21:01:42Z

Wrap over-width declaration-level where clauses one generic requirement per line as part of the wrap rule.

Before this PR:

- extension Combined: MirrorableAtomicTransition where TransitionA: MirrorableAtomicTransition, TransitionB: MirrorableAtomicTransition {}
+ extension Combined: MirrorableAtomicTransition where TransitionA: MirrorableAtomicTransition,
+     TransitionB: MirrorableAtomicTransition {}

After this PR:

- extension Combined: MirrorableAtomicTransition where TransitionA: MirrorableAtomicTransition, TransitionB: MirrorableAtomicTransition {}
+ extension Combined: MirrorableAtomicTransition where
+     TransitionA: MirrorableAtomicTransition,
+     TransitionB: MirrorableAtomicTransition {}

…klockwood#2676)

…icklockwood#2672) Co-authored-by: Cal Stephens <cal.stephens@airbnb.com>

…ingAPI` (nicklockwood#2678) Co-authored-by: calda <1811727+calda@users.noreply.github.com>

…assignment pattern (nicklockwood#2681)

…ckwood#2682) Co-authored-by: calda <1811727+calda@users.noreply.github.com>

…ites from classes to structs (nicklockwood#2680) Co-authored-by: calda <1811727+calda@users.noreply.github.com>

…wood#2683) Co-authored-by: calda <1811727+calda@users.noreply.github.com>

codecov · 2026-09-04T21:08:01Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.57%. Comparing base (1ed45c7) to head (8b1b9fe).

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #2684      +/-   ##
===========================================
+ Coverage    95.49%   95.57%   +0.07%     
===========================================
  Files          181      181              
  Lines        27680    27788     +108     
===========================================
+ Hits         26433    26557     +124     
+ Misses        1247     1231      -16

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Format over-width declaration-level where clauses one requirement per line while preserving comments, formatter directives, partial wrapping, and formatting ranges.

calda · 2026-09-08T12:53:35Z

 }
+
+extension Formatter {
+    func wrapGenericRequirements() {


I like this but it should be behind an option, like --list-wrap-threshold. In fact it may make sense to just use --list-wrap-threshold.

calda · 2026-09-08T12:54:10Z

+    }
+
+    /// Executes a closure without changing the current rule's enablement or options state.
+    func withPreservedRuleState<T>(_ body: () throws -> T) rethrows -> T {


I would like to avoid introducing something complicated like this. What is the edge case you are trying to fix?

calda · 2026-09-08T12:56:02Z

+                    declarationKeywordIndex = functionKeywordIndex
+                    whereClauseRange = parsedRange
+                } else {
+                    guard let declaration = declarations.declaration(containing: whereIndex),


Instead of iterating over tokens and then finding the containing declaration, it would be better to just use declarations.forEachResursiveDeclaration

I also believe this check as written won't handle nested types, please include a test case for that. forEachResursiveDeclaration will handle that.

calda · 2026-09-08T12:57:39Z

        if tokens[keywordIndex] == .keyword("init"),
           let nextToken = index(of: .nonSpaceOrCommentOrLinebreak, after: keywordIndex),
-           tokens[nextToken] == .operator("?", .postfix)
+           tokens[nextToken] == .operator("?", .postfix) || tokens[nextToken] == .operator("!", .postfix)


Did not know about these 👍🏻

calda · 2026-09-08T12:59:50Z

+                    endIndex: whereClauseRange.upperBound,
+                    forceWrap: true,
+                    leadingDelimiter: .delimiter(","),
+                    normalizeSpaceAfterDelimiter: false


why false? would be simpler to not need to add this extra argument

Given how many changes it takes to use wrapMultilineStatement here, it seems better to just not attempt to use it and instead implement one-off wrapping code directly in this function

nicklockwood · 2026-10-04T21:14:29Z

I feel like this should also have a before-first/after-first wrap option like the other similar rules

davdroman · 2026-10-05T10:00:17Z

@nicklockwood @calda I've been really busy since I made this PR but haven't forgotten. I promise to get around to this asap :)

kimdv and others added 12 commits September 2, 2026 09:14

Add privateSwiftUIDynamicProperties rule (nicklockwood#2673)

244695a

Fix sortDeclarations handling trailing whitespace and comments (nic…

15d08d2

…klockwood#2676)

Add --hoist-imports option to sortImports, defaulting to true (n…

69a0d89

…icklockwood#2672) Co-authored-by: Cal Stephens <cal.stephens@airbnb.com>

Add spi-last option to --import-grouping (nicklockwood#2677)

2ec560b

Preserve replacingOccurrences(of: "", with: ...) in `preferSwiftStr…

56bc428

…ingAPI` (nicklockwood#2678) Co-authored-by: calda <1811727+calda@users.noreply.github.com>

Fix disable:next handling in multiline strings (nicklockwood#2646)

eddb626

Fix docComments for nested functions after executable code

b97ccb7

Update redundantExtendedLifetime rule to also apply to underscored …

0a55e30

…assignment pattern (nicklockwood#2681)

Replace spi-last with attributes-last for import grouping (nicklo…

f54c1d6

…ckwood#2682) Co-authored-by: calda <1811727+calda@users.noreply.github.com>

Add preferStructSwiftTestingSuites rule to convert Swift Testing su…

1acad72

…ites from classes to structs (nicklockwood#2680) Co-authored-by: calda <1811727+calda@users.noreply.github.com>

Handle write-only references in redundantExtendedLifetime (nicklock…

5a254df

…wood#2683) Co-authored-by: calda <1811727+calda@users.noreply.github.com>

Add --locale option for deterministic sorting (nicklockwood#2679)

1ed45c7

Wrap long generic requirement clauses

8b1b9fe

Format over-width declaration-level where clauses one requirement per line while preserving comments, formatter directives, partial wrapping, and formatting ranges.

davdroman force-pushed the feat/generic-requirement-wrapping branch from 00c0553 to 8b1b9fe Compare September 4, 2026 21:14

calda reviewed Sep 8, 2026

View reviewed changes

nicklockwood force-pushed the develop branch 3 times, most recently from 5908303 to 741c3e4 Compare September 16, 2026 06:51

nicklockwood force-pushed the develop branch 3 times, most recently from e668206 to e67a08f Compare September 30, 2026 08:20

Navigation Menu

Repository navigation

Wrap long generic requirement clauses - #2684

Wrap long generic requirement clauses#2684
davdroman wants to merge 13 commits into
nicklockwood:developfrom
davdroman:feat/generic-requirement-wrapping

davdroman commented Sep 4, 2026

Uh oh!

codecov Bot commented Sep 4, 2026 •

edited

Loading

Uh oh!

calda Sep 8, 2026

Uh oh!

calda Sep 8, 2026

Uh oh!

calda Sep 8, 2026

Uh oh!

calda Sep 8, 2026

Uh oh!

calda Sep 8, 2026

Uh oh!

calda Sep 8, 2026

Uh oh!

calda Sep 8, 2026

Uh oh!

nicklockwood commented Oct 4, 2026

Uh oh!

davdroman commented Oct 5, 2026

Uh oh!

This branch has not been deployed

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

Conversation

davdroman commented Sep 4, 2026

Uh oh!

codecov Bot commented Sep 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

calda Sep 8, 2026

Choose a reason for hiding this comment

Uh oh!

calda Sep 8, 2026

Choose a reason for hiding this comment

Uh oh!

calda Sep 8, 2026

Choose a reason for hiding this comment

Uh oh!

calda Sep 8, 2026

Choose a reason for hiding this comment

Uh oh!

calda Sep 8, 2026

Choose a reason for hiding this comment

Uh oh!

calda Sep 8, 2026

Choose a reason for hiding this comment

Uh oh!

calda Sep 8, 2026

Choose a reason for hiding this comment

Uh oh!

nicklockwood commented Oct 4, 2026

Uh oh!

davdroman commented Oct 5, 2026

Uh oh!

This branch has not been deployed

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

codecov Bot commented Sep 4, 2026 •

edited

Loading