Skip to content

Add Swift Package Manager command plugin #168

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
Merged
calda merged 7 commits into from
Jul 20, 2022
Merged

Add Swift Package Manager command plugin #168

calda merged 7 commits into from
Jul 20, 2022

Conversation

@calda
Copy link
Member

@calda calda commented Jul 18, 2022 •
edited
Loading

This PR adds a Swift Package Manager command plugin, that formats source files in Swift package targets according to our style guide.

To use this command plugin, all you have to do is add this repo as a dependency:

dependencies: [
  .package(url: "https://github.com/airbnb/swift", branch: "master"),
]

then run the format command plugin:

$ swift package format

and that's it!

With the Xcode 13 toolchain, or in a non-interactive shell, you have to use swift package --allow-writing-to-package-directory format to give the tool permission to modify the package directory. I'm pretty sure that with the Xcode 14 toolchain you can omit the permission flag, and it will ask you interactively in the shell to grant permission, but I haven't tested that flow.

This seems a lot easier than the current setup that Lottie and Epoxy are using, for example -- they have to install the mint tool, install SwiftFormat and SwiftLint using mint, include copies of our config files in their repo (that quickly drift out of date), and manually invoke the two tools. Having a single command to do all of this is a nice simplification (and it will definitely make it easier to keep things up-to-date)!

calda
calda commented Jul 18, 2022
View reviewed changes
AirbnbSwiftFormatTool/airbnb.swiftformat Outdated
Copy link
Member Author

@calda calda Jul 18, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

To get these config files to appear in Bundle.main for the executable target, I had to move them from the resources folder to the AirbnbSwiftFormatTool folder

@calda calda force-pushed the cal--format-tool branch from 84eaf63 to 4780cda Compare July 18, 2022 02:59
calda
calda commented Jul 18, 2022
View reviewed changes
AirbnbSwiftFormatTool/airbnb.swiftformat Outdated
Copy link
Member Author

@calda calda Jul 18, 2022

Choose a reason for hiding this comment

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

Since the SwiftFormat version has to be specified in Package.swift, I figure we can remove it from this file so we have a single source of truth

@calda calda force-pushed the cal--format-tool branch 2 times, most recently from 9fa4663 to 5bb86e9 Compare July 18, 2022 03:24
calda
calda commented Jul 18, 2022
View reviewed changes
@calda calda force-pushed the cal--format-tool branch from 5bb86e9 to 8089ef3 Compare July 18, 2022 03:31
bachand
bachand approved these changes Jul 19, 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.

Nice!

AirbnbSwiftFormatTool/AirbnbSwiftFormatTool.swift Outdated
Copy link
Contributor

@bachand bachand Jul 19, 2022

Choose a reason for hiding this comment

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

I wondered if instead wanted to link to the code for SwiftFormat and SwiftLint but executing the binaries is probably more robust.

@bachand
Copy link
Contributor

bachand commented Jul 19, 2022

Oh also, a GIF of this in action would be great!

@calda
Copy link
Member Author

calda commented Jul 20, 2022

2022-07-19 17 03 56

@calda calda force-pushed the cal--format-tool branch 2 times, most recently from 0743264 to 4408b6c Compare July 20, 2022 00:34
@calda calda force-pushed the cal--format-tool branch 2 times, most recently from 3f60707 to 7741372 Compare July 20, 2022 01:27
@calda calda force-pushed the cal--format-tool branch from 7741372 to d28185c Compare July 20, 2022 01:31
@calda calda force-pushed the cal--format-tool branch from ba32c4a to 61aa59a Compare July 20, 2022 02:12
@calda calda merged commit b844956 into airbnb:master Jul 20, 2022
@calda calda mentioned this pull request Jul 20, 2022
Merged
bachand
bachand reviewed Jul 21, 2022
View reviewed changes
AirbnbSwiftFormatTool/AirbnbSwiftFormatTool.swift

if !lint {
arguments += ["--autocorrect"]
arguments += ["--fix"]
Copy link
Contributor

@bachand bachand Jul 21, 2022

Choose a reason for hiding this comment

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

The docs say the options --fix and --autocorrect are the same. Did you notice a difference?
Screen Shot 2022-07-20 at 5 39 28 PM

Copy link
Member Author

@calda calda Jul 21, 2022

Choose a reason for hiding this comment

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

I tried both and didn't notice a difference

@bachand bachand mentioned this pull request Jul 21, 2022
Merged
@calda calda mentioned this pull request Jul 21, 2022
Merged
3 tasks
@ktoso ktoso mentioned this pull request Jul 22, 2022
Closed
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