Load CSS from package resource when available (#192)

* Load CSS from package resource when available

* Fix warning: using '_' to ignore the result of a Void-returning function is redundant

* Add Changelog entry for #192

Author: mattt

.node/package.json

@@ -5,7 +5,7 @@
     "not dead"
   ],
   "scripts": {
-    "watch": "postcss -w ../Assets/**/*.css -o ../Resources/all.min.css --config ./postcss.config.js"
+    "watch": "postcss -w ../Assets/**/*.css -o ../Sources/swift-doc/Resources/all.min.css --config ./postcss.config.js"
   },
   "dependencies": {
     "cssnano": "^4.1.10",

Changelog.md

@@ -29,6 +29,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Changed GitHub Action to use prebuilt Docker image.
   #185 by @mattt and @MaxDesiatov.
+- Changed build command to load CSS from package resource when available.
+  #192 by @mattt.
 
 ## [1.0.0-beta.4] - 2020-07-31
 

Package.swift

@@ -40,6 +40,9 @@ let package = Package(
                 .product(name: "SwiftSyntaxHighlighter", package: "SwiftSyntaxHighlighter"),
                 .product(name: "Logging", package: "swift-log"),
                 .product(name: "LoggingGitHubActions", package: "LoggingGitHubActions")
+            ],
+            resources: [
+                .copy("Resources")
             ]
         ),
         .target(

Sources/SwiftDoc/SourceFile.swift

@@ -45,7 +45,7 @@ public struct SourceFile: Hashable, Codable {
             sourceLocationConverter = SourceLocationConverter(file: url.path(relativeTo: directory), tree: tree)
             super.init()
 
-            _ = walk(tree)
+            walk(tree)
 
             assert(context.isEmpty)
         }

Resources/all.min.css renamed to Sources/swift-doc/Resources/all.min.css

@@ -120,9 +120,26 @@ extension SwiftDoc {
         }
 
         if case .html = format {
-          let cssData = try fetchRemoteCSS()
-          let cssURL = outputDirectoryURL.appendingPathComponent("all.css")
-          try writeFile(cssData, to: cssURL)
+            let destinationURL = outputDirectoryURL.appendingPathComponent("all.css")
+
+            func fetchRemoteCSS() throws -> Data {
+              let url = URL(string: "https://raw.githubusercontent.com/SwiftDocOrg/swift-doc/master/Resources/all.min.css")!
+              return try Data(contentsOf: url)
+            }
+
+            #if swift(>=5.3)
+            if let resourceURL = Bundle.module.url(forResource: "all.min", withExtension: "css") {
+                if !fileManager.fileExists(atPath: destinationURL.path) {
+                    try fileManager.copyItem(at: resourceURL, to: destinationURL)
+                }
+            } else {
+                let cssData = try fetchRemoteCSS()
+                try writeFile(cssData, to: destinationURL)
+            }
+            #else
+            let cssData = try fetchRemoteCSS()
+            try writeFile(cssData, to: destinationURL)
+            #endif
         }
 
       } catch {
@@ -131,8 +148,3 @@ extension SwiftDoc {
     }
   }
 }
-
-func fetchRemoteCSS() throws -> Data {
-  let url = URL(string: "https://raw.githubusercontent.com/SwiftDocOrg/swift-doc/master/Resources/all.min.css")!
-  return try Data(contentsOf: url)
-}