Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add rule to prefer shorthand if let optional unwrapping syntax #192

Merged
merged 3 commits into from
Oct 13, 2022
Merged

Add rule to prefer shorthand if let optional unwrapping syntax #192

merged 3 commits into from
Oct 13, 2022

Conversation

calda
Copy link
Member

@calda calda commented Sep 12, 2022 •
edited
Loading

Summary

This PR proposes a new rule to prefer the shorthand if let optional unwrapping syntax added in Swift 5.7:

Omit the right-hand side of the expression when unwrapping an optional property to a non-optional property with the same name.

// WRONG
if
  let galaxy = galaxy,
  galaxy.name == "Milky Way"
{ … }

guard
  let galaxy = galaxy,
  galaxy.name == "Milky Way"
else { … }

// RIGHT
if
  let galaxy,
  galaxy.name == "Milky Way"
{ … }

guard
  let galaxy,
  galaxy.name == "Milky Way"
else { … }

Reasoning

We are adopting Swift 5.7 soon, so we should adopt guidance for its new language features.

As discussed in the Motivation section of SE-0345, the new shorthand optional unwrapping syntax removes unnecessary boilerplate while retaining clarity. Auto-formatting for this rule is implemented in nicklockwood/SwiftFormat#1165.

Please react with 👍/👎 if you agree or disagree with this proposal.

bachand
bachand approved these changes Sep 14, 2022
View reviewed changes
Copy link
Contributor

@bachand bachand left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very excited about this one.

