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

SwiftLint setup – Part 1 – Local only SwiftLint, with local configuration #517

Closed
wants to merge 7 commits into from
Closed

SwiftLint setup – Part 1 – Local only SwiftLint, with local configuration #517

wants to merge 7 commits into from

Conversation

mokagio
Copy link
Contributor

@mokagio mokagio commented Jun 6, 2022 •
edited
Loading

Description

This is the most basic SwiftLint setup we could have:

  1. Installed locally, with version managed via CocoaPods. Note that there are alternatives, but the one with the best straightforwardness to level of control I could find in the context of HACK Week.
  2. Use a config file tracked locally.
  3. Run only as an Xcode Build Phase Run Script

Testing Details

Checkout this branch, and update the code to trigger a SwiftLint violation. The simplest thing to do is add a ; at the end of a line in the production and test code. Build the app and verify that Xcode shows a warning.

Next Steps

  • Use a remote configuration, so that we can share it across various project and maintain a consistent style
  • Experiment: Use Danger instead of Hound for inline comments. This is slower but more configurable.
  • Please check here if your pull request includes additional test coverage. – N.A.
  • I have considered updating the version in the .podspec file. – N.A.

mokagio added 7 commits June 6, 2022 15:26
@mokagio
Add SwiftLint via CocoaPods
c48a80d 
I find this is a simpler way to add SwiftLint because, by using a tool
that is already a required part of the setup, it doesn't need extra
scripts or commands that devs may forget to run.

In the long run, we'll want to install SwiftLint in a Ruby-less way.
This commit comes in the context of a HACK Week project, where I'm more
interested in bringing stuff to a working state soon rather than
crafting the best solution.

We can always iterate on top of this and change the SwiftLint install
mode later on.
@mokagio
Add SwiftLint config file from WordPress iOS
33ffb88 
https://github.com/wordpress-mobile/WordPress-iOS/blob/0ad4c832e1b5a085c54518e639c55f2c888bd3f4/.swiftlint.yml
@mokagio
fixup! Add SwiftLint via CocoaPods
5f2da9e
@mokagio
Upgrade the Xcode project.pbxproj to version 54o
9289527 
This happened automatically as a result of adding a build phase run
script step. I decided to track the upgrade changes in isolation to make
reviewing easier.
@mokagio
Add run script build phase for SwiftLint
92a2d07
@mokagio
Address the only two SwiftLint violations found in the project
899f05f
@mokagio
Run SwiftLint on a per-target basis
668d62c 
This ensures more targeted feedback from the tool. That is, if you are
only building the production target, you shouldn't get warnings for the
test target.
@mokagio mokagio changed the title SwiftLint setup – Part 1 – Install SwiftLint locally SwiftLint setup – Part 1 – Local only SwiftLint, with local configuration Jun 8, 2022
This was referenced Jun 8, 2022
Closed
Closed
Closed
Closed
Closed
@mokagio mokagio closed this Mar 17, 2024
@mokagio
Copy link
Contributor Author

mokagio commented Mar 17, 2024

Closed in favor of #693 and #735

@mokagio mokagio deleted the swiftlint-locally branch March 17, 2024 22:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@mokagio