Merge pull request #6 from 0xWDG/swiftlint-fixes

Author: nanashili

.swiftlint.yml

@@ -17,6 +17,7 @@ identifier_name:
   excluded:
     - id
     - vc
+    - to
     # (short) File extensions:
     - c
     - m

.swiftpm/xcode/xcshareddata/xcschemes/Version-Control.xcscheme

@@ -0,0 +1,66 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Scheme
+   LastUpgradeVersion = "1500"
+   version = "1.7">
+   <BuildAction
+      parallelizeBuildables = "YES"
+      buildImplicitDependencies = "YES">
+      <BuildActionEntries>
+         <BuildActionEntry
+            buildForTesting = "YES"
+            buildForRunning = "YES"
+            buildForProfiling = "YES"
+            buildForArchiving = "YES"
+            buildForAnalyzing = "YES">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "Version-Control"
+               BuildableName = "Version-Control"
+               BlueprintName = "Version-Control"
+               ReferencedContainer = "container:">
+            </BuildableReference>
+         </BuildActionEntry>
+      </BuildActionEntries>
+   </BuildAction>
+   <TestAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      shouldAutocreateTestPlan = "YES">
+   </TestAction>
+   <LaunchAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      launchStyle = "0"
+      useCustomWorkingDirectory = "NO"
+      ignoresPersistentStateOnLaunch = "NO"
+      debugDocumentVersioning = "YES"
+      debugServiceExtension = "internal"
+      allowLocationSimulation = "YES">
+   </LaunchAction>
+   <ProfileAction
+      buildConfiguration = "Release"
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      savedToolIdentifier = ""
+      useCustomWorkingDirectory = "NO"
+      debugDocumentVersioning = "YES">
+      <MacroExpansion>
+         <BuildableReference
+            BuildableIdentifier = "primary"
+            BlueprintIdentifier = "Version-Control"
+            BuildableName = "Version-Control"
+            BlueprintName = "Version-Control"
+            ReferencedContainer = "container:">
+         </BuildableReference>
+      </MacroExpansion>
+   </ProfileAction>
+   <AnalyzeAction
+      buildConfiguration = "Debug">
+   </AnalyzeAction>
+   <ArchiveAction
+      buildConfiguration = "Release"
+      revealArchiveInOrganizer = "YES">
+   </ArchiveAction>
+</Scheme>

Sources/Version-Control/Services/Models/Client/Add.swift

@@ -18,7 +18,7 @@ public struct Add {
      */
     func addConflictedFile(directoryURL: URL,
                            file: GitFileItem) async throws {
-        
+
         try ShellClient().run("cd \(directoryURL.relativePath.escapedWhiteSpaces()); git add -- \(file.url)")
     }
 }

Sources/Version-Control/Services/Models/Client/Apply.swift

