Add ability to use relative paths with convert --checkout-path argument

Author: Anthony-Eid

Sources/SwiftDocC/SourceRepository/SourceRepository.swift

@@ -14,13 +14,13 @@ import Foundation
 public struct SourceRepository {
     /// The path at which the repository is cloned locally.
     public var checkoutPath: String
-    
+
     /// The base URL where the service hosts the repository's contents.
     public var sourceServiceBaseURL: URL
-    
+
     /// A function that formats a line number to be included in a URL.
     public var formatLineNumber: (Int) -> String
-    
+
     /// Creates a source code repository.
     /// - Parameters:
     ///   - checkoutPath: The path at which the repository is checked out locally and from which its symbol graphs were generated.
@@ -31,11 +31,17 @@ public struct SourceRepository {
         sourceServiceBaseURL: URL,
         formatLineNumber: @escaping (Int) -> String
     ) {
+        if checkoutPath.starts(with: "/") {
+            self.checkoutPath = checkoutPath
+        } else {
+            self.checkoutPath = "\(FileManager.default.currentDirectoryPath)/\(checkoutPath)"
+        }
+
         self.checkoutPath = checkoutPath
         self.sourceServiceBaseURL = sourceServiceBaseURL
         self.formatLineNumber = formatLineNumber
     }
-    
+
     /// Formats a local source file URL to a URL hosted by the remote source code service.
     /// - Parameters:
     ///   - sourceFileURL: The location of the source file on disk.
@@ -45,7 +51,7 @@ public struct SourceRepository {
         guard sourceFileURL.path.hasPrefix(checkoutPath) else {
             return nil
         }
-        
+
         let path = sourceFileURL.path.dropFirst(checkoutPath.count).removingLeadingSlash
         return sourceServiceBaseURL
             .appendingPathComponent(path)
@@ -65,7 +71,7 @@ public extension SourceRepository {
             formatLineNumber: { line in "L\(line)" }
         )
     }
-    
+
     /// Creates a source repository hosted by the GitLab service.
     /// - Parameters:
     ///   - checkoutPath: The path of the local checkout.
@@ -77,7 +83,7 @@ public extension SourceRepository {
             formatLineNumber: { line in "L\(line)" }
         )
     }
-    
+
     /// Creates a source repository hosted by the BitBucket service.
     /// - Parameters:
     ///   - checkoutPath: The path of the local checkout.
@@ -89,7 +95,7 @@ public extension SourceRepository {
             formatLineNumber: { line in "lines-\(line)" }
         )
     }
-    
+
     /// Creates a source repository hosted by the device's filesystem.
     ///
     /// Use this source repository to format `doc-source-file://` links to files on the
@@ -98,7 +104,7 @@ public extension SourceRepository {
     /// This source repository uses a custom scheme to offer more control local source file navigation.
     static func localFilesystem() -> SourceRepository {
         SourceRepository(
-            checkoutPath: "",
+            checkoutPath: "/",
             // 2 slashes to specify an empty authority/host component and 1 slash to specify a base path at the root.
             sourceServiceBaseURL: URL(string: "doc-source-file:///")!,
             formatLineNumber: { line in "L\(line)" }

Tests/SwiftDocCUtilitiesTests/ArgumentParsing/ConvertSubcommandSourceRepositoryTests.swift

@@ -20,13 +20,13 @@ class ConvertSubcommandSourceRepositoryTests: XCTestCase {
         withExtension: "docc",
         subdirectory: "Test Bundles"
     )!
-    
+
     private let testTemplateURL = Bundle.module.url(
         forResource: "Test Template",
         withExtension: nil,
         subdirectory: "Test Resources"
     )!
-    
+
     func testSourceRepositoryAllArgumentsSpecified() throws {
         for sourceService in ["github", "gitlab", "bitbucket"] {
             try assertSourceRepositoryArguments(
@@ -39,7 +39,7 @@ class ConvertSubcommandSourceRepositoryTests: XCTestCase {
             }
         }
     }
-    
+
     func testDoesNotSetSourceRepositoryIfBothCheckoutPathAndsourceServiceBaseURLArgumentsAreMissing() throws {
         try assertSourceRepositoryArguments(
             checkoutPath: nil,
@@ -49,7 +49,7 @@ class ConvertSubcommandSourceRepositoryTests: XCTestCase {
             XCTAssertNil(action.sourceRepository)
         }
     }
-    
+
     func testThrowsValidationErrorWhenSourceServiceIsSpecifiedButNotSourceServiceBaseURL() throws {
         XCTAssertThrowsError(
             try assertSourceRepositoryArguments(
@@ -67,7 +67,7 @@ class ConvertSubcommandSourceRepositoryTests: XCTestCase {
             )
         }
     }
-    
+
     func testThrowsValidationErrorWhenSourceServiceBaseURLIsSpecifiedButNotSourceService() throws {
         XCTAssertThrowsError(
             try assertSourceRepositoryArguments(
@@ -85,7 +85,7 @@ class ConvertSubcommandSourceRepositoryTests: XCTestCase {
             )
         }
     }
-    
+
     func testThrowsValidationErrorWhenSourceServiceBaseURLIsInvalid() throws {
         XCTAssertThrowsError(
             try assertSourceRepositoryArguments(
@@ -100,7 +100,7 @@ class ConvertSubcommandSourceRepositoryTests: XCTestCase {
             )
         }
     }
-    
+
     func testThrowsValidationErrorWhenCheckoutPathIsNotSpecified() throws {
         XCTAssertThrowsError(
             try assertSourceRepositoryArguments(
@@ -118,7 +118,7 @@ class ConvertSubcommandSourceRepositoryTests: XCTestCase {
             )
         }
     }
-    
+
     func testThrowsValidationErrorWhenSourceServiceIsInvalid() throws {
         XCTAssertThrowsError(
             try assertSourceRepositoryArguments(
@@ -133,15 +133,15 @@ class ConvertSubcommandSourceRepositoryTests: XCTestCase {
             )
         }
     }
-    
+
     private func assertSourceRepositoryArguments(
         checkoutPath: String?,
         sourceService: String?,
         sourceServiceBaseURL: String?,
         assertion: ((ConvertAction) throws -> Void)? = nil
     ) throws {
         SetEnvironmentVariable(TemplateOption.environmentVariableKey, testTemplateURL.path)
-        
+
         var arguments: [String] = [testBundleURL.path]
         if let checkoutPath {
             arguments.append(contentsOf: ["--checkout-path", checkoutPath])
@@ -152,9 +152,9 @@ class ConvertSubcommandSourceRepositoryTests: XCTestCase {
         if let sourceServiceBaseURL {
             arguments.append(contentsOf: ["--source-service-base-url", sourceServiceBaseURL])
         }
-        
+
         let convertOptions = try Docc.Convert.parse(arguments)
-        
+
         let result = try ConvertAction(fromConvertCommand: convertOptions)
         try assertion?(result)
     }