Update linter rules, add editorconfig

Author: rockbruno

.editorconfig

@@ -0,0 +1,10 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+insert_final_newline = true
+xcode_trim_whitespace_on_empty_lines = true

.github/workflows/ci.yaml

@@ -18,7 +18,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
       - name: Lint Swift files
-        run: swift format lint Sources/ Tests/ Example/ --recursive
+        run: swift format lint Sources/ Tests/ Example/ --recursive --strict
       - name: Build sourcekit-bazel-bsp (debug)
         run: swift build
       - name: Test sourcekit-bazel-bsp

.swift-format

@@ -1,32 +1,14 @@
 {
-  "fileScopedDeclarationPrivacy" : {
-    "accessLevel" : "private"
-  },
-  "indentConditionalCompilationBlocks" : true,
-  "indentSwitchCaseLabels" : false,
   "indentation" : {
     "spaces" : 4
   },
-  "lineBreakAroundMultilineExpressionChainComponents" : false,
-  "lineBreakBeforeControlFlowKeywords" : false,
-  "lineBreakBeforeEachArgument" : false,
-  "lineBreakBeforeEachGenericRequirement" : false,
-  "lineBreakBetweenDeclarationAttributes" : false,
-  "lineLength" : 100,
-  "maximumBlankLines" : 1,
-  "multiElementCollectionTrailingCommas" : true,
-  "noAssignmentInExpressions" : {
-    "allowedFunctions" : [
-      "XCTAssertNoThrow"
-    ]
-  },
-  "prioritizeKeepingFunctionOutputTogether" : false,
-  "reflowMultilineStringLiterals" : {
-    "never" : {
-
-    }
-  },
+  "lineLength": 120,
+  "prioritizeKeepingFunctionOutputTogether" : true,
   "respectsExistingLineBreaks" : true,
+  "lineBreakBeforeEachArgument": true,
+  "lineBreakBeforeEachGenericRequirement": true,
+  "lineBreakBetweenDeclarationAttributes": true,
+  "indentConditionalCompilationBlocks": false,
   "rules" : {
     "AllPublicDeclarationsHaveDocumentation" : false,
     "AlwaysUseLiteralForEmptyCollectionInit" : false,
@@ -40,9 +22,9 @@
     "FullyIndirectEnum" : true,
     "GroupNumericLiterals" : true,
     "IdentifiersMustBeASCII" : true,
-    "NeverForceUnwrap" : false,
-    "NeverUseForceTry" : false,
-    "NeverUseImplicitlyUnwrappedOptionals" : false,
+    "NeverForceUnwrap" : true,
+    "NeverUseForceTry" : true,
+    "NeverUseImplicitlyUnwrappedOptionals" : true,
     "NoAccessLevelOnExtensionDeclaration" : true,
     "NoAssignmentInExpressions" : true,
     "NoBlockComments" : true,
@@ -62,7 +44,7 @@
     "ReplaceForEachWithForLoop" : true,
     "ReturnVoidInsteadOfEmptyTuple" : true,
     "TypeNamesShouldBeCapitalized" : true,
-    "UseEarlyExits" : false,
+    "UseEarlyExits" : true,
     "UseExplicitNilCheckInConditions" : true,
     "UseLetInEveryBoundCaseVariable" : true,
     "UseShorthandTypeNames" : true,
@@ -72,8 +54,4 @@
     "UseWhereClausesInForLoops" : false,
     "ValidateDocumentationComments" : false
   },
-  "spacesAroundRangeFormationOperators" : false,
-  "spacesBeforeEndOfLineComments" : 2,
-  "tabWidth" : 8,
-  "version" : 1
-}
+}

Example/HelloWorld/HelloWorldLib/Sources/AddTodoView.swift