@@ -10,7 +10,7 @@
 import Foundation
 
 public struct Apply {
-    
+
     /// Applies a Git patch to the Git index for a specified file in a specified directory.
     ///
     /// - Parameters:
@@ -21,7 +21,9 @@ public struct Apply {
     ///   - An error of type `Error` if any issues occur during the patch application process.
     ///
     /// - Note:
-    ///   If the file was renamed (`file.gitStatus == .renamed`), this function recreates the rename operation by staging the removal of the old file and adding the old file's blob to the index under the new name.
+    ///   If the file was renamed (`file.gitStatus == .renamed`), \
+    ///   this function recreates the rename operation by staging the removal of the old file \
+    ///   and adding the old file's blob to the index under the new name.
     ///
     /// - Example:
     ///   ```swift

Sources/Version-Control/Services/Models/Client/Branch.swift

@@ -10,9 +10,9 @@
 import Foundation
 
 public struct Branch {
-    
+
     public init() {}
-    
+
     /// Retrieves the name of the current Git branch in a specified directory.
     ///
     /// - Parameters:
@@ -47,7 +47,8 @@ public struct Branch {
     /// Retrieves a list of Git branches in a specified directory.
     ///
     /// - Parameters:
-    ///   - allBranches: A Boolean flag indicating whether to list all branches, including remote branches (default is `false`).
+    ///   - allBranches: A Boolean flag indicating whether to list all branches, \
+    ///                  including remote branches (default is `false`).
     ///   - directoryURL: The URL of the directory containing the Git repository.
     ///
     /// - Throws:
@@ -168,7 +169,8 @@ public struct Branch {
     ///   - An error of type `Error` if any issues occur during the branch renaming process.
     ///
     /// - Note:
-    ///   If the branch renaming is successful, the old branch name will no longer exist, and a new branch with the specified `newName` will be created.
+    ///   If the branch renaming is successful, the old branch name will no longer exist, \
+    ///   and a new branch with the specified `newName` will be created.
     ///
     /// - Example:
     ///   ```swift
@@ -203,7 +205,8 @@ public struct Branch {
     ///   - An error of type `Error` if any issues occur during the branch deletion process.
     ///
     /// - Returns:
-    ///   A `Bool` value indicating whether the branch was successfully deleted. Returns `true` if the branch was deleted successfully; otherwise, returns `false`.
+    ///   A `Bool` value indicating whether the branch was successfully deleted. \
+    ///   Returns `true` if the branch was deleted successfully; otherwise, returns `false`.
     ///
     /// - Example:
     ///   ```swift
@@ -229,12 +232,11 @@ public struct Branch {
         /// Prepare and execute the Git command to delete the local branch using a ShellClient.
         try ShellClient().run(
             "cd \(directoryURL.relativePath.escapedWhiteSpaces());git branch -D \(branchName)")
-        
+
         // Return true to indicate that the branch deletion was attempted.
         return true
     }
 
-
     /// Deletes a remote Git branch in a specified directory.
     ///
     /// - Parameters:
@@ -246,7 +248,9 @@ public struct Branch {
     ///   - An error of type `Error` if any issues occur during the remote branch deletion process.
     ///
     /// - Note:
-    ///   This function attempts to delete the remote branch on the specified remote repository. If the deletion fails due to the remote branch already being deleted or for any other reason, it may try to remove the corresponding local reference.
+    ///   This function attempts to delete the remote branch on the specified remote repository. \
+    ///   If the deletion fails due to the remote branch already being deleted or for any other reason, \
+    ///   it may try to remove the corresponding local reference.
     ///
     /// - Example:
     ///   ```swift
@@ -255,7 +259,11 @@ public struct Branch {
     ///   let remoteBranchName = "feature/old-feature"
     ///
     ///   do {
-    ///       try deleteRemoteBranch(directoryURL: directoryURL, remoteName: remoteName, remoteBranchName: remoteBranchName)
+    ///       try deleteRemoteBranch(
+    ///           directoryURL: directoryURL,
+    ///           remoteName: remoteName,
+    ///           remoteBranchName: remoteBranchName
+    ///       )
     ///       print("Remote branch '\(remoteBranchName)' was successfully deleted on '\(remoteName)'.")
     ///   } catch {
     ///       print("Error deleting remote branch: \(error.localizedDescription)")
@@ -330,17 +338,17 @@ public struct Branch {
             "--points-at=\(commitsh)",
             "--format=%(refname:short)"
         ]
-        
+
         let result = try ShellClient.live().run(
             "cd \(directoryURL.relativePath.escapedWhiteSpaces());git \(args)")
-        
+
         let resultSplit = result.split(separator: "\n").map { String($0) }
         let resultRange = Array(resultSplit.reversed())
         return resultRange.isEmpty ? nil : resultRange
     }
 
-
-    /// Retrieves a dictionary of branch names and their corresponding commit SHAs that are merged into the specified branch.
+    /// Retrieves a dictionary of branch names and their corresponding commit SHAs \
+    /// that are merged into the specified branch.
     ///
     /// - Parameters:
     ///   - directoryURL: The URL of the directory containing the Git repository.
@@ -350,7 +358,8 @@ public struct Branch {
     ///   - An error of type `Error` if any issues occur during the branch retrieval process.
     ///
     /// - Returns:
-    ///   A dictionary containing branch names as keys and their corresponding commit SHAs as values, representing branches that are merged into the specified branch.
+    ///   A dictionary containing branch names as keys and their corresponding commit SHAs as values, \
+    ///   representing branches that are merged into the specified branch.
     ///
     /// - Example:
     ///   ```swift
@@ -377,19 +386,19 @@ public struct Branch {
     func getMergedBranches(directoryURL: URL,
                            branchName: String) throws -> [String: String] {
         let canonicalBranchRef = Refs().formatAsLocalRef(name: branchName)
-        
+
         let args = ["branch", "--format=%(refname):%(objectname)", "--merged", branchName]
-        
+
         do {
             let result = try ShellClient().run("cd \(directoryURL.relativePath.escapedWhiteSpaces());git \(args)")
-            
+
             var mergedBranches = [String: String]()
             for line in result.split(separator: "\n") {
                 let components = line.split(separator: ":", maxSplits: 1)
                 if components.count == 2 {
                     let ref = String(components[0])
                     let sha = String(components[1])
-                    
+
                     // Don't include the branch we're using to compare against
                     // in the list of branches merged into that branch.
                     if ref != canonicalBranchRef {
@@ -402,4 +411,4 @@ public struct Branch {
             throw error
         }
     }
-}
+} // swiftlint:disable:this file_length

Sources/Version-Control/Services/Models/Client/Check.swift

@@ -9,16 +9,18 @@
 import Foundation
 
 public struct Check {
-    
+
     public init() {}
- 
+
     /// Checks if a given workspace directory is a Git repository or a Git worktree.
     ///
     /// - Parameter workspaceURL: The URL of the workspace directory to be checked.
     ///
     /// - Returns: `true` if the workspace is a Git repository or worktree, `false` otherwise.
     ///
-    /// - Note: This function checks the type of the workspace using `getRepositoryType`, and if it's marked as unsafe by Git, it falls back to a naive approximation by looking for the `.git` directory.
+    /// - Note: This function checks the type of the workspace using `getRepositoryType`, \
+    ///   and if it's marked as unsafe by Git, \
+    ///   it falls back to a naive approximation by looking for the `.git` directory.
     ///
     /// - Example:
     ///   ```swift

Sources/Version-Control/Services/Models/Client/Checkout.swift

@@ -10,9 +10,9 @@
 import Foundation
 
 public struct Checkout {
-    
+
     public init() {}
-    
+
     /// Checks out a Git branch in a specified directory.
     ///
     /// - Parameters:
@@ -93,7 +93,11 @@ public struct Checkout {
     ///   let resolutionStrategy = ManualConflictResolution.ours // Replace with the desired resolution strategy
     ///
     ///   do {
-    ///       try checkoutConflictedFile(directoryURL: directoryURL, file: conflictedFile, resolution: resolutionStrategy)
+    ///       try checkoutConflictedFile(
+    ///           directoryURL: directoryURL,
+    ///           file: conflictedFile,
+    ///           resolution: resolutionStrategy
+    ///       )
     ///       print("File '\(conflictedFile.url.relativePath)' checked out with \(resolutionStrategy) resolution.")
     ///   } catch {
     ///       print("Error checking out conflicted file: \(error.localizedDescription)")
@@ -111,7 +115,7 @@ public struct Checkout {
             "--",
             file.url.relativePath
         ]
-        
+
         try ShellClient().run("cd \(directoryURL.relativePath.escapedWhiteSpaces());git \(args)")
     }
 }

Sources/Version-Control/Services/Models/Client/Cherry-Pick.swift

@@ -10,9 +10,9 @@
 import Foundation
 
 public struct CherryPick {
-    
+
     public init() {}
-    
+
     /// The app-specific results from attempting to cherry pick commits
     enum CherryPickResult: String {
         /// Git completed the cherry pick without reporting any errors, and the caller can
@@ -133,10 +133,13 @@ public struct CherryPick {
     public func isCherryPickHeadFound(directoryURL: URL) -> Bool {
         do {
             let cherryPickHeadPath = try String(contentsOf: directoryURL) + ".git/CHERRY_PICK_HEAD"
-            
+
             return FileManager.default.fileExists(atPath: cherryPickHeadPath)
         } catch {
-            print("[cherryPick] A problem was encountered reading .git/CHERRY_PICK_HEAD, so it is unsafe to continue cherry-picking.")
+            print(
+                "[cherryPick] A problem was encountered reading .git/CHERRY_PICK_HEAD," +
+                " so it is unsafe to continue cherry-picking."
+            )
             return false
         }
     }

Sources/Version-Control/Services/Models/Client/Clone.swift

@@ -10,7 +10,7 @@
 import Foundation
 
 public struct Clone {
-    
+
     public init() {}
 
     /// Clones a repository from a given url into to the specified path.

Sources/Version-Control/Services/Models/Client/Commit.swift

@@ -10,7 +10,7 @@
 import Foundation
 
 public struct Commit {
-    
+
     public init() {}
 
     /// Creates a Git commit in a specified Git repository directory.