Add Github URLs (#12)

Author: tothambrus11

Sources/CLI/CLI.swift

@@ -158,7 +158,8 @@ public struct CLICore {
         InputModuleInfo(
           name: "Hylo",
           rootFolderPath: modulePaths[0],
-          astId: coreLibraryId
+          astId: coreLibraryId,
+          openSourceUrlBase: URL(string: "https://github.com/hylo-lang/hylo/blob/main/StandardLibrary/Sources/")!
         )
       ],
       ast
@@ -192,7 +193,8 @@ public struct CLICore {
 
       return InputModuleInfo(
         name: "\(sourceURL.lastPathComponent)",
-        rootFolderPath: sourceURL, astId: rootModuleId
+        rootFolderPath: sourceURL, astId: rootModuleId,
+        openSourceUrlBase: nil // todo: allow input of open source url base
       )
     }
 

Sources/DocExtractor/RealAssetScanner.swift

@@ -8,11 +8,13 @@ public struct InputModuleInfo {
   public let name: String
   public let rootFolderPath: URL
   public let astId: ModuleDecl.ID
+  public let openSourceUrlBase: URL?
 
-  public init(name: String, rootFolderPath: URL, astId: ModuleDecl.ID) {
+  public init(name: String, rootFolderPath: URL, astId: ModuleDecl.ID, openSourceUrlBase: URL?) {
     self.name = name
     self.rootFolderPath = rootFolderPath
     self.astId = astId
+    self.openSourceUrlBase = openSourceUrlBase
   }
 }
 
@@ -22,7 +24,8 @@ extension ModuleInfo {
       name: inputInfo.name,
       rootFolderPath: inputInfo.rootFolderPath,
       astId: inputInfo.astId,
-      rootFolder: rootFolderId
+      rootFolder: rootFolderId,
+      openSourceUrlBase: inputInfo.openSourceUrlBase
     )
   }
 }
@@ -177,7 +180,7 @@ public struct DocDBBuildingAssetScanner<SFDocumentor: SourceFileDocumentor>: Ass
 
   public mutating func build() -> Result<DocumentationDatabase, DocExtractionError<Self>> {
     modules
-      .map { module in
+      .map { (module: InputModuleInfo) in
         recursivelyVisitFolder(
           folderPath: module.rootFolderPath.absoluteURL,
           visitor: &self,
@@ -186,7 +189,7 @@ public struct DocDBBuildingAssetScanner<SFDocumentor: SourceFileDocumentor>: Ass
         .map { (module, rootFolderId: $0) }
       }
       .collectResults()
-      .map { extendedModuleInfos in
+      .map { (extendedModuleInfos: [(module: InputModuleInfo, rootFolderId: FolderAsset.ID)]) in
         DocumentationDatabase(
           assets: assets,
           symbols: symbolDocs,

Sources/DocumentationDB/ModuleInfo.swift

@@ -6,11 +6,16 @@ public struct ModuleInfo: IdentifiedEntity {
   public let rootFolderPath: URL
   public let rootFolder: FolderAsset.ID
   public let astId: ModuleDecl.ID
+  /// The base URL for the open source repository where we should link to the source code.
+  /// 
+  /// E.g. https://github.com/hylo-lang/hylo/blob/main/StandardLibrary/Sources/
+  public let openSourceUrlBase: URL?
 
-  public init(name: String, rootFolderPath: URL, astId: ModuleDecl.ID, rootFolder: FolderAsset.ID) {
+  public init(name: String, rootFolderPath: URL, astId: ModuleDecl.ID, rootFolder: FolderAsset.ID, openSourceUrlBase: URL?) {
     self.name = name
     self.rootFolderPath = rootFolderPath
     self.rootFolder = rootFolder
     self.astId = astId
+    self.openSourceUrlBase = openSourceUrlBase
   }
 }

Sources/WebsiteGen/Generation/GeneratePages.swift

@@ -162,12 +162,15 @@ public func generateModuleIndex(_ context: inout GenerationContext) throws {
 public func generateTree(_ stencil: inout Environment, _ documentation: DocumentationContext) throws
   -> String
 {
-  return try documentation.targetResolver.rootTargets.map {
-    documentation.targetResolver.navigationItemFromTarget(targetId: $0)
-  }
-  .filter { $0 != nil }
-  .map {
-    try stencil.renderTemplate(name: "page_components/tree_item.html", context: ["item": $0 as Any])
-  }
-  .joined(separator: "\n")
+  return try documentation.targetResolver.rootTargets
+    .compactMap {
+      documentation.targetResolver.navigationItemFromTarget(targetId: $0)
+    }
+    .map {
+      try stencil.renderTemplate(
+        name: "page_components/tree_item.html",
+        context: ["item": $0 as Any]
+      )
+    }
+    .joined(separator: "\n")
 }

Sources/WebsiteGen/Resolution/Navigation.swift

@@ -6,6 +6,7 @@ public struct NavigationItem {
   let name: String
   let url: URL
   let cssClassOfTarget: String
+  let openSourceUrl: URL?
 
   // Relations
   let children: [NavigationItem]