README.md Outdated Show resolved Hide resolved
Sources/AirbnbSwiftFormatTool/airbnb.swiftformat Outdated Show resolved Hide resolved
README.md
@@ -739,12 +771,12 @@ _You can enable the following settings in Xcode by running [this script](resourc

```swift
// WRONG
if let galaxy = galaxy,
if let galaxy,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you use a regex to search for other code examples to correct, or did you look through all of them?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I looked at all cases of if let and guard let in the document

calda and others added 2 commits September 14, 2022 17:45
@calda @bachand
Update README.md
ef20d4a 
Co-authored-by: Michael Bachand <michael.bachand@airbnb.com>
@calda
Apply suggestions from code review
47ec30a
@calda calda merged commit 00216e3 into master Oct 13, 2022
@calda calda deleted the cal--redundantOptionalBinding branch October 13, 2022 23:49
Halle added a commit to slumberGroup/swift that referenced this pull request Dec 6, 2022
@Halle
Squashed commit of the following:
7c77f88 
commit 9f2d60d
Author: 유재호 <y73447jh@gmail.com>
Date:   Mon Nov 28 23:53:34 2022 +0900

    Add missing space after some comment delimiters (airbnb#208)

commit e8412c7
Author: Hanton Yang <hanton.yang@gmail.com>
Date:   Fri Nov 18 21:28:12 2022 -0800

    Fix typo in SE-0156 link (airbnb#207)

commit 07bb2e0
Author: Cal Stephens <cal@calstephens.tech>
Date:   Fri Nov 11 09:21:26 2022 -0800

    Update rule for long function declarations to specify effects (`async`, `throws`) should be written on the line after the closing paren (airbnb#205)

commit 9ea3428
Author: Cal Stephens <cal@calstephens.tech>
Date:   Fri Nov 4 17:24:56 2022 -0700

    Update `Package.swift` to explicitly not support Linux (airbnb#206)

commit 7884f26
Author: Michael Bachand <michael.bachand@airbnb.com>
Date:   Thu Oct 20 20:26:36 2022 -0700

    Update language around when an underscore prefix may be appropriate (airbnb#203)

commit 105d7cc
Author: Michael Bachand <michael.bachand@airbnb.com>
Date:   Thu Oct 20 20:25:27 2022 -0700

    Update README.md (airbnb#204)

commit 831d3c2
Author: 유재호 <y73447jh@gmail.com>
Date:   Tue Oct 18 11:17:12 2022 +0900

    Fix typos in rule 'prefer opaque generic parameter syntax' (airbnb#202)

commit fff6fdc
Author: Cal Stephens <cal@calstephens.tech>
Date:   Mon Oct 17 16:42:22 2022 -0700

    Bump SwiftFormat version (airbnb#201)

commit f600ed0
Author: Cal Stephens <cal@calstephens.tech>
Date:   Mon Oct 17 11:04:28 2022 -0700

    Add rule to prefer opaque generic parameter syntax (airbnb#193)

commit f7f2ff9
Author: 유재호 <y73447jh@gmail.com>
Date:   Tue Oct 18 02:13:17 2022 +0900

    Fix naming exception example(underscore prefix) and typos (airbnb#200)

commit f5ae3d7
Author: Cal Stephens <cal@calstephens.tech>
Date:   Fri Oct 14 11:18:27 2022 -0700

    Add rule to prefer simplified generic extension syntax (airbnb#194)

commit 00216e3
Author: Cal Stephens <cal@calstephens.tech>
Date:   Thu Oct 13 16:49:19 2022 -0700

    Add rule to prefer shorthand `if let` optional unwrapping syntax (airbnb#192)

commit 860f0d5
Author: Cal Stephens <cal@calstephens.tech>
Date:   Tue Oct 11 14:39:32 2022 -0700

    Add rule to prefer trailing closure syntax for closure arguments with no parameter name (airbnb#199)

commit eff3f23
Author: 유재호 <y73447jh@gmail.com>
Date:   Tue Aug 23 01:15:12 2022 +0900

    Fix typos in README.md (airbnb#191)

commit f602b12
Author: Cal Stephens <cal@calstephens.tech>
Date:   Tue Aug 16 16:52:56 2022 -0500

    Update to SwiftFormat build based on 0.49.16 (airbnb#190)

commit d1b1bda
Author: 유재호 <y73447jh@gmail.com>
Date:   Mon Aug 15 22:55:29 2022 +0900

    Fix typo and broken type annotations (airbnb#189)

commit cec2928
Author: Cal Stephens <cal@calstephens.tech>
Date:   Fri Jul 29 18:30:21 2022 -0700

    Improve handling of `--swift-format` and `--exclude` arguments (airbnb#182)

commit 1bf9613
Author: Cal Stephens <cal@calstephens.tech>
Date:   Thu Jul 28 09:21:53 2022 -0700

    Infer Swift version from Package.swift swift-tools-version (airbnb#180)

commit b53ed2a
Author: Cal Stephens <cal@calstephens.tech>
Date:   Thu Jul 28 08:54:24 2022 -0700

    Add `XcodeCommandPlugin` to fully support Xcode 14  (airbnb#181)

commit 30e8f68
Author: Michael Bachand <michael.bachand@airbnb.com>
Date:   Wed Jul 27 09:35:21 2022 -0700

    Remove executable as product (airbnb#179)

commit 1d8bb91
Author: Cal Stephens <cal@calstephens.tech>
Date:   Mon Jul 25 15:23:08 2022 -0700

    Add Swift Package Index badges (airbnb#178)

commit 7ecef5d
Author: Cal Stephens <cal@calstephens.tech>
Date:   Mon Jul 25 13:39:16 2022 -0700

    Add info about Swift Package Manager command plugin to README.md (airbnb#176)

commit 5542090
Author: Jay Hickey <hi@jayhickey.com>
Date:   Sat Jul 23 13:56:43 2022 -0700

    Add `--paths` argument to only lint specific paths (airbnb#177)

commit 503c5bc
Author: Cal Stephens <cal@calstephens.tech>
Date:   Fri Jul 22 14:17:09 2022 -0700

    Support target selection dialog in Xcode 14 (airbnb#175)

commit 7079bc3
Author: Cal Stephens <cal@calstephens.tech>
Date:   Fri Jul 22 14:06:02 2022 -0700

    Improve error handling, add support for `--exclude` flag (airbnb#173)

commit 852a2e3
Author: Cal Stephens <cal@calstephens.tech>
Date:   Fri Jul 22 11:46:12 2022 -0700

    Bump to latest commit of SwiftLint (airbnb#174)

commit 20290d8
Author: Michael Bachand <michael.bachand@airbnb.com>
Date:   Thu Jul 21 13:46:20 2022 -0700

    Aesthetics for new Swift command plugin (airbnb#172)

    * restrucutre

    * reorganize again

    * one more change

    * update ci

    * Update Package.swift

    * Update main.yml

commit 640b1ee
Author: Cal Stephens <cal@calstephens.tech>
Date:   Thu Jul 21 08:20:35 2022 -0700

    Update Swift version to 5.6 (airbnb#169)

commit fb658f4
Author: Cal Stephens <cal@calstephens.tech>
Date:   Wed Jul 20 14:23:23 2022 -0700

    Update xcode_settings.sh script to enable Xcode spell check (airbnb#171)

commit b844956
Author: Cal Stephens <cal@calstephens.tech>
Date:   Tue Jul 19 19:14:56 2022 -0700

    Add Swift Package Manager command plugin (airbnb#168)

commit c60d1f6
Author: Cal Stephens <cal@calstephens.tech>
Date:   Tue Jul 19 11:59:19 2022 -0700

    Include a single space in a set of empty braces (`{ }`) (airbnb#167)

commit d53c95b
Author: Cal Stephens <cal@calstephens.tech>
Date:   Tue Jul 19 11:58:54 2022 -0700

    Use commas instead of `&&` operators in conditional statements (airbnb#166)

commit 15309c9
Author: Cal Stephens <cal@calstephens.tech>
Date:   Tue Jul 5 10:02:40 2022 -0700

    Add rule to remove blank lines from the top and bottom of scopes (excluding type bodies) (airbnb#164)

commit a310253
Author: Cal Stephens <cal@calstephens.tech>
Date:   Sat Jul 2 19:55:48 2022 -0700

    Add `actor` to `--organizetypes` option (airbnb#165)

commit ea85cf2
Author: Michael Bachand <michael.bachand@airbnb.com>
Date:   Wed Jun 8 15:00:29 2022 -0700

    Fix href for #whitespace-around-comment-delimiters (airbnb#163)

commit 5034513
Author: Cal Stephens <cal@calstephens.tech>
Date:   Tue Jun 7 12:11:13 2022 -0700

    Add rule that there should be no spaces inside brackets of collection literals (airbnb#162)

commit 9785e35
Author: Cal Stephens <cal@calstephens.tech>
Date:   Tue Jun 7 12:11:03 2022 -0700

    Add rule that there should be no spaces before or inside the parentheses of function calls / declarations (airbnb#161)

commit 904b72d
Author: Cal Stephens <cal@calstephens.tech>
Date:   Tue Jun 7 12:10:52 2022 -0700

    Add rule to include spaces before and after comment delimiters (airbnb#160)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bachand bachand bachand approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@calda @bachand