Add support for Swift 5.4 / Xcode 12.5 (#252)

mattt · web-flow · commit c3f476dd8dd9 · 2021-04-24T03:22:10.000-07:00
* Add Brewfile.lock.json file

* Update dependencies

Fix CommonMark version specifier

* Add version-specific manifest for Swift 5.4

* Change minimum Swift version requirements to version 5.3+

* Fix failing tests
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -13,8 +13,7 @@ jobs:
     strategy:
       matrix:
         xcode:
-          - "11.7" # Swift 5.2
-          - "12.2" # Swift 5.3
+          - "12.4" # Swift 5.3
 
     name: "macOS Big Sur (Xcode ${{ matrix.xcode }})"
 
@@ -42,8 +41,7 @@ jobs:
     strategy:
       matrix:
         xcode:
-          - "11.7" # Swift 5.2
-          - "12" # Swift 5.3
+          - "12.4" # Swift 5.3
 
     name: "macOS Catalina (Xcode ${{ matrix.xcode }})"
 
@@ -70,7 +68,7 @@ jobs:
 
     strategy:
       matrix:
-        swift: ["5.3", "5.2"]
+        swift: ["5.3"]
 
     name: "Linux (Swift ${{ matrix.swift }})"
 
diff --git a/Brewfile.lock.json b/Brewfile.lock.json
@@ -2,28 +2,30 @@
   "entries": {
     "brew": {
       "graphviz": {
-        "version": "2.47.0",
+        "version": "2.47.1",
         "bottle": {
           "rebuild": 0,
-          "cellar": "/usr/local/Cellar",
-          "prefix": "/usr/local",
-          "root_url": "https://homebrew.bintray.com/bottles",
+          "root_url": "https://ghcr.io/v2/homebrew/core",
           "files": {
             "arm64_big_sur": {
-              "url": "https://homebrew.bintray.com/bottles/graphviz-2.47.0.arm64_big_sur.bottle.tar.gz",
-              "sha256": "e4263e38be3d51648bffba45b0572dafd16254ce27fc3d1b13c555dff1110d5a"
+              "cellar": "/opt/homebrew/Cellar",
+              "url": "https://ghcr.io/v2/homebrew/core/graphviz/blobs/sha256:d9830966d41ef07d40f0a269597051dc3bd317f1f834f8eebf220d7fee6e06cb",
+              "sha256": "d9830966d41ef07d40f0a269597051dc3bd317f1f834f8eebf220d7fee6e06cb"
             },
             "big_sur": {
-              "url": "https://homebrew.bintray.com/bottles/graphviz-2.47.0.big_sur.bottle.tar.gz",
-              "sha256": "7972126b79753efa1f0c3519d6a063079cb1ff02c69759864a865e4ae6b4f193"
+              "cellar": "/usr/local/Cellar",
+              "url": "https://ghcr.io/v2/homebrew/core/graphviz/blobs/sha256:41c4fe36cca429a201173d6f282bbc3e12ac9ae397736da75f2beb5c4c0d2e33",
+              "sha256": "41c4fe36cca429a201173d6f282bbc3e12ac9ae397736da75f2beb5c4c0d2e33"
             },
             "catalina": {
-              "url": "https://homebrew.bintray.com/bottles/graphviz-2.47.0.catalina.bottle.tar.gz",
-              "sha256": "e5d3b7b652e5cf828c0a2afc2fadb31090f3d7f10389766857404b4359b695e3"
+              "cellar": "/usr/local/Cellar",
+              "url": "https://ghcr.io/v2/homebrew/core/graphviz/blobs/sha256:4010170a67db373c8aaf6d2d4cc4767ed74963fbedf33641e672414f49af6a9b",
+              "sha256": "4010170a67db373c8aaf6d2d4cc4767ed74963fbedf33641e672414f49af6a9b"
             },
             "mojave": {
-              "url": "https://homebrew.bintray.com/bottles/graphviz-2.47.0.mojave.bottle.tar.gz",
-              "sha256": "d045a9a68315b4e3fa61c7a0a813da345be8197892d070162d909f4985ff3bd7"
+              "cellar": "/usr/local/Cellar",
+              "url": "https://ghcr.io/v2/homebrew/core/graphviz/blobs/sha256:a6dfb7964c7776134a100467120aa190fe45415b53a704b2a372d0b82e1d2bc6",
+              "sha256": "a6dfb7964c7776134a100467120aa190fe45415b53a704b2a372d0b82e1d2bc6"
             }
           }
         }
@@ -66,6 +68,14 @@
         "CLT": "12.4.0.0.1.1610135815",
         "Xcode": "12.4",
         "macOS": "10.15.7"
+      },
+      "big_sur": {
+        "HOMEBREW_VERSION": "3.1.3",
+        "HOMEBREW_PREFIX": "/usr/local",
+        "Homebrew/homebrew-core": "f668b627f8d03499447661e6f87c7c15bb597ab8",
+        "CLT": "12.4.0.0.1.1610135815",
+        "Xcode": "12.5",
+        "macOS": "11.2.3"
       }
     }
   }
diff --git a/Dockerfile b/Dockerfile
@@ -1,4 +1,4 @@
-FROM swift:5.2 as builder
+FROM swift:5.3 as builder
 WORKDIR /swiftdoc
 COPY . .
 RUN apt-get -qq update && apt-get install -y libxml2-dev && rm -r /var/lib/apt/lists/*
diff --git a/Package.resolved b/Package.resolved
@@ -6,17 +6,17 @@
         "repositoryURL": "https://github.com/SwiftDocOrg/CommonMark.git",
         "state": {
           "branch": null,
-          "revision": "62176a332884826997928ba578d9d322c16772fb",
-          "version": "0.4.0"
+          "revision": "1c8f3983c12b848e0d84b3a7a1d6f9a735e6661a",
+          "version": "0.5.0"
         }
       },
       {
         "package": "GraphViz",
         "repositoryURL": "https://github.com/SwiftDocOrg/GraphViz.git",
         "state": {
           "branch": null,
-          "revision": "cf52b27bf7086e9ca5665cef0de57d0481bbab41",
-          "version": "0.3.0"
+          "revision": "e9a73a30755c3c5b26ba7c73312b1f2ccb9a1a30",
+          "version": "0.4.0"
         }
       },
       {
@@ -42,17 +42,17 @@
         "repositoryURL": "https://github.com/apple/swift-argument-parser.git",
         "state": {
           "branch": null,
-          "revision": "92646c0cdbaca076c8d3d0207891785b3379cbff",
-          "version": "0.3.1"
+          "revision": "9564d61b08a5335ae0a36f789a7d71493eacadfc",
+          "version": "0.3.2"
         }
       },
       {
         "package": "cmark",
         "repositoryURL": "https://github.com/SwiftDocOrg/swift-cmark.git",
         "state": {
           "branch": null,
-          "revision": "2a766030bee955b4806044fd7aca1b6884475138",
-          "version": "0.28.3+20200110.2a76603"
+          "revision": "9c8096a23f44794bde297452d87c455fc4f76d42",
+          "version": "0.29.0+20210102.9c8096a"
         }
       },
       {
@@ -87,25 +87,25 @@
         "repositoryURL": "https://github.com/SwiftDocOrg/SwiftMarkup.git",
         "state": {
           "branch": null,
-          "revision": "7915d17608dd32434dc8abb95156f70367f38a5a",
-          "version": "0.2.1"
+          "revision": "bc71bde93b5217833c8ed13d5cf1e0c60f1367a7",
+          "version": "0.3.0"
         }
       },
       {
         "package": "SwiftSemantics",
         "repositoryURL": "https://github.com/SwiftDocOrg/SwiftSemantics.git",
         "state": {
           "branch": null,
-          "revision": "4fdc48bddbbb8311079ed111e5a4f2b92423b05c",
-          "version": "0.1.0"
+          "revision": "2f571ccc67e0789d23f8adbccb6a18a6ff3b166c",
+          "version": "0.3.0"
         }
       },
       {
         "package": "SwiftSyntaxHighlighter",
         "repositoryURL": "https://github.com/NSHipster/SwiftSyntaxHighlighter.git",
         "state": {
-          "branch": "1.1.3",
-          "revision": "b086ef5066b6f799f9c7d6d7fc1553581b55ef1e",
+          "branch": "1.2.2",
+          "revision": "175923d005df00dc76c3c191bd7977c066a5288c",
           "version": null
         }
       }
diff --git a/Package.swift b/Package.swift
@@ -14,13 +14,13 @@ let package = Package(
     ],
     dependencies: [
         .package(name: "SwiftSyntax", url: "https://github.com/apple/swift-syntax.git", .revision("0.50300.0")),
-        .package(url: "https://github.com/SwiftDocOrg/SwiftSemantics.git", .upToNextMinor(from: "0.1.0")),
-        .package(url: "https://github.com/SwiftDocOrg/CommonMark.git", .upToNextMinor(from: "0.4.0")),
-        .package(url: "https://github.com/SwiftDocOrg/SwiftMarkup.git", .upToNextMinor(from: "0.2.1")),
-        .package(url: "https://github.com/SwiftDocOrg/GraphViz.git", .upToNextMinor(from: "0.3.0")),
+        .package(url: "https://github.com/SwiftDocOrg/SwiftSemantics.git", .upToNextMinor(from: "0.3.0")),
+        .package(url: "https://github.com/SwiftDocOrg/CommonMark.git", .upToNextMinor(from: "0.5.0")),
+        .package(url: "https://github.com/SwiftDocOrg/SwiftMarkup.git", .upToNextMinor(from: "0.3.0")),
+        .package(url: "https://github.com/SwiftDocOrg/GraphViz.git", .upToNextMinor(from: "0.4.0")),
         .package(url: "https://github.com/NSHipster/HypertextLiteral.git", .upToNextMinor(from: "0.0.2")),
         .package(url: "https://github.com/SwiftDocOrg/Markup.git", .upToNextMinor(from: "0.0.3")),
-        .package(url: "https://github.com/NSHipster/SwiftSyntaxHighlighter.git", .revision("1.1.3")),
+        .package(url: "https://github.com/NSHipster/SwiftSyntaxHighlighter.git", .revision("1.2.2")),
         .package(url: "https://github.com/apple/swift-argument-parser.git", .upToNextMinor(from: "0.3.1")),
         .package(url: "https://github.com/apple/swift-log.git", .upToNextMinor(from: "1.4.2")),
         .package(name: "LoggingGitHubActions", url: "https://github.com/NSHipster/swift-log-github-actions.git", .upToNextMinor(from: "0.0.1")),
diff --git a/Package@swift-5.2.swift b/Package@swift-5.2.swift
diff --git a/Package@swift-5.4.swift b/Package@swift-5.4.swift
@@ -0,0 +1,77 @@
+// swift-tools-version:5.3
+// The swift-tools-version declares the minimum version of Swift required to build this package.
+
+import PackageDescription
+
+let package = Package(
+    name: "swift-doc",
+    platforms: [
+        .macOS(.v11)
+    ],
+    products: [
+        .executable(name: "swift-doc", targets: ["swift-doc"]),
+        .library(name: "SwiftDoc", targets: ["SwiftDoc"])
+    ],
+    dependencies: [
+        .package(name: "SwiftSyntax", url: "https://github.com/apple/swift-syntax.git", .revision("release/5.4")),
+        .package(url: "https://github.com/SwiftDocOrg/SwiftSemantics.git", .revision("0.3.0")),
+        .package(url: "https://github.com/SwiftDocOrg/CommonMark.git", .upToNextMinor(from: "0.5.0")),
+        .package(url: "https://github.com/SwiftDocOrg/SwiftMarkup.git", .upToNextMinor(from: "0.3.0")),
+        .package(url: "https://github.com/SwiftDocOrg/GraphViz.git", .upToNextMinor(from: "0.4.0")),
+        .package(url: "https://github.com/NSHipster/HypertextLiteral.git", .upToNextMinor(from: "0.0.2")),
+        .package(url: "https://github.com/SwiftDocOrg/Markup.git", .upToNextMinor(from: "0.0.3")),
+        .package(url: "https://github.com/NSHipster/SwiftSyntaxHighlighter.git", .revision("1.2.2")),
+        .package(url: "https://github.com/apple/swift-argument-parser.git", .upToNextMinor(from: "0.3.1")),
+        .package(url: "https://github.com/apple/swift-log.git", .upToNextMinor(from: "1.4.2")),
+        .package(name: "LoggingGitHubActions", url: "https://github.com/NSHipster/swift-log-github-actions.git", .upToNextMinor(from: "0.0.1")),
+    ],
+    targets: [
+        // Targets are the basic building blocks of a package. A target can define a module or a test suite.
+        // Targets can depend on other targets in this package, and on products in packages which this package depends on.
+        .target(
+            name: "swift-doc",
+            dependencies: [
+                .target(name: "SwiftDoc"),
+                .target(name: "DCOV"),
+                .product(name: "ArgumentParser", package: "swift-argument-parser"),
+                .product(name: "SwiftSemantics", package: "SwiftSemantics"),
+                .product(name: "SwiftMarkup", package: "SwiftMarkup"),
+                .product(name: "CommonMarkBuilder", package: "CommonMark"),
+                .product(name: "HypertextLiteral", package: "HypertextLiteral"),
+                .product(name: "Markup", package: "Markup"),
+                .product(name: "GraphViz", package: "GraphViz"),
+                .product(name: "SwiftSyntaxHighlighter", package: "SwiftSyntaxHighlighter"),
+                .product(name: "Logging", package: "swift-log"),
+                .product(name: "LoggingGitHubActions", package: "LoggingGitHubActions")
+            ]
+        ),
+        .target(
+            name: "DCOV",
+            dependencies: []
+        ),
+        .target(
+            name: "SwiftDoc",
+            dependencies: [
+                .product(name: "SwiftSyntax", package: "SwiftSyntax"),
+                .product(name: "SwiftSemantics", package: "SwiftSemantics"),
+                .product(name: "SwiftMarkup", package: "SwiftMarkup"),
+                .product(name: "SwiftSyntaxHighlighter", package: "SwiftSyntaxHighlighter")
+            ]
+        ),
+        .testTarget(
+            name: "SwiftDocTests",
+            dependencies: [
+                .target(name: "SwiftDoc"),
+                .product(name: "SwiftSyntax", package: "SwiftSyntax"),
+                .product(name: "SwiftSemantics", package: "SwiftSemantics"),
+                .product(name: "SwiftMarkup", package: "SwiftMarkup")
+            ]
+        ),
+        .testTarget(
+            name: "EndToEndTests",
+            dependencies: [
+                .target(name: "swift-doc"),
+            ]
+        ),
+    ]
+)
diff --git a/README.md b/README.md
@@ -16,7 +16,7 @@ as well as top-level type aliases, functions, and variables.
 
 ## Requirements
 
-- Swift 5.3
+- Swift 5.3+
 - [libxml2][libxml2]
 - [GraphViz][graphviz] _(optional)_
 
diff --git a/Sources/swift-doc/Supporting Types/Components/Abstract.swift b/Sources/swift-doc/Supporting Types/Components/Abstract.swift
@@ -48,7 +48,7 @@ struct Abstract: Component {
             </a>
         </dt>
         <dd>
-            \#(commonmark: symbol.documentation?.summary ?? "")
+            \#(commonmark: symbol.documentation?.summary?.description ?? "")
         </dd>
         """#
     }
diff --git a/Sources/swift-doc/Supporting Types/Components/Documentation.swift b/Sources/swift-doc/Supporting Types/Components/Documentation.swift
diff --git a/Sources/swift-doc/Supporting Types/Components/Relationships.swift b/Sources/swift-doc/Supporting Types/Components/Relationships.swift
diff --git a/Tests/SwiftDocTests/SourceFileTests.swift b/Tests/SwiftDocTests/SourceFileTests.swift

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-FROM swift:5.2 as builder`
	`1`	`+FROM swift:5.3 as builder`
`2`	`2`	`WORKDIR /swiftdoc`
`3`	`3`	`COPY . .`
`4`	`4`	`RUN apt-get -qq update && apt-get install -y libxml2-dev && rm -r /var/lib/apt/lists/*`
Original file line number	Diff line number	Diff line change
`@@ -6,17 +6,17 @@`
`6`	`6`	`"repositoryURL": "https://github.com/SwiftDocOrg/CommonMark.git",`
`7`	`7`	`"state": {`
`8`	`8`	`"branch": null,`
`9`		`- "revision": "62176a332884826997928ba578d9d322c16772fb",`
`10`		`- "version": "0.4.0"`
	`9`	`+ "revision": "1c8f3983c12b848e0d84b3a7a1d6f9a735e6661a",`
	`10`	`+ "version": "0.5.0"`
`11`	`11`	`}`
`12`	`12`	`},`
`13`	`13`	`{`
`14`	`14`	`"package": "GraphViz",`
`15`	`15`	`"repositoryURL": "https://github.com/SwiftDocOrg/GraphViz.git",`
`16`	`16`	`"state": {`
`17`	`17`	`"branch": null,`
`18`		`- "revision": "cf52b27bf7086e9ca5665cef0de57d0481bbab41",`
`19`		`- "version": "0.3.0"`
	`18`	`+ "revision": "e9a73a30755c3c5b26ba7c73312b1f2ccb9a1a30",`
	`19`	`+ "version": "0.4.0"`
`20`	`20`	`}`
`21`	`21`	`},`
`22`	`22`	`{`
`@@ -42,17 +42,17 @@`
`42`	`42`	`"repositoryURL": "https://github.com/apple/swift-argument-parser.git",`
`43`	`43`	`"state": {`
`44`	`44`	`"branch": null,`
`45`		`- "revision": "92646c0cdbaca076c8d3d0207891785b3379cbff",`
`46`		`- "version": "0.3.1"`
	`45`	`+ "revision": "9564d61b08a5335ae0a36f789a7d71493eacadfc",`
	`46`	`+ "version": "0.3.2"`
`47`	`47`	`}`
`48`	`48`	`},`
`49`	`49`	`{`
`50`	`50`	`"package": "cmark",`
`51`	`51`	`"repositoryURL": "https://github.com/SwiftDocOrg/swift-cmark.git",`
`52`	`52`	`"state": {`
`53`	`53`	`"branch": null,`
`54`		`- "revision": "2a766030bee955b4806044fd7aca1b6884475138",`
`55`		`- "version": "0.28.3+20200110.2a76603"`
	`54`	`+ "revision": "9c8096a23f44794bde297452d87c455fc4f76d42",`
	`55`	`+ "version": "0.29.0+20210102.9c8096a"`
`56`	`56`	`}`
`57`	`57`	`},`
`58`	`58`	`{`
`@@ -87,25 +87,25 @@`
`87`	`87`	`"repositoryURL": "https://github.com/SwiftDocOrg/SwiftMarkup.git",`
`88`	`88`	`"state": {`
`89`	`89`	`"branch": null,`
`90`		`- "revision": "7915d17608dd32434dc8abb95156f70367f38a5a",`
`91`		`- "version": "0.2.1"`
	`90`	`+ "revision": "bc71bde93b5217833c8ed13d5cf1e0c60f1367a7",`
	`91`	`+ "version": "0.3.0"`
`92`	`92`	`}`
`93`	`93`	`},`
`94`	`94`	`{`
`95`	`95`	`"package": "SwiftSemantics",`
`96`	`96`	`"repositoryURL": "https://github.com/SwiftDocOrg/SwiftSemantics.git",`
`97`	`97`	`"state": {`
`98`	`98`	`"branch": null,`
`99`		`- "revision": "4fdc48bddbbb8311079ed111e5a4f2b92423b05c",`
`100`		`- "version": "0.1.0"`
	`99`	`+ "revision": "2f571ccc67e0789d23f8adbccb6a18a6ff3b166c",`
	`100`	`+ "version": "0.3.0"`
`101`	`101`	`}`
`102`	`102`	`},`
`103`	`103`	`{`
`104`	`104`	`"package": "SwiftSyntaxHighlighter",`
`105`	`105`	`"repositoryURL": "https://github.com/NSHipster/SwiftSyntaxHighlighter.git",`
`106`	`106`	`"state": {`
`107`		`- "branch": "1.1.3",`
`108`		`- "revision": "b086ef5066b6f799f9c7d6d7fc1553581b55ef1e",`
	`107`	`+ "branch": "1.2.2",`
	`108`	`+ "revision": "175923d005df00dc76c3c191bd7977c066a5288c",`
`109`	`109`	`"version": null`
`110`	`110`	`}`
`111`	`111`	`}`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ struct Abstract: Component {`
`48`	`48`	`</a>`
`49`	`49`	`</dt>`
`50`	`50`	`<dd>`
`51`		`- \#(commonmark: symbol.documentation?.summary ?? "")`
	`51`	`+ \#(commonmark: symbol.documentation?.summary?.description ?? "")`
`52`	`52`	`</dd>`
`53`	`53`	`"""#`
`54`	`54`	`}`