Merge pull request #515 from ably/move-LogParser-example-app

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

.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/Library/LogParser
+
+      - name: Build LogParserExample app
+        run: swift build
+        working-directory: Tools/Library/LogParserExample

Tools/Library/LogParser/Package.swift

@@ -0,0 +1,25 @@
+// 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: "LogParser",
+    platforms: [
+        .macOS(.v12)
+    ],
+    products: [
+        .library(
+            name: "LogParser",
+            targets: ["LogParser"])
+    ],
+    targets: [
+        .target(
+            name: "LogParser"
+        ),
+        .testTarget(
+            name: "LogParserTests",
+            dependencies: ["LogParser"]
+        )
+    ]
+)

Tools/Library/LogParser/README.md

@@ -0,0 +1,5 @@
+# LogParser
+
+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 [`../LogParserExample`](../LogParserExample) which demonstrates how to use the library.

Tools/Library/LogParserExample/Package.swift

@@ -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/Library/LogParserExample/README.md

@@ -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
+```

Tools/README.md

@@ -0,0 +1,5 @@
+# Developer tools for the Ably Asset Tracking Swift SDKs
+
+This directory contains tooling intended to be used by developers working on the Ably Asset Tracking Swift SDKs.
+
+It currently just contains the [`Library`](Library) directory, which contains the [`LogParser` library](Library/LogParser) for parsing logs emitted by these SDKs, as well as [an example app for the `LogParser` library](Library/LogParserExample).