Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xareelee/XLTestLog
Styling and coloring your XCTest logs on Xcode Console
https://github.com/xareelee/XLTestLog
Last synced: 3 months ago
JSON representation
Styling and coloring your XCTest logs on Xcode Console
- Host: GitHub
- URL: https://github.com/xareelee/XLTestLog
- Owner: xareelee
- License: mit
- Created: 2015-04-13T19:46:52.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-10-11T14:26:15.000Z (about 8 years ago)
- Last Synced: 2024-04-28T20:43:25.186Z (6 months ago)
- Language: Objective-C
- Homepage:
- Size: 1.49 MB
- Stars: 56
- Watchers: 3
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-ios - XLTestLog - Styling and coloring your XCTest logs on Xcode Console. (Logging / Other Hardware)
- awesome-ios-star - XLTestLog - Styling and coloring your XCTest logs on Xcode Console. (Logging / Other Hardware)
README
# XLTestLog
## Notes with Xcode 8 and XLTestLog
Since [Xcode 8 killed XcodeColors](https://github.com/robbiehanson/XcodeColors/issues/88), the current way using XCTestLog on Xcode 8 is just plain texts with emoji. You could still use XCTestLog to stylish XCTest logs without coloring.
XLTestLog v1.1+ will remove **"color code"** from logs if you don't privide a `UseXcodeColors == YES` preprocess macro.
## Introduction
**XLTestLog** is a lightweight library for stylish XCTest logs. It makes your testing logs more readable in Xcode Console.
- Reformat the log messages to make them more readable.
- Use indentations and Emoji bullets for different logs.
- Paint log messages and highlight important keywords using [XcodeColors].
- Only test logs will be styled. You can distinguish colored test logs from other logs (e.g. `NSLog()`).
The following is an example for test results in Xcode Console using XLTestLog:
And this is without using XLTestLog:
The readability between them is quite different. The original test code for the console logs is simple **(one passed test, one failed test, one measure task, and one message from`NSLog()`)**:
```objc
@implementation XLTestLogDevTests
- (void)testPassedCase {
XCTAssert(YES, @"Pass");
NSLog(@"This is a message from `NSLog()`.");
}
- (void)testFailureCase {
XCTAssert(NO, @"Fail");
}
- (void)testPerformanceExample {
// This is an example of a performance test case.
[self measureBlock:^{
int j = 0;
for (int i = 0; i < 1000000; i++) {
j += i;
}
}];
}
@end
```
## How to use
No additional code is needed to use XLTestLog.
1. Include XLTestLog in your test target (see [Installation section](#installation)).
2. Install [XcodeColors] plugin.
3. Just run your test, and see the delightful logs in the Xcode Console.
## Release Notes
### You should also install XcodeColors
Currently, you should use XLTestLog with [XcodeColors]. If you don't, it would show the color code in the logs.
In the next release, XLTestLog will [read the environment variable `XcodeColors`](https://github.com/robbiehanson/XcodeColors#option-1-manual-use--custom-macros) to decide whether using XcodeColors to paint log messages or not.
## Installation
Before installing XLTestLog, please read the section **Release Notes**.
### via CocoaPods
You can install XLTestLog simply via [CocoaPods]:
```
target :MyAppTests do
pod 'XLTestLog'
end
```
### Manually
You can install XLTestLog manually via adding files in `XLTestLog/` directory into your project.
## About
### Contribution
Any help would be most welcome. Even buy me a beer. :p
### Author
* Xaree Lee (李岡諭, Kang-Yu Lee), an iOS developer from Taiwan.
-
### License
XLTestLog is available under the MIT license. See the [LICENSE] file for more info.
[CocoaPods]: https://cocoapods.org
[XcodeColors]: https://github.com/robbiehanson/XcodeColors
[LICENSE]: ./LICENSE.md