Merge pull request #65 from kean/feature-base-url

mattt · web-flow · commit f3e218547b41 · 2020-04-09T07:41:51.000-07:00
Add baseURL option to generate command
diff --git a/Changelog.md b/Changelog.md
@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Added `--base-url` option.
+  #65 by @kean.
+
 ## [1.0.0-beta.2] - 2020-04-08
 
 ### Changed
diff --git a/Sources/swift-doc/Subcommands/Generate.swift b/Sources/swift-doc/Subcommands/Generate.swift
@@ -29,6 +29,11 @@ extension SwiftDoc {
                     default: .commonmark,
                     help: "The output format")
             var format: Format
+
+            @Option(name: .customLong("base-url"),
+                    default: "/",
+                    help: "The base URL used for all relative URLs in generated documents.")
+            var baseURL: String
         }
 
         static var configuration = CommandConfiguration(abstract: "Generates Swift documentation")
@@ -79,7 +84,7 @@ extension SwiftDoc {
                     }
 
                     let url = outputDirectoryURL.appendingPathComponent(filename)
-                    try page.write(to: url, format: format)
+                    try page.write(to: url, format: format, baseURL: options.baseURL)
                 } else {
                     switch format {
                     case .commonmark:
@@ -102,7 +107,7 @@ extension SwiftDoc {
                         }
 
                         let url = outputDirectoryURL.appendingPathComponent(filename)
-                        try $0.value.write(to: url, format: format)
+                        try $0.value.write(to: url, format: format, baseURL: options.baseURL)
                     }
                 }
             } catch {
diff --git a/Sources/swift-doc/Supporting Types/Components/Relationships.swift b/Sources/swift-doc/Supporting Types/Components/Relationships.swift
@@ -113,7 +113,7 @@ struct Relationships: Component {
                                 """#
                             } else {
                                 return #"""
-                                <dt class="\#(descriptor)"><code><a href="/\#(path(for: symbol))">\#(symbol.id)</a></code></dt>
+                                <dt class="\#(descriptor)"><code><a href="\#(path(for: symbol))">\#(symbol.id)</a></code></dt>
                                 <dd>\#(commonmark: symbol.documentation?.summary ?? "")</dd>
                                 """#
                             }
diff --git a/Sources/swift-doc/Supporting Types/Helpers.swift b/Sources/swift-doc/Supporting Types/Helpers.swift
@@ -12,7 +12,7 @@ public func linkCodeElements(of html: String, for symbol: Symbol, in module: Mod
             let candidate = candidates.filter({ $0 != symbol }).first
         {
             let a = Element(name: "a")
-            a["href"] = "/" + path(for: candidate)
+            a["href"] = path(for: candidate)
             element.wrap(inside: a)
         }
     }
diff --git a/Sources/swift-doc/Supporting Types/Layout.swift b/Sources/swift-doc/Supporting Types/Layout.swift
@@ -1,7 +1,7 @@
 import HypertextLiteral
 import Foundation
 
-func layout(_ page: Page) -> HTML {
+func layout(_ page: Page, baseURL: String) -> HTML {
     let html = page.html
 
     return #"""
@@ -11,13 +11,14 @@ func layout(_ page: Page) -> HTML {
         <meta charset="UTF-8">
         <meta name="viewport" content="width=device-width, initial-scale=1.0">
         <title>\#(page.module.name) - \#(page.title)</title>
+        <base href="\#(baseURL)"/>
         <style type="text/css">
         \#(unsafeUnescaped: css)
         </style>
     </head>
     <body>
         <header>
-            <a href="/">
+            <a href="\#(baseURL)">
                 <strong>
                     \#(page.module.name)
                 </strong>
diff --git a/Sources/swift-doc/Supporting Types/Page.swift b/Sources/swift-doc/Supporting Types/Page.swift
@@ -19,13 +19,13 @@ extension Page {
 }
 
 extension Page {
-    func write(to url: URL, format: SwiftDoc.Generate.Format) throws {
+    func write(to url: URL, format: SwiftDoc.Generate.Format, baseURL: String) throws {
         let data: Data?
         switch format {
         case .commonmark:
             data = document.render(format: .commonmark).data(using: .utf8)
         case .html:
-            data = layout(self).description.data(using: .utf8)
+            data = layout(self, baseURL: baseURL).description.data(using: .utf8)
         }
 
         let fileManager = FileManager.default

Original file line number	Diff line number	Diff line change
`@@ -29,6 +29,11 @@ extension SwiftDoc {`
`29`	`29`	`default: .commonmark,`
`30`	`30`	`help: "The output format")`
`31`	`31`	`var format: Format`
	`32`	`+`
	`33`	`+ @Option(name: .customLong("base-url"),`
	`34`	`+ default: "/",`
	`35`	`+ help: "The base URL used for all relative URLs in generated documents.")`
	`36`	`+ var baseURL: String`
`32`	`37`	`}`
`33`	`38`
`34`	`39`	`static var configuration = CommandConfiguration(abstract: "Generates Swift documentation")`
`@@ -79,7 +84,7 @@ extension SwiftDoc {`
`79`	`84`	`}`
`80`	`85`
`81`	`86`	`let url = outputDirectoryURL.appendingPathComponent(filename)`
`82`		`- try page.write(to: url, format: format)`
	`87`	`+ try page.write(to: url, format: format, baseURL: options.baseURL)`
`83`	`88`	`} else {`
`84`	`89`	`switch format {`
`85`	`90`	`case .commonmark:`
`@@ -102,7 +107,7 @@ extension SwiftDoc {`
`102`	`107`	`}`
`103`	`108`
`104`	`109`	`let url = outputDirectoryURL.appendingPathComponent(filename)`
`105`		`- try $0.value.write(to: url, format: format)`
	`110`	`+ try $0.value.write(to: url, format: format, baseURL: options.baseURL)`
`106`	`111`	`}`
`107`	`112`	`}`
`108`	`113`	`} catch {`
Original file line number	Diff line number	Diff line change
`@@ -113,7 +113,7 @@ struct Relationships: Component {`
`113`	`113`	`"""#`
`114`	`114`	`} else {`
`115`	`115`	`return #"""`
`116`		`- <dt class="\#(descriptor)"><code><a href="/\#(path(for: symbol))">\#(symbol.id)</a></code></dt>`
	`116`	`+ <dt class="\#(descriptor)"><code><a href="\#(path(for: symbol))">\#(symbol.id)</a></code></dt>`
`117`	`117`	`<dd>\#(commonmark: symbol.documentation?.summary ?? "")</dd>`
`118`	`118`	`"""#`
`119`	`119`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ public func linkCodeElements(of html: String, for symbol: Symbol, in module: Mod`
`12`	`12`	`let candidate = candidates.filter({ $0 != symbol }).first`
`13`	`13`	`{`
`14`	`14`	`let a = Element(name: "a")`
`15`		`- a["href"] = "/" + path(for: candidate)`
	`15`	`+ a["href"] = path(for: candidate)`
`16`	`16`	`element.wrap(inside: a)`
`17`	`17`	`}`
`18`	`18`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,13 +19,13 @@ extension Page {`
`19`	`19`	`}`
`20`	`20`
`21`	`21`	`extension Page {`
`22`		`- func write(to url: URL, format: SwiftDoc.Generate.Format) throws {`
	`22`	`+ func write(to url: URL, format: SwiftDoc.Generate.Format, baseURL: String) throws {`
`23`	`23`	`let data: Data?`
`24`	`24`	`switch format {`
`25`	`25`	`case .commonmark:`
`26`	`26`	`data = document.render(format: .commonmark).data(using: .utf8)`
`27`	`27`	`case .html:`
`28`		`- data = layout(self).description.data(using: .utf8)`
	`28`	`+ data = layout(self, baseURL: baseURL).description.data(using: .utf8)`
`29`	`29`	`}`
`30`	`30`
`31`	`31`	`let fileManager = FileManager.default`