Fixed multiple SwiftLint violations (#772)

peripheryapp · Aug 3, 2024 · 9fa573e · 9fa573e
1 parent 8759518
commit 9fa573e
Show file tree

Hide file tree

Showing 35 changed files with 90 additions and 115 deletions.
diff --git a/Package.swift b/Package.swift
@@ -8,7 +8,7 @@ var dependencies: [Package.Dependency] = [
     .package(url: "https://github.com/apple/swift-argument-parser", from: "1.0.0"),
     .package(url: "https://github.com/ileitch/swift-indexstore", from: "9.0.4"),
     .package(url: "https://github.com/apple/swift-syntax", from: "510.0.2"),
-    .package(url: "https://github.com/ileitch/swift-filename-matcher", from: "0.0.0"),
+    .package(url: "https://github.com/ileitch/swift-filename-matcher", from: "0.0.0")
 ]
 
 #if os(macOS)
@@ -131,7 +131,7 @@ var targets: [PackageDescription.Target] = [
             .target(name: "PeripheryKit")
         ],
         exclude: ["AccessibilityProject"]
-    ),
+    )
 ]
 
 #if os(macOS)
@@ -142,7 +142,7 @@ targets.append(contentsOf: [
             .target(name: "SourceGraph"),
             .target(name: "Shared"),
             .target(name: "PeripheryKit"),
-            .product(name: "XcodeProj", package: "XcodeProj"),
+            .product(name: "XcodeProj", package: "XcodeProj")
         ]
     ),
     .target(

diff --git a/Sources/PeripheryKit/Indexer/SwiftIndexer.swift b/Sources/PeripheryKit/Indexer/SwiftIndexer.swift
@@ -39,7 +39,7 @@ public final class SwiftIndexer: Indexer {
                 let indexStore = try IndexStore.open(store: URL(fileURLWithPath: indexStorePath.string), lib: .open())
                 let units = indexStore.units(includeSystem: false)
 
-                return try units.compactMap { unit  -> (FilePath, IndexStore, IndexStoreUnit)? in
+                return try units.compactMap { unit -> (FilePath, IndexStore, IndexStoreUnit)? in
                     guard let filePath = try indexStore.mainFilePath(for: unit) else { return nil }
 
                     let file = FilePath.makeAbsolute(filePath, relativeTo: currentFilePath)
@@ -187,7 +187,7 @@ public final class SwiftIndexer: Indexer {
                               let location = try transformLocation(occurrence.location)
                               else { return true }
 
-                        if !occurrence.roles.intersection([.definition, .declaration]).isEmpty {
+                        if !occurrence.roles.isDisjoint(with: [.definition, .declaration]) {
                             if let (decl, relations) = try parseRawDeclaration(occurrence, usr, location, indexStore) {
                                 rawDeclsByKey[decl.key, default: []].append((decl, relations))
                             }
@@ -257,10 +257,8 @@ public final class SwiftIndexer: Indexer {
             sourceFile.importStatements = importSyntaxVisitor.importStatements
 
             if !configuration.disableUnusedImportAnalysis {
-                for stmt in sourceFile.importStatements {
-                    if stmt.isExported {
-                        graph.addExportedModule(stmt.module, exportedBy: sourceFile.modules)
-                    }
+                for stmt in sourceFile.importStatements where stmt.isExported {
+                    graph.addExportedModule(stmt.module, exportedBy: sourceFile.modules)
                 }
             }
 
@@ -388,10 +386,8 @@ public final class SwiftIndexer: Indexer {
             if fileCommands.contains(.ignoreAll) {
                 retainHierarchy(declarations)
             } else {
-                for decl in declarations {
-                    if decl.commentCommands.contains(.ignore) {
-                        retainHierarchy([decl])
-                    }
+                for decl in declarations where decl.commentCommands.contains(.ignore) {
+                    retainHierarchy([decl])
                 }
             }
         }
@@ -593,7 +589,7 @@ public final class SwiftIndexer: Indexer {
                     }
                 }
 
-                if !rel.roles.intersection([.baseOf, .calledBy, .extendedBy, .containedBy]).isEmpty {
+                if !rel.roles.isDisjoint(with: [.baseOf, .calledBy, .extendedBy, .containedBy]) {
                     let referencer = rel.symbol
 
                     if let referencerUsr = referencer.usr {
@@ -663,7 +659,7 @@ public final class SwiftIndexer: Indexer {
             var refs = [Reference]()
 
             indexStore.forEachRelations(for: occurrence) { rel -> Bool in
-                if !rel.roles.intersection([.baseOf, .calledBy, .containedBy, .extendedBy]).isEmpty {
+                if !rel.roles.isDisjoint(with: [.baseOf, .calledBy, .containedBy, .extendedBy]) {
                     let referencer = rel.symbol
 
                     if let referencerUsr = referencer.usr {

diff --git a/Sources/PeripheryKit/Results/CodeClimateFormatter.swift b/Sources/PeripheryKit/Results/CodeClimateFormatter.swift
@@ -17,16 +17,16 @@ final class CodeClimateFormatter: OutputFormatter {
             let lines: [AnyHashable: Any] = [
                 "begin": result.declaration.location.line
             ]
-            
+
             let location: [AnyHashable: Any] = [
                 "path": outputPath(result.declaration.location).url.relativePath,
                 "lines": lines
             ]
-            
+
             let description = describe(result, colored: false)
                 .map { $0.1 }
                 .joined(separator: ", ")
-            
+
             let fingerprint: String
             if result.declaration.kind == .varParameter,
                 let parentFingerprint = result.declaration.parent?.usrs.joined(separator: "."),
@@ -37,14 +37,14 @@ final class CodeClimateFormatter: OutputFormatter {
             } else {
                 fingerprint = result.declaration.usrs.joined(separator: ".")
             }
-            
+
             let object: [AnyHashable: Any] = [
                 "description": description,
                 "fingerprint": fingerprint,
                 "severity": "major",
                 "location": location
             ]
-            
+
             jsonObject.append(object)
         }
 

diff --git a/Sources/PeripheryKit/Results/JsonFormatter.swift b/Sources/PeripheryKit/Results/JsonFormatter.swift
@@ -33,8 +33,8 @@ final class JsonFormatter: OutputFormatter {
                     let object: [AnyHashable: Any] = [
                         "kind": ref.kind.rawValue,
                         "name": ref.name ?? "",
-                        "modifiers": Array<String>(),
-                        "attributes": Array<String>(),
+                        "modifiers": [String](),
+                        "attributes": [String](),
                         "accessibility": "",
                         "ids": [ref.usr],
                         "hints": [redundantConformanceHint(with: inherited)],

diff --git a/Sources/PeripheryKit/Results/OutputFormatter.swift b/Sources/PeripheryKit/Results/OutputFormatter.swift
@@ -26,7 +26,7 @@ extension OutputFormatter {
             return "unused"
         case .assignOnlyProperty:
             return "assignOnlyProperty"
-        case .redundantProtocol(_, _):
+        case .redundantProtocol:
             return "redundantProtocol"
         case .redundantPublicAccessibility:
             return "redundantPublicAccessibility"

diff --git a/Sources/PeripheryKit/Syntax/ImportSyntaxVisitor.swift b/Sources/PeripheryKit/Syntax/ImportSyntaxVisitor.swift
@@ -14,7 +14,7 @@ final class ImportSyntaxVisitor: PeripherySyntaxVisitor {
     func visit(_ node: ImportDeclSyntax) {
         let parts = node.path.map { $0.name.text }
         let module = parts.first ?? ""
-        let attributes = node.attributes.compactMap { $0.as(AttributeSyntax.self)?.attributeName.trimmedDescription } 
+        let attributes = node.attributes.compactMap { $0.as(AttributeSyntax.self)?.attributeName.trimmedDescription }
         let location = sourceLocationBuilder.location(at: node.positionAfterSkippingLeadingTrivia)
         let statement = ImportStatement(
             module: module,

diff --git a/Sources/PeripheryKit/Syntax/UnusedParameterAnalyzer.swift b/Sources/PeripheryKit/Syntax/UnusedParameterAnalyzer.swift
@@ -115,10 +115,8 @@ final class UnusedParameterAnalyzer {
         case let item as Identifier:
             return item.name == param.name ? .used : .unused
         case let item as GenericItem where item.node.is(LabeledExprListSyntax.self): // function call arguments
-            for item in item.items {
-                if isParam(param, usedIn: item) {
-                    return .used
-                }
+            for item in item.items where isParam(param, usedIn: item) {
+                return .used
             }
 
             return .unused

diff --git a/Sources/Shared/Configuration.swift b/Sources/Shared/Configuration.swift
@@ -269,7 +269,7 @@ public final class Configuration {
         if $retainCodableProperties.hasNonDefaultValue {
             config[$retainCodableProperties.key] = retainCodableProperties
         }
-        
+
         if $retainEncodableProperties.hasNonDefaultValue {
             config[$retainEncodableProperties.key] = retainEncodableProperties
         }

diff --git a/Sources/Shared/Extensions/FilePath+Glob.swift b/Sources/Shared/Extensions/FilePath+Glob.swift
@@ -15,7 +15,7 @@ public extension FilePath {
 
         return Glob(
             pattern: absolutePattern,
-            blacklistedDirectories: [".build", "node_modules", ".gems", "gems", ".swiftpm"],
+            excludedDirectories: [".build", "node_modules", ".gems", "gems", ".swiftpm"],
             logger: Logger()
         ).paths.mapSet { FilePath($0).lexicallyNormalized() }
     }
@@ -27,18 +27,18 @@ public extension FilePath {
  ///      For example, with the pattern "dir/**/*.ext" the file "dir/file.ext" is also included.
  ///    - When the pattern ends with a trailing slash, only directories are matched.
 private class Glob {
-    private let blacklistedDirectories: [String]
+    private let excludedDirectories: [String]
     private let logger: Logger
     private var isDirectoryCache: [String: Bool] = [:]
 
     fileprivate var paths: Set<String> = []
 
     init(
         pattern: String,
-        blacklistedDirectories: [String],
+        excludedDirectories: [String],
         logger: Logger
     ) {
-        self.blacklistedDirectories = blacklistedDirectories
+        self.excludedDirectories = excludedDirectories
         self.logger = logger
 
         let hasTrailingGlobstarSlash = pattern.hasSuffix("**/")
@@ -107,7 +107,7 @@ private class Glob {
 
     private func exploreDirectories(url: URL) throws -> [URL] {
         let subURLs = try FileManager.default.contentsOfDirectory(atPath: url.path).flatMap { subPath -> [URL] in
-            if blacklistedDirectories.contains(subPath) {
+            if excludedDirectories.contains(subPath) {
                 return []
             }
 

diff --git a/Sources/Shared/UnfairLock.swift b/Sources/Shared/UnfairLock.swift
@@ -6,13 +6,13 @@ import os
 
 public final class UnfairLock {
     #if canImport(os)
-    private var _osAllocatedUnfairLock: Any? = nil
+    private var _osAllocatedUnfairLock: Any?
 
     private var osAllocatedUnfairLock: OSAllocatedUnfairLock<Void> {
         _osAllocatedUnfairLock as! OSAllocatedUnfairLock
     }
     #else
-    private var _nsLock: Any? = nil
+    private var _nsLock: Any?
 
     private var nsLock: NSLock {
         _nsLock as! NSLock

diff --git a/Sources/SourceGraph/Elements/Declaration.swift b/Sources/SourceGraph/Elements/Declaration.swift
@@ -341,7 +341,7 @@ extension Declaration: Comparable {
 public struct DeclarationAccessibility {
     public let value: Accessibility
     public let isExplicit: Bool
-    
+
     public init(value: Accessibility, isExplicit: Bool) {
         self.value = value
         self.isExplicit = isExplicit

diff --git a/Sources/SourceGraph/Elements/ImportStatement.swift b/Sources/SourceGraph/Elements/ImportStatement.swift
@@ -5,7 +5,7 @@ public struct ImportStatement {
     public let isTestable: Bool
     public let isExported: Bool
     public let location: Location
-    
+
     public init(
         module: String,
         isTestable: Bool,

diff --git a/Sources/SourceGraph/Mutators/AccessibilityCascader.swift b/Sources/SourceGraph/Mutators/AccessibilityCascader.swift
@@ -20,16 +20,14 @@ final class AccessibilityCascader: SourceGraphMutator {
     // MARK: - Private
 
     private func cascadeAccessibility(for decls: [Declaration], only kinds: Set<Declaration.Kind> = []) throws {
-        for decl in decls {
-            if decl.accessibility.isExplicit {
-                for childDecl in decl.declarations {
-                    if !kinds.isEmpty && !kinds.contains(childDecl.kind) {
-                        continue
-                    }
+        for decl in decls where decl.accessibility.isExplicit {
+            for childDecl in decl.declarations {
+                if !kinds.isEmpty && !kinds.contains(childDecl.kind) {
+                    continue
+                }
 
-                    if !childDecl.accessibility.isExplicit {
-                        childDecl.accessibility = .init(value: decl.accessibility.value, isExplicit: false)
-                    }
+                if !childDecl.accessibility.isExplicit {
+                    childDecl.accessibility = .init(value: decl.accessibility.value, isExplicit: false)
                 }
             }
         }

diff --git a/Sources/SourceGraph/Mutators/InterfaceBuilderPropertyRetainer.swift b/Sources/SourceGraph/Mutators/InterfaceBuilderPropertyRetainer.swift
@@ -13,10 +13,8 @@ class InterfaceBuilderPropertyRetainer {
         let extensions = graph.declarations(ofKind: .extensionClass)
 
         for extDecl in extensions {
-            for decl in extDecl.declarations {
-                if decl.attributes.contains(where: { ibAttributes.contains($0) }) {
-                    graph.markRetained(decl)
-                }
+            for decl in extDecl.declarations where decl.attributes.contains(where: { ibAttributes.contains($0) }) {
+                graph.markRetained(decl)
             }
         }
     }
@@ -26,10 +24,8 @@ class InterfaceBuilderPropertyRetainer {
         let descendentInheritedDeclarations = inheritedDeclarations.map { $0.declarations }.joined()
         let allDeclarations = declaration.declarations.union(descendentInheritedDeclarations)
 
-        for declaration in allDeclarations {
-            if declaration.attributes.contains(where: { ibAttributes.contains($0) }) {
-                graph.markRetained(declaration)
-            }
+        for declaration in allDeclarations where declaration.attributes.contains(where: { ibAttributes.contains($0) }) {
+            graph.markRetained(declaration)
         }
     }
 }
diff --git a/Sources/SourceGraph/Mutators/PropertyWrapperRetainer.swift b/Sources/SourceGraph/Mutators/PropertyWrapperRetainer.swift
@@ -10,12 +10,10 @@ final class PropertyWrapperRetainer: SourceGraphMutator {
     }
 
     func mutate() {
-        for decl in graph.declarations(ofKinds: Declaration.Kind.toplevelAttributableKind) {
-            if decl.attributes.contains("propertyWrapper") {
-                decl.declarations
-                    .filter { $0.kind == .varInstance && specialProperties.contains($0.name ?? "") }
-                    .forEach { graph.markRetained($0) }
-            }
+        for decl in graph.declarations(ofKinds: Declaration.Kind.toplevelAttributableKind) where decl.attributes.contains("propertyWrapper") {
+            decl.declarations
+                .filter { $0.kind == .varInstance && specialProperties.contains($0.name ?? "") }
+                .forEach { graph.markRetained($0) }
         }
     }
 }
diff --git a/Sources/SourceGraph/Mutators/PubliclyAccessibleRetainer.swift b/Sources/SourceGraph/Mutators/PubliclyAccessibleRetainer.swift
@@ -18,7 +18,7 @@ final class PubliclyAccessibleRetainer: SourceGraphMutator {
         }
 
         let publicDeclarations = declarations.filter { $0.accessibility.value == .public || $0.accessibility.value == .open }
-        
+
         publicDeclarations.forEach { graph.markRetained($0) }
 
         // Enum cases inherit the accessibility of the enum.

diff --git a/Sources/SourceGraph/Mutators/ResultBuilderRetainer.swift b/Sources/SourceGraph/Mutators/ResultBuilderRetainer.swift
@@ -12,20 +12,18 @@ final class ResultBuilderRetainer: SourceGraphMutator {
         "buildArray(_:)",
         "buildBlock(_:)",
         "buildFinalResult(_:)",
-        "buildLimitedAvailability(_:)",
+        "buildLimitedAvailability(_:)"
     ])
 
     required init(graph: SourceGraph, configuration: Configuration) {
         self.graph = graph
     }
 
     func mutate() {
-        for decl in graph.declarations(ofKinds: Declaration.Kind.toplevelAttributableKind) {
-            if decl.attributes.contains("resultBuilder") {
-                for childDecl in decl.declarations {
-                    if let name = childDecl.name, resultBuilderMethods.contains(name) {
-                        graph.markRetained(childDecl)
-                    }
+        for decl in graph.declarations(ofKinds: Declaration.Kind.toplevelAttributableKind) where decl.attributes.contains("resultBuilder") {
+            for childDecl in decl.declarations {
+                if let name = childDecl.name, resultBuilderMethods.contains(name) {
+                    graph.markRetained(childDecl)
                 }
             }
         }

diff --git a/Sources/SourceGraph/Mutators/UnusedParameterRetainer.swift b/Sources/SourceGraph/Mutators/UnusedParameterRetainer.swift
@@ -35,7 +35,7 @@ final class UnusedParameterRetainer: SourceGraphMutator {
                         functionDecl.unusedParameters.forEach { graph.markRetained($0) }
                     }
                 } else {
-                    let overrideDecls = conformingDecls.flatMap { graph.allOverrideDeclarations(fromBase:$0) }
+                    let overrideDecls = conformingDecls.flatMap { graph.allOverrideDeclarations(fromBase: $0) }
                     let allFunctionDecls = conformingDecls + overrideDecls + extFuncDecls + [protoFuncDecl]
 
                     for functionDecl in allFunctionDecls {
@@ -90,10 +90,8 @@ final class UnusedParameterRetainer: SourceGraphMutator {
     }
 
     private func retain(params: [Declaration], usedIn functionDecls: [Declaration]) {
-        for param in params {
-            if isParam(param, usedInAnyOf: functionDecls) {
-                graph.markRetained(param)
-            }
+        for param in params where isParam(param, usedInAnyOf: functionDecls) {
+            graph.markRetained(param)
         }
     }
 

diff --git a/Tests/AccessibilityTests/AccessibilityProject/Package.swift b/Tests/AccessibilityTests/AccessibilityProject/Package.swift
@@ -9,7 +9,7 @@ let package = Package(
         .executable(
             name: "app",
             targets: ["MainTarget"]
-        ),
+        )
     ],
     targets: [
         .executableTarget(
@@ -23,6 +23,6 @@ let package = Package(
             dependencies: ["ExternalTarget"]),
         .testTarget(
             name: "TestTarget",
-            dependencies: ["MainTarget", "TargetA"]),
+            dependencies: ["MainTarget", "TargetA"])
     ]
 )
diff --git a/Tests/AccessibilityTests/AccessibilityProject/Sources/TargetA/IgnoreAllCommentCommand.swift b/Tests/AccessibilityTests/AccessibilityProject/Sources/TargetA/IgnoreAllCommentCommand.swift
@@ -8,4 +8,4 @@ public class IgnoreAllCommentCommandRetainer {
     public func retain() {
         _ = IgnoreAllCommentCommand()
     }
-}
+}