A Swift Package Plugin for SwiftLint that will run SwiftLint on build time and show errors & warnings in Xcode.
Note There now is an official version in the SwiftLint repo! Though this package will still be maintained and updated since it brings the benefit of being a smaller repository and therefore faster to download as a dependency
First add a dependency from this package:
dependencies: [
// ...
.package(url: "https://github.com/lukepistrol/SwiftLintPlugin", from: "0.2.2"),
]Then add it to your targets as a plugin:
targets: [
.target(
name: "YOUR_TARGET",
dependencies: [],
plugins: [
.plugin(name: "SwiftLint", package: "SwiftLintPlugin")
]
),
]Starting with Xcode 14, plugins can also work on Xcode Project's targets. To do so, simply add this package to your SPM dependencies in Xcode. After that open your target's settings > Build Phases and add SwiftLint to Run Build Tool Plug-ins like shown below:
You may need to enable & trust the plugin before you can actually run it during builds.
As of version 0.1.0 this package also includes a command plugin which can be called on any target.
- Select a project or package in the project navigator.
- Richt-click and select
SwiftLintFix.- alternatively you can select
File > Packages > SwiftLintFix.
- alternatively you can select
- Choose the target(s) to run the
swiftlint --fixcommand on.
Important to notice is that when building a package/project on any CI provider (e.g. GitHub Actions) it is mandatory to pass the -skipPackagePluginValidation flag to the xcodebuild command. This will skip the validation prompt which in Xcode looks like this:
xcodebuild \
-scheme "$SCHEME" \
-destination "$PLATFORM" \
-skipPackagePluginValidation \ # this is mandatory
clean buildIf you need to disable linting (for release/app store builds), you can setDISABLE_SWIFTLINT environment variable
