I developed this library in response to the difficulties I faced while attempting to debug both an Apple Watch app and an iOS app concurrently.

Debugging on iOS is typically straightforward, utilizing tools like print statements or OSLog to aid in troubleshooting via LLDB. However, the complexity increases when simultaneously working on both iOS and watchOS. Debugging the watchOS component becomes particularly challenging. Traditional debugging approaches like prints or logs are practically ineffective when trying to debug watchOS via LLDB, especially when both the iOS and watchOS apps are running concurrently. While communication methods like WCSession's sendMessage can be employed, resorting to these techniques solely for debugging purposes seems inefficient.

To address this challenge, I developed a library aimed at assisting iOS developers in streamlining the debugging process for Apple Watch apps. For individuals facing the need to access real-time debugging messages, I introduced a feature: a translucent debugging list that remains visible alongside the main app interface. The feature allows developers to monitor and interact with debugging information conveniently while simultaneously engaging with the primary application on the Apple Watch.

In addition, the library offers a draggable assistive touch button that empowers developers to access more comprehensive log information effortlessly. The decision to make this button draggable stems from the confined screen space available on the watch. The rationale behind this design choice is that affixing the button to a fixed position could lead to an inconvenience. If the button were stationary and happened to obstruct critical information or areas requiring interaction, developers might find the library less effective. To circumvent this potential hindrance, I implemented the drag-and-drop functionality. This way, if the detail button interferes with the view or interaction in any way, developers have the freedom to relocate the button to a more suitable location on the screen. This approach aims to enhance the overall usability of the library while catering to the limitations of the watch's display area.

Like conventional loggers, the appleWatchLogger also offers a range of message levels. These levels are distinguishable through both color emoji and distinct text identifiers. You are welcome to utilize this functionality as per your requirements and preferences. Whether you need to categorize messages for different purposes or ensure clarity in the log display, the flexibility of message levels is at your disposal to enhance your debugging experience. Feel free to take advantage of this feature in a manner that aligns with your convenience and development objectives.

pod 'AppleWatchLogger'

[!] The platform of the target `YourProject` is not compatible with `AppleWatchLogger`, which does not support `iOS`.

Swift Package Manager

1. You can add AppleWatchLogger to an Xcode project by adding it as a package dependency.
2. From the File menu, select Add Packages...
3. Enter "https://github.com/inwoodev/AppleWatchLogger.git" into the package repository URL text field
4. [Important] Make sure you add the packate to watch app target

To integrate a LogView into your project, follow these steps:

1. Import the AppleWatchLogger module into your target project.
2. Use the .appleWatchLog() view modifier.

import AppleWatchLogger
import SwiftUI

@main
struct AppleWatchLogger_Example_Watch_App: App {
  var body: some Scene {
    WindowGroup {
      ContentView()
        .appleWatchLog()
    }
  }
}

With these steps, you've integrated the AppleWatchLogView into your app's view side.

You can implement AppleWatchLogger in various parts of your code, such as ViewModel, Repository, or Service layers. The location doesn't matter as long as you import the AppleWatchLogger module.

import AppleWatchLogger
import Foundation

final class ExampleRepository {
  func wantVisualLog() {
    AppleWatchLogger.info(message: "Want to debug, but don't want to create extra view")
  }
}

AppleWatchLogger supports various levels of logging, each represented by an emoji and text:

public enum Level: String {
    case verbose, success, unsure, info, warning, error, fatalError
    
    var emoji: Character {
      switch self {
      case .verbose:      return "⚫"
      case .success:      return "🟢"
      case .unsure:       return "🟣"
      case .info:         return "🔵"
      case .warning:      return "🟡"
      case .error:        return "🟠"
      case .fatalError:   return "🔴"
      }
    }
  }

With these log levels, you can easily differentiate and identify the severity of each logged message in your debugging process.

inwoodev, dlsdn1207@gmail.com

AppleWatchLogger is available under the MIT license. See the LICENSE file for more info.