@@ -22,10 +22,14 @@ import TodoModels
 
 struct AddTodoView: View {
 
-    @ObservedObject var todoManager: TodoListManager
-    @Binding var isPresented: Bool
-    @State private var todoTitle = ""
-    @FocusState private var isTextFieldFocused: Bool
+    @ObservedObject
+    var todoManager: TodoListManager
+    @Binding
+    var isPresented: Bool
+    @State
+    private var todoTitle = ""
+    @FocusState
+    private var isTextFieldFocused: Bool
 
     var body: some View {
         NavigationView {

Example/HelloWorld/HelloWorldLib/Sources/TodoListView.swift

@@ -21,8 +21,10 @@ import SwiftUI
 import TodoModels
 
 struct TodoListView: View {
-    @StateObject private var todoManager = TodoListManager()
-    @State private var showingAddTodo = false
+    @StateObject
+    private var todoManager = TodoListManager()
+    @State
+    private var showingAddTodo = false
 
     var body: some View {
         NavigationView {

Example/HelloWorld/TodoModels/Sources/TodoListManager.swift

@@ -21,7 +21,8 @@ import Foundation
 import SwiftUI
 
 public final class TodoListManager: ObservableObject {
-    @Published public var todoItems: [TodoItem] = []
+    @Published
+    public var todoItems: [TodoItem] = []
 
     private let userDefaults: UserDefaults
     private let todoItemsKey = "todo-items"

Sources/BazelProtobufBindings/BazelProtobufBindings.swift

@@ -20,23 +20,19 @@
 import Foundation
 
 public struct BazelProtobufBindings {
-    
+
     let actionGraph: Analysis_ActionGraphContainer
-    
-    init(actionGraph: Analysis_ActionGraphContainer) {
-        self.actionGraph = actionGraph
-    }
 
     public static func new(data: Data) throws -> Self {
         let actionGraph = try Analysis_ActionGraphContainer(serializedBytes: data)
         return BazelProtobufBindings(actionGraph: actionGraph)
     }
-    
+
     public func findActionsBy(mnemonic: String) -> [Analysis_Action] {
         return actionGraph.actions.filter { $0.mnemonic == mnemonic }
     }
-    
+
     public func getTargetBy(label: String) -> Analysis_Target? {
-         return actionGraph.targets.first { $0.label == label }
+        return actionGraph.targets.first { $0.label == label }
     }
 }

Sources/SourceKitBazelBSP/RequestHandlers/BuildTargets/BazelQueryParser.swift

@@ -38,16 +38,10 @@ enum BazelQueryParser {
 
         var targets: [(BuildTarget, [URI])] = []
         for child in (xml.children ?? []) {
-            if child.name != "rule" {
-                continue
-            }
-            guard let childElement = child as? XMLElement else {
-                continue
-            }
+            if child.name != "rule" { continue }
+            guard let childElement = child as? XMLElement else { continue }
             let className = childElement.attribute(forName: "class")?.stringValue ?? ""
-            guard supportedRuleTypes.contains(className) else {
-                continue
-            }
+            guard supportedRuleTypes.contains(className) else { continue }
             if let data = try getTargetForLibrary(childElement, className, rootUri, toolchainPath) {
                 targets.append(data)
             }
@@ -56,10 +50,11 @@ enum BazelQueryParser {
     }
 
     static private func getTargetForLibrary(
-        _ childElement: XMLElement, _ className: String, _ rootUri: String, _ toolchainPath: String
-    )
-        throws -> (BuildTarget, [URI])?
-    {
+        _ childElement: XMLElement,
+        _ className: String,
+        _ rootUri: String,
+        _ toolchainPath: String
+    ) throws -> (BuildTarget, [URI])? {
         let bazelTarget = childElement.attribute(forName: "name")?.stringValue ?? ""
         guard bazelTarget.starts(with: "//") else {
             // FIXME
@@ -73,28 +68,16 @@ enum BazelQueryParser {
         let uri: URI = try URI(string: uriRaw)
 
         for child in (childElement.children ?? []) {
-            if child.name != "list" {
-                continue
-            }
-            guard let childElement = child as? XMLElement else {
-                continue
-            }
+            if child.name != "list" { continue }
+            guard let childElement = child as? XMLElement else { continue }
             let name = childElement.attribute(forName: "name")?.stringValue ?? ""
-            guard name == "srcs" else {
-                continue
-            }
+            guard name == "srcs" else { continue }
             for srcsEntry in (childElement.children ?? []) {
-                if srcsEntry.name != "label" {
-                    continue
-                }
-                guard let srcsEntryElement = srcsEntry as? XMLElement else {
-                    continue
-                }
+                if srcsEntry.name != "label" { continue }
+                guard let srcsEntryElement = srcsEntry as? XMLElement else { continue }
                 let srcValue = srcsEntryElement.attribute(forName: "value")?.stringValue ?? ""
                 // FIXME
-                if !srcValue.starts(with: "//") {
-                    continue
-                }
+                if !srcValue.starts(with: "//") { continue }
                 let src = srcValue.replacingOccurrences(of: ":", with: "/")
                 let srcUri = try URI(string: "file://" + rootUri + "/" + src.dropFirst(2))
                 targetSrcs.append(srcUri)
@@ -103,41 +86,24 @@ enum BazelQueryParser {
 
         var targetDeps: [BuildTargetIdentifier] = []
         for child in (childElement.children ?? []) {
-            if child.name != "list" {
-                continue
-            }
-            guard let childElement = child as? XMLElement else {
-                continue
-            }
+            if child.name != "list" { continue }
+            guard let childElement = child as? XMLElement else { continue }
             let name = childElement.attribute(forName: "name")?.stringValue ?? ""
-            guard name == "deps" else {
-                continue
-            }
+            guard name == "deps" else { continue }
             for depsEntry in (childElement.children ?? []) {
-                if depsEntry.name != "label" {
-                    continue
-                }
-                guard let depsEntryElement = depsEntry as? XMLElement else {
-                    continue
-                }
+                if depsEntry.name != "label" { continue }
+                guard let depsEntryElement = depsEntry as? XMLElement else { continue }
                 let depValue = depsEntryElement.attribute(forName: "value")?.stringValue ?? ""
                 // FIXME
-                if !depValue.starts(with: "//") {
-                    continue
-                }
+                if !depValue.starts(with: "//") { continue }
                 let depFullPath = rootUri + "/" + depValue.dropFirst(2)
                 let depUri = bazelTargetToURI(depFullPath)
                 targetDeps.append(BuildTargetIdentifier(uri: try URI(string: depUri)))
             }
         }
 
         var tags: [BuildTargetTag] = [.library]
-        var capabilities = BuildTargetCapabilities(
-            canCompile: true,
-            canTest: false,
-            canRun: false,
-            canDebug: false
-        )
+        var capabilities = BuildTargetCapabilities(canCompile: true, canTest: false, canRun: false, canDebug: false)
         // FIXME: Not the way to do this
         if bazelTarget.hasSuffix("TestsLib") {
             capabilities.canTest = true
@@ -153,9 +119,7 @@ enum BazelQueryParser {
                 languageIds: isSwift ? [.swift] : [.objective_c],
                 dependencies: targetDeps,
                 dataKind: .sourceKit,
-                data: SourceKitBuildTarget(
-                    toolchain: try URI(string: "file://" + toolchainPath)
-                ).encodeToLSPAny()
+                data: SourceKitBuildTarget(toolchain: try URI(string: "file://" + toolchainPath)).encodeToLSPAny()
             ), targetSrcs
         )
     }

Sources/SourceKitBazelBSP/RequestHandlers/BuildTargets/BazelTargetQuerier.swift

@@ -28,12 +28,9 @@ enum BazelTargetQuerierError: Error, LocalizedError {
 
     var errorDescription: String? {
         switch self {
-        case .noKinds:
-            return "A list of kinds is necessary to query targets"
-        case .noTargets:
-            return "A list of targets is necessary to query targets"
-        case .invalidQueryOutput:
-            return "Query output is not valid XML"
+        case .noKinds: return "A list of kinds is necessary to query targets"
+        case .noTargets: return "A list of targets is necessary to query targets"
+        case .invalidQueryOutput: return "Query output is not valid XML"
         }
     }
 }
@@ -62,13 +59,7 @@ final class BazelTargetQuerier {
         self.commandRunner = commandRunner
     }
 
-    func queryTargets(
-        forConfig config: BaseServerConfig,
-        rootUri: String,
-        kinds: Set<String>
-    ) throws
-        -> XMLElement
-    {
+    func queryTargets(forConfig config: BaseServerConfig, rootUri: String, kinds: Set<String>) throws -> XMLElement {
         guard !kinds.isEmpty else {
             throw BazelTargetQuerierError.noKinds
         }
@@ -90,11 +81,7 @@ final class BazelTargetQuerier {
 
         // We run this one on the main output base since it's not related to the actual indexing bits
         let cmd = "query \"kind('\(kindsFilter)', \(depsQuery))\" --output xml"
-        let output = try commandRunner.bazel(
-            baseConfig: config,
-            rootUri: rootUri,
-            cmd: cmd
-        )
+        let output = try commandRunner.bazel(baseConfig: config, rootUri: rootUri, cmd: cmd)
 
         logger.debug("Finished querying, building result XML")
 

Sources/SourceKitBazelBSP/RequestHandlers/BuildTargets/BazelTargetStore.swift

@@ -26,8 +26,7 @@ enum BazelTargetStoreError: Error, LocalizedError {
 
     var errorDescription: String? {
         switch self {
-        case .unknownBSPURI(let uri):
-            return "Requested data about a URI, but couldn't find it in the store: \(uri)"
+        case .unknownBSPURI(let uri): return "Requested data about a URI, but couldn't find it in the store: \(uri)"
         }
     }
 }
@@ -37,10 +36,7 @@ enum BazelTargetStoreError: Error, LocalizedError {
 final class BazelTargetStore {
 
     // The list of rules we currently care about and can process
-    static let supportedRuleTypes: Set<String> = [
-        "swift_library",
-        "objc_library",
-    ]
+    static let supportedRuleTypes: Set<String> = ["swift_library", "objc_library"]
 
     private let initializedConfig: InitializedServerConfig
     private let bazelTargetQuerier: BazelTargetQuerier
@@ -49,10 +45,7 @@ final class BazelTargetStore {
     private var bspURIsToSrcsMap: [URI: [URI]] = [:]
     private var srcToBspURIsMap: [URI: [URI]] = [:]
 
-    init(
-        initializedConfig: InitializedServerConfig,
-        bazelTargetQuerier: BazelTargetQuerier = BazelTargetQuerier()
-    ) {
+    init(initializedConfig: InitializedServerConfig, bazelTargetQuerier: BazelTargetQuerier = BazelTargetQuerier()) {
         self.initializedConfig = initializedConfig
         self.bazelTargetQuerier = bazelTargetQuerier
     }