Skip to content

stry-inc/CocoaDebug

 
 

Repository files navigation

logo
Travis CI Build Status
Codacy Codacy Badge
Codecov codecov
Frameworks Carthage Compatible CocoaPods Compatible
Languages Languages
Platform Platform
Licence License MIT

Screenshot

Introduction

  • Shake to hide or show the black bubble. (Support iPhone device and simulator)

  • Share network details via email or copy to clipboard when you are in the Network Details page.

  • Copy logs. (Long press the text, then select all or select copy)

  • Search logs by keyword.

  • Long press the black bubble to clean all network logs.

  • Detect FPS.

  • List crash errors.

  • List application and device informations, including: version, build, bundle name, bundle id, screen resolution, device, iOS version

  • List all network requests sent by the application. (Support JSON and Google's Protocol buffers)

  • List all sandbox folders and files, supporting to preview and edit.

  • List all WKWebView consoles.

  • List all React Native JavaScript consoles and Native logs.

  • List all print() and NSLog() messages which have been written by developer in Xcode.

Installation

CocoaPods

target 'YourTargetName' do
    use_frameworks!
    pod 'CocoaDebug', :configurations => ['Debug']
end

Carthage

github "CocoaDebug/CocoaDebug"

Framework

Drag CocoaDebug.framework into project and set Embed Without Signing or Embed & Sign in Xcode.

WARNING: Don't submit .ipa to AppStore which has been linked with the CocoaDebug.framework. This Integration Guide outline a way to use build configurations to isolate linking the framework to Debug builds only.

Usage

  • Don't need to do anything. CocoaDebug will start automatically.

  • Check Example_Objc and Example_Swift for more advanced usage.

Parameters

When you initialize CocoaDebug, you can customize the following parameter values before CocoaDebug.enable().

  • serverURL - If the captured URLs contain server URL, CocoaDebug set server URL bold font to be marked. Not mark when this value is nil. Default value is nil.

  • ignoredURLs - Set the URLs which should not been captured, CocoaDebug capture all URLs when the value is nil. Default value is nil.

  • onlyURLs - Set the URLs which are only been captured, CocoaDebug capture all URLs when the value is nil. Default value is nil.

  • ignoredPrefixLogs - Set the prefix Logs which should not been captured, CocoaDebug capture all Logs when the value is nil. Default value is nil.

  • onlyPrefixLogs - Set the prefix Logs which are only been captured, CocoaDebug capture all Logs when the value is nil. Default value is nil.

  • additionalViewController - Add an additional UIViewController as child controller of CocoaDebug's main UITabBarController. Default value is nil.

  • logMaxCount - The maximum count of logs which CocoaDebug display. Default value is 1000.

  • emailToRecipients - Set the initial recipients to include in the email’s “To” field when share via email. Default value is nil.

  • emailCcRecipients - Set the initial recipients to include in the email’s “Cc” field when share via email. Default value is nil.

  • mainColor - Set CocoaDebug's main color with hexadecimal format. Default value is #42d459.

  • protobufTransferMap - Protobuf data transfer to JSON map. Default value is nil.

TODO

Thanks

Special thanks to remirobert.

License

CocoaDebug is released under the MIT license.

Releases

No releases published

Packages

No packages published

Languages

  • Swift 99.2%
  • Other 0.8%