https://github.com/krzysztofzablocki/LinkedConsole
Clickable links in your Xcode console, so you never wonder which class logged the message.
https://github.com/krzysztofzablocki/LinkedConsole
Last synced: 4 months ago
JSON representation
Clickable links in your Xcode console, so you never wonder which class logged the message.
- Host: GitHub
- URL: https://github.com/krzysztofzablocki/LinkedConsole
- Owner: krzysztofzablocki
- License: mit
- Created: 2015-12-08T10:53:34.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2022-09-07T08:56:09.000Z (about 3 years ago)
- Last Synced: 2025-06-13T19:27:12.220Z (5 months ago)
- Language: Swift
- Homepage: http://merowing.info
- Size: 543 KB
- Stars: 932
- Watchers: 21
- Forks: 62
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# KZLinkedConsole
Ever wondered which part of your application logged the message you just saw in console?
Wonder no more, instead just click on it to jump to the culprit. Simple as that.
## Installation
Download the source, build the Xcode project and restart Xcode.
The plugin will automatically be installed in ~/Library/Application Support/Developer/Shared/Xcode/Plug-ins. To uninstall, just remove the plugin from there (and restart Xcode).
#### Swift 3
Xcode8 / Swift3 is on `swift3` branch.
### Alcatraz
This plugin can be installed using Alcatraz. Search for KZLinkedConsole in Alcatraz.
## Details
If a console logs a **fileName.extension:123** that name turns into a clickable hyperlink that will open the specific file and highlight the line.
That way you can either use your own logging mechanism and just add this simple prefix, e.g.
~~~swift
func logMessage(message: String, filename: String = __FILE__, line: Int = __LINE__, function: String = __FUNCTION__) {
print("\((filename as NSString).lastPathComponent):\(line) \(function):\r\(message)")
}
~~~
## Integration with popular loggers
- [XCGLogger](https://github.com/DaveWoodCom/XCGLogger) is supported out of the box.
- [SwiftyBeaver](https://github.com/skreutzberger/SwiftyBeaver) is supported out of the box.
- [Log](https://github.com/delba/Log) is supported out of the box.
- [QorumLogs](https://github.com/goktugyil/QorumLogs) after enable KZLinkedConsoleSupportEnabled flag.
~~~swift
QorumLogs.KZLinkedConsoleSupportEnabled = true
~~~
- [CocoaLumberjack](https://github.com/CocoaLumberjack/CocoaLumberjack) supported, with a log formatter printing **fileName.extension:123**, here's my log formatter for it:
Swift version (Objective-C version is part of [KZBootstrap](https://github.com/krzysztofzablocki/KZBootstrap)):
~~~swift
import Foundation
import CocoaLumberjack.DDDispatchQueueLogFormatter
class KZFormatter: DDDispatchQueueLogFormatter {
lazy var formatter: NSDateFormatter = {
let dateFormatter = NSDateFormatter()
dateFormatter.formatterBehavior = .Behavior10_4
dateFormatter.dateFormat = "HH:mm:ss.SSS"
return dateFormatter
}()
override func formatLogMessage(logMessage: DDLogMessage!) -> String {
let dateAndTime = formatter.stringFromDate(logMessage.timestamp)
var logLevel: String
let logFlag = logMessage.flag
if logFlag.contains(.Error) {
logLevel = "ERR"
} else if logFlag.contains(.Warning){
logLevel = "WRN"
} else if logFlag.contains(.Info) {
logLevel = "INF"
} else if logFlag.contains(.Debug) {
logLevel = "DBG"
} else if logFlag.contains(.Verbose) {
logLevel = "VRB"
} else {
logLevel = "???"
}
let formattedLog = "\(dateAndTime) |\(logLevel)| \((logMessage.file as NSString).lastPathComponent):\(logMessage.line): ( \(logMessage.function) ): \(logMessage.message)"
return formattedLog;
}
}
~~~
## Opening files from outside Xcode
KZLinkedConsole also supports opening files from outside Xcode through distributed notifications. The [xed](https://developer.apple.com/legacy/library/documentation/Darwin/Reference/ManPages/man1/xed.1.html) command line tool is supposed to provide this feature but is unfortunately [terribly broken](http://openradar.appspot.com/19529585).
In order to open the file *Example.m* and select the line *123*, simply do the following:
```objc
[[NSDistributedNotificationCenter defaultCenter]
postNotificationName:@"pl.pixle.KZLinkedConsole.OpenFile"
object:@"Example.m"
userInfo:@{ @"Line": @123 }
deliverImmediately:YES];
```
You can also specify an absolute path if you know it. The userInfo dictionary with line number information is optional.
If the file was successfully opened, KZLinkedConsole will post back a `pl.pixle.KZLinkedConsole.DidOpenFile` distributed notification.
## More info
Read more about creation of this plugin on [my blog](http://merowing.info/2015/12/writing-xcode-plugin-in-swift/)
[Follow me on twitter for more useful iOS stuff](http://twitter.com/merowing_)