Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/noppefoxwolf/debugmenu
https://github.com/noppefoxwolf/debugmenu
Last synced: 5 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/noppefoxwolf/debugmenu
- Owner: noppefoxwolf
- License: mit
- Created: 2020-12-06T15:06:04.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-10-03T18:19:23.000Z (about 1 year ago)
- Last Synced: 2024-05-02T05:45:55.435Z (6 months ago)
- Language: Swift
- Size: 9.71 MB
- Stars: 104
- Watchers: 4
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# DebugMenu
## Installation
### Swift Package Manager
Select File > Swift Packages > Add Package Dependency.
Enter https://github.com/noppefoxwolf/DebugMenu in the "Choose Package Repository" dialog.
```swift
.package(url: "https://github.com/noppefoxwolf/DebugMenu", from: "2.0.4")
```
## Usage
### UIKit based
```swift
#if DEBUG
DebugMenu.install(windowScene: windowScene, items: [
ViewControllerDebugItem(),
ClearCacheDebugItem(),
UserDefaultsResetDebugItem(),
CustomDebugItem()
], dashboardItems: [
CPUUsageDashboardItem()
])
#endif
```
### SwiftUI based
```swift
@main
struct App: SwiftUI.App {
var body: some Scene {
WindowGroup {
Root.View(
store: .init(
initialState: .init(),
reducer: Root.reducer,
environment: .debug
)
).debugMenu(debuggerItems: [
ViewControllerDebugItem(),
ClearCacheDebugItem(),
UserDefaultsResetDebugItem(),
CustomDebugItem()
], dashboardItems: [
CPUUsageDashboardItem()
])
}
}
}
```
## Custom debug item
```swift
struct CustomDebugItem: DebugItem {
let debugItemTitle: String = "Custom item"
let action: DebugItemAction = .toggle { UserDefaults.standard.bool(forKey: "key") } action: { (isOn, completions) in
let updater = Updater()
do {
await updater.update()
return .success(message: "Updated")
} catch {
return .failure(message: "Faild to update")
}
}
}
```
## Custom dashboard item
```swift
public class CustomDashboardItem: DashboardItem {
public init() {}
public func startMonitoring() {}
public func stopMonitoring() {}
public let fetcher: MetricsFetcher = .text {
let formatter = DateFormatter()
formatter.dateFormat = "HH:mm:ss"
return formatter.string(from: Date())
}
public var title: String = "Date"
}
```
# Exclude DebugMenu in production
Read following article.
[Linking a Swift package only in debug builds](https://augmentedcode.io/2022/05/02/linking-a-swift-package-only-in-debug-builds/)
# How to use
## Open DebugMenu
Tap floating bug button.
## Show Dashboard
Longpress floating bug button, and tap `Show widget`.
# License
License
DebugMenu is released under the MIT license. See LICENSE for details.