Move the LogParser example app outside of the library’s directory

I want it to be easy for people to create a script that uses the
LogParser library. The easiest thing I can think of is to be able to
just copy and paste the existing example app and then make modifications
to it. This isn’t very easy with the current structure, since the
example app’s code and build config is a bit intertwined with that of
the LogParser library. By putting the example app in a separate
directory, we can make a copy of it by just duplicating the entire
directory.

Author: lawrence-forooghian

.github/workflows/check.yml

@@ -48,15 +48,15 @@ jobs:
 
   check-log-parser:
     runs-on: macos-latest
-    defaults:
-      run:
-        working-directory: Tools/LogParser
     steps:
       - uses: actions/checkout@v2
         with:
           submodules: recursive
 
       - name: Run LogParser tests
         run: swift test
-      - name: Build LogParser command-line example app
-        run: swift build --target CommandLineExample
+        working-directory: Tools/LogParser
+
+      - name: Build LogParserExample app
+        run: swift build
+        working-directory: Tools/LogParserExample

Tools/LogParser/Package.swift

@@ -11,13 +11,7 @@ let package = Package(
     products: [
         .library(
             name: "LogParser",
-            targets: ["LogParser"]),
-        .executable(
-            name: "CommandLineExample",
-            targets: ["CommandLineExample"])
-    ],
-    dependencies: [
-        .package(url: "https://github.com/apple/swift-argument-parser", from: "1.2.0")
+            targets: ["LogParser"])
     ],
     targets: [
         .target(
@@ -26,14 +20,6 @@ let package = Package(
         .testTarget(
             name: "LogParserTests",
             dependencies: ["LogParser"]
-        ),
-        .executableTarget(
-            name: "CommandLineExample",
-            dependencies: [
-                "LogParser",
-                .product(name: "ArgumentParser", package: "swift-argument-parser")
-            ],
-            path: "Examples/CommandLineExample/Sources"
         )
     ]
 )

Tools/LogParser/README.md

@@ -2,8 +2,4 @@
 
 A package for parsing the log output of the Ably Asset Tracking Swift SDKs and their example apps.
 
-There is an example command-line app in [`Examples/CommandLineExample`](Examples/CommandLineExample) which demonstrates how to use the library. You can run it on an example log file by running the following command from the current directory:
-
-```bash
-swift run CommandLineExample Examples/CommandLineExample/example.txt
-```
+There is an example command-line app in [`../LogParserExample`](../LogParserExample) which demonstrates how to use the library.

Tools/LogParser/Package.resolved renamed to Tools/LogParserExample/Package.resolved

@@ -0,0 +1,24 @@
+// swift-tools-version: 5.7
+// The swift-tools-version declares the minimum version of Swift required to build this package.
+
+import PackageDescription
+
+let package = Package(
+    name: "LogParserExample",
+    platforms: [
+        .macOS(.v12)
+    ],
+    dependencies: [
+        .package(url: "https://github.com/apple/swift-argument-parser", from: "1.2.0"),
+        .package(path: "../LogParser")
+    ],
+    targets: [
+        .executableTarget(
+            name: "LogParserExample",
+            dependencies: [
+                .product(name: "LogParser", package: "LogParser"),
+                .product(name: "ArgumentParser", package: "swift-argument-parser")
+            ]
+        ),
+    ]
+)

Tools/LogParserExample/Package.swift

@@ -0,0 +1,9 @@
+# LogParserExample
+
+An example command-line app which demonstrates how to use the [LogParser library](../LogParser).
+
+You can run it on an example log file by running the following command from the current directory:
+
+```bash
+swift run LogParserExample example.txt
+```