Rename category documentation "path" to "URL"

Since we're creating a hyperlink to it, we want a URL here.

Author: DougGregor

Sources/SwiftDiagnostics/DiagnosticDecorators/ANSIDiagnosticDecorator.swift

@@ -84,8 +84,8 @@ extension DiagnosticDecorator where Self == ANSIDiagnosticDecorator {
       // Make the category name a link to the documentation, if there is
       // documentation.
       let categoryName: String
-      if let documentationPath = category.documentationPath {
-        categoryName = ANSIAnnotation.hyperlink(category.name, to: documentationPath)
+      if let documentationURL = category.documentationURL {
+        categoryName = ANSIAnnotation.hyperlink(category.name, to: "\(documentationURL)")
       } else {
         categoryName = category.name
       }
@@ -240,6 +240,9 @@ private struct ANSIAnnotation {
   }
 
   /// Forms a hyperlink to the given URL with the given text.
+  ///
+  /// This follows the OSC 8 standard for hyperlinks that is supported by
+  /// a number of different terminals.
   static func hyperlink(_ text: String, to url: String) -> String {
     "\u{001B}]8;;\(url)\u{001B}\\\(text)\u{001B}]8;;\u{001B}\\"
   }

Sources/SwiftDiagnostics/Message.swift

@@ -39,12 +39,12 @@ public struct DiagnosticCategory: Sendable, Hashable {
   /// Name that identifies the category, e.g., StrictMemorySafety.
   public let name: String
 
-  /// Path to a file providing documentation documentation for this category.
-  public let documentationPath: String?
+  /// URL providing documentation documentation for this category.
+  public let documentationURL: String?
 
-  public init(name: String, documentationPath: String?) {
+  public init(name: String, documentationURL: String?) {
     self.name = name
-    self.documentationPath = documentationPath
+    self.documentationURL = documentationURL
   }
 }
 

Tests/SwiftDiagnosticsTest/DiagnosticDecorators/ANSIDiagnosticDecoratorTests.swift

@@ -38,7 +38,7 @@ final class ANSIDiagnosticDecoratorTests: XCTestCase {
     let decoratedMessageWithCategory = decorator.decorateMessage(
       message,
       basedOnSeverity: .error,
-      category: DiagnosticCategory(name: "Filesystem", documentationPath: "http://www.swift.org")
+      category: DiagnosticCategory(name: "Filesystem", documentationURL: "http://www.swift.org")
     )
     assertStringsEqualWithDiff(decoratedMessageWithCategory, "\u{1B}[1;31merror: \u{1B}[1;39mFile not found\u{1B}[0;0m [#\u{001B}]8;;http://www.swift.org\u{001B}\\Filesystem\u{001B}]8;;\u{001B}\\]")
   }

Tests/SwiftDiagnosticsTest/DiagnosticDecorators/BasicDiagnosticDecoratorTests.swift

@@ -38,7 +38,7 @@ final class BasicDiagnosticDecoratorTests: XCTestCase {
     let decoratedMessageWithCategory = decorator.decorateMessage(
       message,
       basedOnSeverity: .error,
-      category: DiagnosticCategory(name: "Filesystem", documentationPath: "http://www.swift.org")
+      category: DiagnosticCategory(name: "Filesystem", documentationURL: "http://www.swift.org")
     )
     assertStringsEqualWithDiff(decoratedMessageWithCategory, "error: File not found [#Filesystem]")
   }