From 1ef15f3bb756e94de49f40e1c6d8000051248408 Mon Sep 17 00:00:00 2001 From: chrisjf Date: Thu, 18 Aug 2022 03:53:52 -0400 Subject: [PATCH] Update documentation for multiline_arguments_brackets and multiline_literal_brackets (#4098) - added two triggering examples that are a common style, to make it immediately obvious that they trigger the rules - also fixed a spelling mistake throughout the examples for the multiline_literal_brackets rule ("Gryffindor" is now correctly spelt) --- CHANGELOG.md | 6 ++++++ .../Style/MultilineArgumentsBracketsRule.swift | 5 +++++ .../Style/MultilineLiteralBracketsRule.swift | 18 ++++++++++++------ 3 files changed, 23 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0f5f0c419..c8df4dd44 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -82,6 +82,12 @@ accordingly._ `swiftlint` executables are identical. [JP Simard](https://github.com/jpsim) +* Update documentation for `multiline_arguments_brackets` and + `multiline_literal_brackets` to make it immediately obvious that common + examples will trigger. + [chrisjf](https://github.com/chrisjf) + [#4060](https://github.com/realm/SwiftLint/issues/4060) + #### Bug Fixes * Fix false positive in `self_in_property_initialization` rule when using diff --git a/Source/SwiftLintFramework/Rules/Style/MultilineArgumentsBracketsRule.swift b/Source/SwiftLintFramework/Rules/Style/MultilineArgumentsBracketsRule.swift index cb687c0d9..2517c3ab0 100644 --- a/Source/SwiftLintFramework/Rules/Style/MultilineArgumentsBracketsRule.swift +++ b/Source/SwiftLintFramework/Rules/Style/MultilineArgumentsBracketsRule.swift @@ -87,6 +87,11 @@ public struct MultilineArgumentsBracketsRule: ASTRule, OptInRule, ConfigurationP param3: "Param3"↓) """), Example(""" + foo(↓param1: "Param1", + param2: "Param2", + param3: "Param3"↓) + """), + Example(""" foo(↓bar( x: 5, y: 7 diff --git a/Source/SwiftLintFramework/Rules/Style/MultilineLiteralBracketsRule.swift b/Source/SwiftLintFramework/Rules/Style/MultilineLiteralBracketsRule.swift index fb8a3b3a2..8cbadd2a4 100644 --- a/Source/SwiftLintFramework/Rules/Style/MultilineLiteralBracketsRule.swift +++ b/Source/SwiftLintFramework/Rules/Style/MultilineLiteralBracketsRule.swift @@ -14,7 +14,7 @@ public struct MultilineLiteralBracketsRule: ASTRule, OptInRule, ConfigurationPro nonTriggeringExamples: [ Example(""" let trio = ["harry", "ronald", "hermione"] - let houseCup = ["gryffinder": 460, "hufflepuff": 370, "ravenclaw": 410, "slytherin": 450] + let houseCup = ["gryffindor": 460, "hufflepuff": 370, "ravenclaw": 410, "slytherin": 450] """), Example(""" let trio = [ @@ -23,7 +23,7 @@ public struct MultilineLiteralBracketsRule: ASTRule, OptInRule, ConfigurationPro "hermione" ] let houseCup = [ - "gryffinder": 460, + "gryffindor": 460, "hufflepuff": 370, "ravenclaw": 410, "slytherin": 450 @@ -34,7 +34,7 @@ public struct MultilineLiteralBracketsRule: ASTRule, OptInRule, ConfigurationPro "harry", "ronald", "hermione" ] let houseCup = [ - "gryffinder": 460, "hufflepuff": 370, + "gryffindor": 460, "hufflepuff": 370, "ravenclaw": 410, "slytherin": 450 ] """), @@ -57,11 +57,17 @@ public struct MultilineLiteralBracketsRule: ASTRule, OptInRule, ConfigurationPro ] """), Example(""" - let houseCup = [↓"gryffinder": 460, "hufflepuff": 370, + let houseCup = [↓"gryffindor": 460, "hufflepuff": 370, "ravenclaw": 410, "slytherin": 450 ] """), Example(""" + let houseCup = [↓"gryffindor": 460, + "hufflepuff": 370, + "ravenclaw": 410, + "slytherin": 450↓] + """), + Example(""" let trio = [ "harry", "ronald", @@ -69,13 +75,13 @@ public struct MultilineLiteralBracketsRule: ASTRule, OptInRule, ConfigurationPro """), Example(""" let houseCup = [ - "gryffinder": 460, "hufflepuff": 370, + "gryffindor": 460, "hufflepuff": 370, "ravenclaw": 410, "slytherin": 450↓] """), Example(""" class Hogwarts { let houseCup = [ - "gryffinder": 460, "hufflepuff": 370, + "gryffindor": 460, "hufflepuff": 370, "ravenclaw": 410, "slytherin": 450↓] } """),