Format the whole codebase with SwiftFormat #695

dusi · 2019-05-30T22:20:04Z

📲 What

As title says

🤔 Why

Consistency consistency consistency + courage

🛠 How

Ran bin/format.sh . from project's root folder in order to format all the Swift files
(you can double check by running the same command that it won't change any files anymore)

🍍

You should first check .swiftformat configuration file and review the rules we're using over at https://github.com/nicklockwood/SwiftFormat/blob/master/Rules.md (there are some examples that will help you get started)
It's possible that due to the stripunusedargs rule, the function was stripped from argument names and would potentially fit on one line now (feel free to add suggestions if you spot this happening - there's no good way of automating this).
Please try to keep an eye on self reference which is now inserted by SwiftFormat in a closure context (so that we don't leak by not using [weak self])
Fun fact: The whole codebase was formatted in under 7s (that's how fast SwiftFormat is

✅ Acceptance criteria

There are no odd formatting choices done by the formatter
Playgrounds work 😄

dusi

@justinswart @ifbarrera @Scollaco @cdolm92 please feel free to review this PR that formats the whole codebase...more sets of eyes are welcome...please note that this is optional if you're not an assignee (who's name I'll randomly draw from my hat :)

Even though this is optional, I'd suggest you time cop yourself to 30 mins or an hour and scan through as much as you can so that you can familiarize yourself with the formatter changes - this will be the way going forward).

You can get familiar with our rules in .swiftformat config and check some examples over at https://github.com/nicklockwood/SwiftFormat/blob/master/Rules.md

It took me almost 4 hours to scan through the whole DIFF (yep, I'm never doing this again)...I was able to find some oddities and hopefully there's not much left.

Since Github won't be able to render everything and life is too short to read every single change, here are some tips for reviewers..

Suggestions

Scan through couple files under various areas of our codebase (Cells, ViewModels, KsApi/Models, etc., etc.)
Coordinate with other reviewers to not review the same thing (maybe one person can start from the top, one from the bottom, etc.)

dusi · 2019-05-30T22:20:37Z

.swiftformat

@@ -1,26 +1,32 @@
-# Indent by 2 spaces
+# fileHeader


I had to manually update SwiftFormat's config file to match the feature branch formatting

dusi · 2019-05-30T22:36:17Z

Kickstarter-iOS/Library/Nib.swift

@@ -44,12 +46,14 @@ protocol NibLoading {

 extension NibLoading {
  static func fromNib(nib: Nib) -> Self? {
+    // swiftformat:disable indent


An example of ignoring the formatting since the formatter didn't do a good job here (it's more readable for us this way)

dusi · 2019-05-30T22:37:03Z

Kickstarter-iOS/Library/WebViewController.swift

@@ -66,6 +62,6 @@ extension LensHolder where Object: WebViewControllerProtocol {

 extension Lens where Whole: WebViewControllerProtocol, Part == WKWebView {
  internal var scrollView: Lens<Whole, UIScrollView> {
-    return Whole.lens.webView..Part.lens.scrollView
+    return Whole.lens.webView .. Part.lens.scrollView


This is not a range (--ranges no-space) but an operator so should be fine

dusi · 2019-05-30T23:04:28Z

Library/ViewModels/RewardPledgeViewModelTests.swift

@@ -1709,7 +1759,7 @@ internal final class RewardPledgeViewModelTests: TestCase {

  func testOrLabelHidden() {
    //todo


Clearly todos are an exception (we can fix this manually or not)

dusi · 2019-05-30T23:32:21Z

Library/UIColor.swift

-  @nonobjc public static func hexa(_ value: UInt32) -> UIColor {
-    let a = CGFloat((value & 0xFF000000) >> 24) / 255.0
+  @nonobjc static func hexa(_ value: UInt32) -> UIColor {
+    let a = CGFloat((value & 0xFF00_0000) >> 24) / 255.0


This looks odd

How about we added // swiftformat:disable numberFormatting for this file?

I've looked at the rules docs and it looks like hex grouping threshold was (4,8) by default so I've actually changed this to "ignore" for now

ksr-ci-bot · 2019-05-31T00:21:23Z

	1 Warning
⚠️	Big PR

Generated by 🚫 Danger

dusi · 2019-05-31T00:27:46Z

An example of code change that makes things more readable..

dusi · 2019-05-31T06:27:10Z

Format iOS codebase with SwiftFormat

justinswart · 2019-05-31T16:15:52Z

Please try to keep an eye on self reference which is now inserted by SwiftFormat in a closure context (so that we don't leak by not using [weak self])

Swift didn't allow references to self inside a closure without explicitly calling self before so I don't think this would have happened? Also, regardless of whether self is referenced, it would still be synthesized by the compiler I believe.

justinswart · 2019-05-31T16:39:22Z

Kickstarter-iOS/Library/Storyboard.swift

@@ -35,12 +35,14 @@ public enum Storyboard: String {
  case Video
  case WebModal

-  public func instantiate<VC: UIViewController>(_ viewController: VC.Type,
-                                                inBundle bundle: Bundle = .framework) -> VC {
+  public func instantiate<VC: UIViewController>(


This can fit on one line now 👍

justinswart

This looks great. I skimmed around the codebase, everything looks good and just had the one suggestion to disable numberFormatting in that file. 🚢

ksr-ci-bot added 8 commits May 30, 2019 14:36

Update swiftformat config

445eb6d

Format codebase and resolve errors

7a24a63

Fix some odd spacing

4fee76a

Resolve line length violations

69a4dca

Fix odd spacing in a playground

62a3e26

Move swiftlint disable comment

4812049

Fix tests

b8a04b7

Fix odd formatting

efcd35a

dusi commented May 31, 2019

View reviewed changes

dusi assigned justinswart May 31, 2019

dusi requested review from ifbarrera, Scollaco and cdolm92 May 31, 2019 01:26

justinswart reviewed May 31, 2019

View reviewed changes

justinswart approved these changes May 31, 2019

View reviewed changes

dusi changed the title ~~Format the whole codebase with SwiftLint~~ Format the whole codebase with SwiftFormat May 31, 2019

ksr-ci-bot added 3 commits May 31, 2019 11:37

Disable hex grouping rule

aac5874

Reformat hex value back to no spacing

30537bb

Make a function one liner again

ea83588

dusi merged commit 520d0a3 into master May 31, 2019

dusi deleted the swift-format branch May 31, 2019 19:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Format the whole codebase with SwiftFormat #695

Format the whole codebase with SwiftFormat #695

dusi commented May 30, 2019 •

edited

Loading

dusi left a comment

dusi May 30, 2019

dusi May 30, 2019

dusi May 30, 2019

dusi May 30, 2019

dusi May 30, 2019

justinswart May 31, 2019

dusi May 31, 2019 •

edited

Loading

ksr-ci-bot commented May 31, 2019

dusi commented May 31, 2019

dusi commented May 31, 2019

justinswart commented May 31, 2019

justinswart May 31, 2019

justinswart left a comment

		@@ -1709,7 +1759,7 @@ internal final class RewardPledgeViewModelTests: TestCase {

		func testOrLabelHidden() {
		//todo

Format the whole codebase with SwiftFormat #695

Format the whole codebase with SwiftFormat #695

Conversation

dusi commented May 30, 2019 • edited Loading

📲 What

🤔 Why

🛠 How

🍍

✅ Acceptance criteria

dusi left a comment

Choose a reason for hiding this comment

Suggestions

dusi May 30, 2019

Choose a reason for hiding this comment

dusi May 30, 2019

Choose a reason for hiding this comment

dusi May 30, 2019

Choose a reason for hiding this comment

dusi May 30, 2019

Choose a reason for hiding this comment

dusi May 30, 2019

Choose a reason for hiding this comment

justinswart May 31, 2019

Choose a reason for hiding this comment

dusi May 31, 2019 • edited Loading

Choose a reason for hiding this comment

ksr-ci-bot commented May 31, 2019

dusi commented May 31, 2019

dusi commented May 31, 2019

justinswart commented May 31, 2019

justinswart May 31, 2019

Choose a reason for hiding this comment

justinswart left a comment

Choose a reason for hiding this comment

dusi commented May 30, 2019 •

edited

Loading

dusi May 31, 2019 •

edited

Loading