Upgrades for Xcode 13 (SourceDocs#70)

* WIP: some fixes

* Fix Xcode13 issues and dependency updates. Remove dependency on SwiftPM

* Updates for 2.0.0

* Use Swift 5.5 on workflows

* Checkout current working code

* Update checkout directory

* Unit test workflow

* Update test.yml

Author: eneko

.github/workflows/install.yml

@@ -16,10 +16,15 @@ jobs:
     name: Install from Source on macOS
     runs-on: macos-latest
     steps:
+#     - name: Setup Swift
+#       uses: fwal/[email protected]
+#       with:
+#         swift-version: 5.5
+    - name: Checkout
+      uses: actions/[email protected]
     - name: Install SourceDocs
       run: |
-        git clone --depth 1 https://github.com/eneko/SourceDocs.git
-        cd SourceDocs
+        swift --version
         make install
         sourcedocs version
 
@@ -31,9 +36,14 @@ jobs:
       run: |
         sudo apt-get update
         sudo apt-get install -y libsqlite3-dev libedit-dev
+#     - name: Setup Swift
+#       uses: fwal/[email protected]
+#       with:
+#         swift-version: 5.5
+    - name: Checkout
+      uses: actions/[email protected]
     - name: Install SourceDocs
       run: |
-        git clone --depth 1 https://github.com/eneko/SourceDocs.git
-        cd SourceDocs
+        swift --version
         sudo make install
         sourcedocs version

.github/workflows/test.yml

@@ -0,0 +1,30 @@
+name: Run Unit Tests
+
+on: [push, pull_request]
+
+jobs:
+  macOS:
+    name: Unit Test on macOS
+    runs-on: macos-latest
+    steps:
+    - name: Checkout
+      uses: actions/[email protected]
+    - name: Unit Test
+      run: |
+        swift --version
+        swift test
+
+  ubuntu:
+    name: Unit Test on Ubuntu
+    runs-on: ubuntu-latest
+    steps:
+    - name: Install Dependencies
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y libsqlite3-dev libedit-dev
+    - name: Checkout
+      uses: actions/[email protected]
+    - name: Unit Test
+      run: |
+        swift --version
+        swift test

CHANGELOG.md

@@ -9,6 +9,11 @@
 #### Bug Fixes
 - None
 
+## 2.0.0
+
+- Remove dependency on SwiftPM module for package dump decoding
+- Updates required for Xcode 13
+
 
 ## 1.2.1
 

Makefile

@@ -1,5 +1,5 @@
 TOOL_NAME = sourcedocs
-VERSION = 1.2.1
+VERSION = 2.0.0
 
 PREFIX = /usr/local
 INSTALL_PATH = $(PREFIX)/bin/$(TOOL_NAME)
@@ -23,7 +23,7 @@ lint:
 	swiftlint lint --quiet --strict
 
 docs:
-	swift run sourcedocs generate -car -o docs/reference
+	swift run sourcedocs generate --clean -ar -o docs/reference
 	swift run sourcedocs package -r -o docs
 
 linuxmain:

Package.resolved

@@ -1,33 +1,6 @@
 {
   "object": {
     "pins": [
-      {
-        "package": "Commandant",
-        "repositoryURL": "https://github.com/Carthage/Commandant.git",
-        "state": {
-          "branch": null,
-          "revision": "ab68611013dec67413628ac87c1f29e8427bc8e4",
-          "version": "0.17.0"
-        }
-      },
-      {
-        "package": "CwlCatchException",
-        "repositoryURL": "https://github.com/mattgallagher/CwlCatchException.git",
-        "state": {
-          "branch": null,
-          "revision": "7cd2f8cacc4d22f21bc0b2309c3b18acf7957b66",
-          "version": "1.2.0"
-        }
-      },
-      {
-        "package": "CwlPreconditionTesting",
-        "repositoryURL": "https://github.com/mattgallagher/CwlPreconditionTesting.git",
-        "state": {
-          "branch": null,
-          "revision": "c228db5d2ad1b01ebc84435e823e6cca4e3db98b",
-          "version": "1.2.0"
-        }
-      },
       {
         "package": "MarkdownGenerator",
         "repositoryURL": "https://github.com/eneko/MarkdownGenerator.git",
@@ -37,15 +10,6 @@
           "version": "0.5.0"
         }
       },
-      {
-        "package": "Nimble",
-        "repositoryURL": "https://github.com/Quick/Nimble.git",
-        "state": {
-          "branch": null,
-          "revision": "6abeb3f5c03beba2b9e4dbe20886e773b5b629b6",
-          "version": "8.0.4"
-        }
-      },
       {
         "package": "ProcessRunner",
         "repositoryURL": "https://github.com/eneko/ProcessRunner.git",
@@ -55,15 +19,6 @@
           "version": "1.1.0"
         }
       },
-      {
-        "package": "Quick",
-        "repositoryURL": "https://github.com/Quick/Quick.git",
-        "state": {
-          "branch": null,
-          "revision": "33682c2f6230c60614861dfc61df267e11a1602f",
-          "version": "2.2.0"
-        }
-      },
       {
         "package": "Rainbow",
         "repositoryURL": "https://github.com/onevcat/Rainbow",
@@ -78,35 +33,17 @@
         "repositoryURL": "https://github.com/jpsim/SourceKitten.git",
         "state": {
           "branch": null,
-          "revision": "77a4dbbb477a8110eb8765e3c44c70fb4929098f",
-          "version": "0.29.0"
+          "revision": "558628392eb31d37cb251cfe626c53eafd330df6",
+          "version": "0.31.1"
         }
       },
       {
         "package": "swift-argument-parser",
         "repositoryURL": "https://github.com/apple/swift-argument-parser",
         "state": {
           "branch": null,
-          "revision": "9f04d1ff1afbccd02279338a2c91e5f27c45e93a",
-          "version": "0.0.5"
-        }
-      },
-      {
-        "package": "llbuild",
-        "repositoryURL": "https://github.com/apple/swift-llbuild.git",
-        "state": {
-          "branch": null,
-          "revision": "f1c9ad9a253cdf1aa89a7f5c99c30b4513b06ddb",
-          "version": "0.1.1"
-        }
-      },
-      {
-        "package": "SwiftPM",
-        "repositoryURL": "https://github.com/apple/swift-package-manager",
-        "state": {
-          "branch": null,
-          "revision": "8656a25cb906c1896339f950ac960ee1b4fe8034",
-          "version": "0.4.0"
+          "revision": "e1465042f195f374b94f915ba8ca49de24300a0d",
+          "version": "1.0.2"
         }
       },
       {
@@ -123,8 +60,8 @@
         "repositoryURL": "https://github.com/jpsim/Yams.git",
         "state": {
           "branch": null,
-          "revision": "c947a306d2e80ecb2c0859047b35c73b8e1ca27f",
-          "version": "2.0.0"
+          "revision": "9ff1cc9327586db4e0c8f46f064b6a82ec1566fa",
+          "version": "4.0.6"
         }
       }
     ]

Package.swift

@@ -1,22 +1,22 @@
-// swift-tools-version:5.1
+// swift-tools-version:5.3
 import PackageDescription
+import Foundation
 
 let package = Package(
     name: "SourceDocs",
     platforms: [
-        .macOS(.v10_13)
+        .macOS(.v10_15)
     ],
     products: [
         .executable(name: "sourcedocs", targets: ["SourceDocsCLI"]),
         .library(name: "SourceDocsLib", targets: ["SourceDocsLib"])
     ],
     dependencies: [
-        .package(url: "https://github.com/apple/swift-argument-parser", from: "0.0.1"),
-        .package(url: "https://github.com/apple/swift-package-manager", .exact("0.4.0")),
+        .package(url: "https://github.com/apple/swift-argument-parser", from: "1.0.0"),
         .package(url: "https://github.com/jpsim/SourceKitten.git", from: "0.29.0"),
         .package(url: "https://github.com/eneko/MarkdownGenerator.git", from: "0.4.0"),
         .package(url: "https://github.com/onevcat/Rainbow", from: "3.0.0"),
-        .package(url: "https://github.com/eneko/ProcessRunner.git", .upToNextMajor(from: "1.1.0"))
+        .package(url: "https://github.com/eneko/ProcessRunner.git", from: "1.1.0")
     ],
     targets: [
         .target(name: "SourceDocsCLI", dependencies: [
@@ -26,7 +26,6 @@ let package = Package(
         ]),
         .target(name: "SourceDocsLib", dependencies: [
             .product(name: "SourceKittenFramework", package: "SourceKitten"),
-            "SwiftPM-auto",
             "MarkdownGenerator",
             "Rainbow",
             "ProcessRunner"

Sources/SourceDocsCLI/CleanCommand.swift

@@ -9,16 +9,18 @@ import Foundation
 import ArgumentParser
 import SourceDocsLib
 
-struct CleanCommand: ParsableCommand {
-    static var configuration = CommandConfiguration(
-        commandName: "clean",
-        abstract: "Delete the output folder and quit."
-    )
+extension SourceDocs {
+    struct CleanCommand: ParsableCommand {
+        static var configuration = CommandConfiguration(
+            commandName: "clean",
+            abstract: "Delete the output folder and quit."
+        )
 
-    @Option(name: .shortAndLong, default: SourceDocs.defaultOutputPath, help: "Output directory to clean")
-    var outputFolder: String
+        @Option(name: .shortAndLong, help: "Output directory to clean")
+        var outputFolder = SourceDocs.defaultOutputPath
 
-    func run() throws {
-        try DocumentationEraser(docsPath: outputFolder).run()
+        func run() throws {
+            try DocumentationEraser(docsPath: outputFolder).run()
+        }
     }
 }