Use SwiftPM over CocoaPods to fetch SwiftLint

Author: mokagio

.gitignore

@@ -57,3 +57,6 @@ default.profraw
 # Everything without a .enc extension is ignored
 .configure-files/*
 !.configure-files/*.enc
+
+# BuildTools
+BuildTools/.build

.swiftlint.yml

@@ -2,6 +2,7 @@ swiftlint_version: 0.58.2
 
 # Project configuration
 excluded:
+  - BuildTools
   - DerivedData
   - Pods
   - fastlane

BuildTools/Empty.swift

@@ -0,0 +1,2 @@
+// Here only to satisfy SwiftPM requirement.
+// See https://github.com/nicklockwood/SwiftFormat#1-create-a-buildtools-folder-and-packageswift

BuildTools/Package.resolved

@@ -0,0 +1,37 @@
+// swift-tools-version:6.0
+import Foundation
+import PackageDescription
+
+let package = Package(
+    name: "BuildTools",
+    platforms: [.macOS(.v10_13)],
+    dependencies: [
+        .package(url: "https://github.com/SimplyDanny/SwiftLintPlugins", exact: loadSwiftLintVersion()),
+    ],
+    targets: [.target(name: "BuildTools", path: "")]
+)
+
+func loadSwiftLintVersion() -> Version {
+    let swiftLintConfigURL = URL(fileURLWithPath: #filePath)
+        .deletingLastPathComponent()
+        .appendingPathComponent("..")
+        .appendingPathComponent(".swiftlint.yml")
+
+    guard let yamlString = try? String(contentsOf: swiftLintConfigURL) else {
+        fatalError("Failed to read SwiftLint config file at \(swiftLintConfigURL).")
+    }
+
+    guard let versionLine = yamlString.components(separatedBy: .newlines)
+        .first(where: { $0.contains("swiftlint_version") }) else {
+        fatalError("SwiftLint version not found in YAML file.")
+    }
+
+    // Assumes the format `swiftlint_version: <version>`
+    guard let version = Version(versionLine.components(separatedBy: ":")
+        .last?
+        .trimmingCharacters(in: .whitespaces) ?? "") else {
+        fatalError("Failed to extract SwiftLint version.")
+    }
+
+    return version
+}

BuildTools/Package.swift

@@ -41,20 +41,6 @@ abstract_target 'Automattic' do
   end
 end
 
-## Tools
-## ===================
-##
-
-def swiftlint_version
-  require 'yaml'
-
-  YAML.load_file('.swiftlint.yml')['swiftlint_version']
-end
-
-abstract_target 'Tools' do
-  pod 'SwiftLint', swiftlint_version
-end
-
 # Post Install
 #
 post_install do |installer|

Podfile

@@ -11,32 +11,28 @@ PODS:
   - Simperium/SocketTrust (1.9.0)
   - Simperium/SPReachability (1.9.0)
   - Simperium/SSKeychain (1.9.0)
-  - SwiftLint (0.58.2)
   - WordPress-Ratings-iOS (0.0.2)
   - ZIPFoundation (0.9.15)
 
 DEPENDENCIES:
   - Gridicons (~> 0.18)
   - Simperium (= 1.9.0)
-  - SwiftLint (= 0.58.2)
   - WordPress-Ratings-iOS (= 0.0.2)
   - ZIPFoundation (~> 0.9.9)
 
 SPEC REPOS:
   trunk:
     - Gridicons
     - Simperium
-    - SwiftLint
     - WordPress-Ratings-iOS
     - ZIPFoundation
 
 SPEC CHECKSUMS:
   Gridicons: dc92efbe5fd60111d2e8ea051d84a60cca552abc
   Simperium: 45d828d68aad71f3449371346f270013943eff78
-  SwiftLint: 365bcd9ffc83d0deb874e833556d82549919d6cd
   WordPress-Ratings-iOS: 9f83dbba6e728c5121b1fd21b5683cf2fd120646
   ZIPFoundation: 063163dc828bf699c5be160eb4f58f676322d94f
 
-PODFILE CHECKSUM: 1a6145a673ddc931a81b1fbd59e20edfdbaca298
+PODFILE CHECKSUM: 14904fe5db303e2b35352af2f191345f1edf8f0a
 
 COCOAPODS: 1.16.0

Podfile.lock

@@ -20,7 +20,8 @@ Third party libraries and resources managed by CocoaPods will be installed by th
 
 #### SwiftLint
 
-We use [SwiftLint](https://github.com/realm/SwiftLint) to enforce a common style for Swift code. If you plan to write code, SwiftLint is going to be installed when you run `bundle exec pod install` and SwiftLint will run during the build.
+We use [SwiftLint](https://github.com/realm/SwiftLint) to enforce a common style for Swift code.
+If you plan to write code, SwiftLint is going to be installed automatically when you build the app.
 No commit should have lint warnings or errors.
 
 ### Open Xcode

README.md

@@ -17,6 +17,18 @@ LOCAL_PATH = 'vendor/bundle'
 
 task default: %w[test]
 
+desc 'Checks the source for style errors'
+task :lint do
+  swiftlint
+end
+
+namespace :lint do
+  desc 'Automatically corrects style errors where possible'
+  task :autocorrect do
+    swiftlint(additional_args: ['--fix'])
+  end
+end
+
 desc 'Install required dependencies'
 task dependencies: %w[dependencies:check]
 
@@ -251,3 +263,16 @@ def check_dependencies_hook
     exit 1
   end
 end
+
+def swiftlint(additional_args: [])
+  run_package_plugin(cmd: "swiftlint --working-directory .. --quiet #{additional_args.join(' ')}")
+end
+
+def run_package_plugin(cmd:)
+  run_in_build_tools(cmd: "swift package plugin --allow-writing-to-directory .. --allow-writing-to-package-directory #{cmd}")
+end
+
+# We could use more idiomatic Ruby here, with `Dir.chdir`, but leaving as raw shell commands for when we'll drop Ruby and rake for tooling.
+def run_in_build_tools(cmd:)
+  sh "pushd BuildTools && export SDKROOT=$(xcrun --sdk macosx --show-sdk-path) && #{cmd} && popd"
+end

Rakefile

@@ -3306,7 +3306,7 @@
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 			shellPath = /bin/sh;
-			shellScript = "[ $CI ] && exit 0\n./Pods/SwiftLint/swiftlint\n";
+			shellScript = "[ $CI ] && exit 0\nrake lint\n";
 		};
 		B553F5A11D10474600F7E397 /* Delete Frameworks folder (temporary fix for CocoaPods) */ = {
 			isa = PBXShellScriptBuildPhase;