Bump SourceKitten

https://stackoverflow.com/a/49438718/373262

Co-authored-by: Keith Smiley <keithbsmiley@gmail.com>

BUILD

@@ -6,7 +6,10 @@ load(
 
 swift_library(
     name = "SwiftLintFramework",
-    srcs = glob(["Source/SwiftLintFramework/**/*.swift"]),
+    srcs = glob(
+        ["Source/SwiftLintFramework/**/*.swift"],
+        exclude = ["Source/SwiftLintFramework/Rules/ExcludedFromBazel/ExtraRules.swift"],
+    ) + ["@swiftlint_extra_rules//:extra_rules"],
     module_name = "SwiftLintFramework",
     visibility = ["//visibility:public"],
     deps = [

CHANGELOG.md

@@ -19,6 +19,12 @@
 * Support for building SwiftLint with bazel.  
   [JP Simard](https://github.com/jpsim)
 
+* Support for writing custom private native rules when building with
+  bazel.  
+  [JP Simard](https://github.com/jpsim)
+  [Keith Smiley](https://github.com/keith)
+  [#3516](https://github.com/realm/SwiftLint/issues/3516)
+
 #### Bug Fixes
 
 * None.

Source/SwiftLintFramework/Extensions/Configuration+Cache.swift

@@ -63,9 +63,8 @@ extension Configuration {
             .map { rule in [type(of: rule).description.identifier, rule.cacheDescription] }
             .sorted { $0[0] < $1[0] }
         let jsonObject: [Any] = [rootDirectory, cacheRulesDescriptions]
-        if let jsonData = try? JSONSerialization.data(withJSONObject: jsonObject),
-            let jsonString = String(data: jsonData, encoding: .utf8) {
-            return jsonString.sha256()
+        if let jsonData = try? JSONSerialization.data(withJSONObject: jsonObject) {
+            return jsonData.sha256().toHexString()
         }
         queuedFatalError("Could not serialize configuration for cache")
     }
@@ -81,7 +80,14 @@ extension Configuration {
             baseURL = FileManager.default.urls(for: .cachesDirectory, in: .userDomainMask)[0]
 #endif
         }
-        let folder = baseURL.appendingPathComponent("SwiftLint/\(Version.current.value)")
+
+        let versionedDirectory = [
+            "SwiftLint",
+            Version.current.value,
+            ExecutableInfo.buildID
+        ].compactMap({ $0 }).joined(separator: "/")
+
+        let folder = baseURL.appendingPathComponent(versionedDirectory)
 
         do {
             try FileManager.default.createDirectory(at: folder, withIntermediateDirectories: true, attributes: nil)

Source/SwiftLintFramework/Extensions/String+sha256.swift

@@ -1,14 +1,24 @@
 #if canImport(CommonCrypto)
 import CommonCrypto
+import Foundation
+
+extension Data {
+    internal func sha256() -> Data {
+        withUnsafeBytes { bytes in
+            var hash = [UInt8](repeating: 0, count: Int(CC_SHA256_DIGEST_LENGTH))
+            _ = CC_SHA256(bytes.baseAddress, CC_LONG(count), &hash)
+            return Data(hash)
+        }
+    }
+
+    internal func toHexString() -> String {
+        reduce(into: "") { $0.append(String(format: "%02x", $1)) }
+    }
+}
 
 extension String {
     internal func sha256() -> String {
-        let theData = data(using: .utf8)!
-        return theData.withUnsafeBytes { bytes in
-            var hash = [UInt8](repeating: 0, count: Int(CC_SHA256_DIGEST_LENGTH))
-            _ = CC_SHA256(bytes.baseAddress, CC_LONG(theData.count), &hash)
-            return hash.reduce(into: "") { $0.append(String(format: "%02x", $1)) }
-        }
+        data(using: .utf8)!.sha256().toHexString()
     }
 }
 #endif

Source/SwiftLintFramework/Helpers/ExecutableInfo.swift

@@ -0,0 +1,38 @@
+#if os(macOS)
+import Foundation
+import MachO
+
+enum ExecutableInfo {
+    static let buildID: String? = {
+        if let handle = dlopen(nil, RTLD_LAZY) {
+            defer { dlclose(handle) }
+
+            if let ptr = dlsym(handle, MH_EXECUTE_SYM) {
+                return getUUID(pointer: ptr)?.uuidString
+            }
+        }
+
+        return nil
+    }()
+
+    private static func getUUID(pointer: UnsafeRawPointer) -> UUID? {
+        var offset: UInt64 = 0
+        let header = pointer.bindMemory(to: mach_header_64.self, capacity: 1)
+        offset += UInt64(MemoryLayout<mach_header_64>.size)
+        for _ in 0..<header.pointee.ncmds {
+            let loadCommand = pointer.load(fromByteOffset: Int(offset), as: load_command.self)
+            if loadCommand.cmd == LC_UUID {
+                let uuidCommand = pointer.load(fromByteOffset: Int(offset), as: uuid_command.self)
+                return UUID(uuid: uuidCommand.uuid)
+            }
+            offset += UInt64(loadCommand.cmdsize)
+        }
+        return nil
+    }
+}
+
+#else
+enum ExecutableInfo {
+    static let buildID: String? = nil
+}
+#endif

Source/SwiftLintFramework/Models/PrimaryRuleList.swift

@@ -216,4 +216,4 @@ public let primaryRuleList = RuleList(rules: [
     XCTFailMessageRule.self,
     XCTSpecificMatcherRule.self,
     YodaConditionRule.self
-])
+] + extraRules())

Source/SwiftLintFramework/Rules/ExcludedFromBazel/ExtraRules.swift

@@ -0,0 +1,6 @@
+// DO NOT EDIT
+
+/// This is an extension point for custom native rules for Bazel.
+///
+/// - returns: Extra rules that are compiled with Bazel.
+func extraRules() -> [Rule.Type] { [] }

bazel/deps.bzl

@@ -2,6 +2,20 @@ load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
 load("@com_github_keith_swift_syntax_bazel//:deps.bzl", "swift_syntax_deps")
 load("@com_github_jpsim_sourcekitten//bazel:repos.bzl", "sourcekitten_repos")
 
+def _default_extra_swift_sources_impl(ctx):
+    ctx.file("WORKSPACE", "")
+    ctx.file("empty.swift", "func extraRules() -> [Rule.Type] { [] }")
+    ctx.file("BUILD.bazel", """
+filegroup(
+    name = "extra_rules",
+    srcs = ["empty.swift"],
+    visibility = ["//visibility:public"],
+)""")
+
+_default_extra_swift_sources = repository_rule(
+    implementation = _default_extra_swift_sources_impl,
+)
+
 def swiftlint_deps():
     """Fetches SwiftLint dependencies"""
     if not native.existing_rule("build_bazel_rules_apple"):
@@ -10,5 +24,8 @@ def swiftlint_deps():
     if not native.existing_rule("build_bazel_rules_swift"):
         fail("error: this depends on rules_swift but that wasn't setup")
 
+    if not native.existing_rule("swiftlint_extra_rules"):
+        _default_extra_swift_sources(name = "swiftlint_extra_rules")
+
     swift_syntax_deps()
     sourcekitten_repos()

bazel/repos.bzl

@@ -4,9 +4,9 @@ def swiftlint_repos():
     """Fetches SwiftLint repositories"""
     http_archive(
         name = "com_github_jpsim_sourcekitten",
-        sha256 = "f3e17da70aa039a54df45d648c20c84fb13f4f70df33df88bcf69b06f8714304",
-        strip_prefix = "SourceKitten-24fc942861f1446c2aefb19ebc94a471b2abea0f",
-        url = "https://github.com/jpsim/SourceKitten/archive/24fc942861f1446c2aefb19ebc94a471b2abea0f.tar.gz",
+        sha256 = "2e79dde69433880bcf366b5328bde08a86eb446ccfde1e455702d62c436c07b9",
+        strip_prefix = "SourceKitten-d5b430416ad2df92adfe7649fea949d10357d2d4",
+        url = "https://github.com/jpsim/SourceKitten/archive/d5b430416ad2df92adfe7649fea949d10357d2d4.tar.gz",
     )
 
     http_archive(