Enable SwiftLint plugin for local development #129
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jkmassel
requested changes
May 30, 2024
Fwiw, this wasn't working for me before this PR either. I had to manually setup |
|
Yeah, neither 0.53 nor 0.55 work on my Mac. I thought we'll use we have the SwiftLint Swift Package locally, and use the docker image on CI. Maybe we can get rid of the docker image and just use the SwiftLint package: |
crazytonyli
force-pushed
the
swift-package-add-swiftlint
branch
from
41e4b54 to
03b20d7
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
At the moment, SwiftLint issues are not super straightforward to discover. It's part of CI checks, but requires manually running a command locally. Also, after running the swiftlint command, it's pretty hard to identify exact locations of the issues by reading its console output.
This PR integrates SwiftLint plugin into the
WordPressAPImodule, so that we can see linting issue right from Xcode when building the package.However, I don't want to add SwiftLint as part of the package dependencies, which would put extra constraints (also adding unnecessary swift packages) to the consumers. Since Swift Pakcage Manager treats all package dependencies as runtime dependencies, and there is no concept of "build dependencies", I have added some conditional checks in
Package.swiftto only addSwiftLintfor "local development".Since now we have different dependencies on local mac and CI agents, the
Package.resolvedcontent would be different too. I have checked in thePackage.resolvedfile, with SwiftLint and other dependencies in it. But on CI, that file basically gets ignored. I think that should be fine for now. Let me know if you have any concerns.