Enable SwiftLint plugin for local development

.buildkite/download-xcframework.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+set -euo pipefail
+
+echo "--- :arrow_down: Downloading xcframework"
+buildkite-agent artifact download target/libwordpressFFI.xcframework.zip . --step "xcframework"
+buildkite-agent artifact download native/swift/Sources/wordpress-api-wrapper/wp_api.swift . --step "xcframework"
+unzip target/libwordpressFFI.xcframework.zip -d .
+rm target/libwordpressFFI.xcframework.zip

.buildkite/pipeline.yml

@@ -85,8 +85,14 @@ steps:
           make test-swift-linux
       - label: ":swift: Lint"
         command: |
+          .buildkite/download-xcframework.sh
           echo "--- :swift: Swiftlint"
           make lint-swift
+        depends_on: xcframework
+        env:
+          IMAGE_ID: xcode-15.3
+        agents:
+          queue: mac
   #
   # Kotlin Group
   - group: ":kotlin: Kotlin Wrapper"

.buildkite/swift-test.sh

@@ -2,11 +2,8 @@
 
 set -euo pipefail
 
-echo "--- :arrow_down: Downloading xcframework"
-buildkite-agent artifact download target/libwordpressFFI.xcframework.zip . --step "xcframework"
-buildkite-agent artifact download native/swift/Sources/wordpress-api-wrapper/wp_api.swift . --step "xcframework"
-unzip target/libwordpressFFI.xcframework.zip -d .
-rm target/libwordpressFFI.xcframework.zip
+.buildkite/download-xcframework.sh
+
 export SKIP_PACKAGE_WP_API=true
 
 function run_tests() {
@@ -23,6 +20,7 @@ function build_for_real_device() {
     xcodebuild -destination "generic/platform=$platform" \
         -scheme WordPress \
         -derivedDataPath DerivedData \
+        -skipPackagePluginValidation \
         build | xcbeautify
 }
 

.buildkite/validate-cocoapods.sh

@@ -41,11 +41,8 @@ Pod::Spec.new do |spec|
 end
 EOT
 
-echo "--- :arrow_down: Downloading xcframework"
-buildkite-agent artifact download target/libwordpressFFI.xcframework.zip . --step "xcframework"
-buildkite-agent artifact download native/swift/Sources/wordpress-api-wrapper/wp_api.swift . --step "xcframework"
-unzip target/libwordpressFFI.xcframework.zip -d .
-rm target/libwordpressFFI.xcframework.zip
+.buildkite/download-xcframework.sh
+
 export SKIP_PACKAGE_WP_API=true
 
 echo "--- :rubygems: Setting up Gems"

.swiftlint.yml

@@ -1,4 +1,4 @@
-swiftlint_version: 0.53.0
+swiftlint_version: 0.55.1
 strict: true
 included:
   - native/swift

Makefile

@@ -3,7 +3,6 @@ docker_container_repo_dir=/app
 
 # Common docker options
 rust_docker_container := public.ecr.aws/docker/library/rust:1.76
-swiftlint_container := ghcr.io/realm/swiftlint:0.53.0
 
 docker_opts_shared :=  --rm -v "$(PWD)":$(docker_container_repo_dir) -w $(docker_container_repo_dir)
 rust_docker_run := docker run -v $(PWD):/$(docker_container_repo_dir) -w $(docker_container_repo_dir) -it -e CARGO_HOME=/app/.cargo $(rust_docker_container)
@@ -181,10 +180,10 @@ lint-rust:
 	$(rust_docker_run) /bin/bash -c "rustup component add clippy && cargo clippy --all -- -D warnings && cargo clippy --tests --all -- -D warnings"
 
 lint-swift:
-	docker run -v $(PWD):$(docker_container_repo_dir) -w $(docker_container_repo_dir) -it $(swiftlint_container) swiftlint
+	swift package plugin swiftlint
 
 lintfix-swift:
-	docker run -v $(PWD):$(docker_container_repo_dir) -w $(docker_container_repo_dir) -it $(swiftlint_container) swiftlint --autocorrect
+	swift package plugin swiftlint --autocorrect
 
 fmt-rust:
 	$(rust_docker_run) /bin/bash -c "rustup component add rustfmt && cargo fmt"

Package.swift

@@ -1,12 +1,8 @@
 // swift-tools-version:5.10
 
+import Foundation
 import PackageDescription
 
-enum WordPressRSVersion {
-    case local
-    case release(version: String, checksum: String)
-}
-
 let libwordpressFFIVersion: WordPressRSVersion = .local
 
 #if os(Linux)
@@ -15,20 +11,10 @@ let libwordpressFFI: Target = .systemLibrary(
         path: "target/swift-bindings/libwordpressFFI-linux/"
     )
 #elseif os(macOS)
-let libwordpressFFI: Target
-switch libwordpressFFIVersion {
-    case .local:
-        libwordpressFFI = .binaryTarget(name: "libwordpressFFI", path: "target/libwordpressFFI.xcframework")
-    case let .release(version, checksum):
-        libwordpressFFI = .binaryTarget(
-            name: "libwordpressFFI",
-            url: "https://github.com/Automattic/wordpress-rs/releases/download/\(version)/libwordpressFFI.xcframework.zip",
-            checksum: checksum
-        )
-}
+let libwordpressFFI: Target = libwordpressFFIVersion.target
 #endif
 
-let package = Package(
+var package = Package(
     name: "WordPress",
     platforms: [
         .iOS(.v13),
@@ -75,3 +61,66 @@ let package = Package(
         )
     ]
 )
+
+// MARK: - Enable local development toolings
+
+let localDevelopment = libwordpressFFIVersion.isLocal
+
+if localDevelopment {
+    try enableSwiftLint()
+}
+
+// MARK: - Helpers
+
+enum WordPressRSVersion {
+    case local
+    case release(version: String, checksum: String)
+
+    var isLocal: Bool {
+        if case .local = self {
+            return true
+        }
+        return false
+    }
+
+    var target: Target {
+        switch libwordpressFFIVersion {
+        case .local:
+            return .binaryTarget(name: "libwordpressFFI", path: "target/libwordpressFFI.xcframework")
+        case let .release(version, checksum):
+            return .binaryTarget(
+                name: "libwordpressFFI",
+                url: "https://github.com/Automattic/wordpress-rs/releases/download/\(version)/libwordpressFFI.xcframework.zip",
+                checksum: checksum
+            )
+        }
+    }
+}
+
+// Add SwiftLint to the package so that we can see linting issues directly from Xcode.
+func enableSwiftLint() throws {
+#if os(macOS)
+    let version = try String(contentsOf: URL(string:"./.swiftlint.yml", relativeTo: URL(filePath: #filePath))!)
+        .split(separator: "\n")
+        .first(where: { $0.starts(with: "swiftlint_version") })?
+        .split(separator: ":")
+        .last?
+        .trimmingCharacters(in: .whitespaces)
+    guard let version else {
+        fatalError("Can't find swiftlint_version in .swiftlint.yml")
+    }
+
+    package.dependencies.append(.package(url: "https://github.com/realm/SwiftLint", exact: .init(version)!))
+
+    var platforms = package.platforms ?? []
+    if let mac = platforms.firstIndex(where: { $0 == .macOS(.v11) }) {
+        platforms.remove(at: mac)
+        platforms.append(.macOS(.v12))
+    }
+    package.platforms = platforms
+
+    if let target = package.targets.first(where: { $0.name == "WordPressAPI" }) {
+        target.plugins = (target.plugins ?? []) + [.plugin(name: "SwiftLintBuildToolPlugin", package: "SwiftLint")]
+    }
+#endif
+}

scripts/xcodebuild-test.sh

@@ -14,5 +14,6 @@ xcodebuild \
     -scheme WordPress \
     -derivedDataPath DerivedData \
     -destination "id=${device_id}" \
+    -skipPackagePluginValidation \
     test \
     | xcbeautify