Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/delba/Log
An extensible logging framework for Swift
https://github.com/delba/Log
Last synced: 3 months ago
JSON representation
An extensible logging framework for Swift
- Host: GitHub
- URL: https://github.com/delba/Log
- Owner: delba
- License: mit
- Created: 2015-12-10T17:32:32.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2019-11-16T19:48:21.000Z (almost 5 years ago)
- Last Synced: 2024-07-26T22:32:23.054Z (3 months ago)
- Language: Swift
- Homepage:
- Size: 263 KB
- Stars: 829
- Watchers: 13
- Forks: 67
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ios - Log - A logging tool with built-in themes, formatters, and a nice API to define your owns. (Logging / Other Hardware)
- awesome-swift - Log - A logging tool with built-in themes, formatters, and a nice API to define your owns. (Logging)
- awesome-ios-star - Log - A logging tool with built-in themes, formatters, and a nice API to define your owns. (Logging / Other Hardware)
- awesome-swift-cn - Log - A logging tool with built-in themes, formatters, and a nice API to define your owns. (Libs / Logging)
README
`Log` is a powerful logging framework that provides built-in themes and formatters, and a nice API to define your owns.
> Get the most out of `Log` by installing [`XcodeColors`](https://github.com/robbiehanson/XcodeColors) and [`KZLinkedConsole`](https://github.com/krzysztofzablocki/KZLinkedConsole)
Usage • Installation • License
### Usage
#### The basics
- Use `Log` just as you would use `print`.
```swift
let Log = Logger()
Log.trace("Called!!!")
Log.debug("Who is self:", self)
Log.info(some, objects, here)
Log.warning(one, two, three, separator: " - ")
Log.error(error, terminator: "😱😱😱\n")
```
- Disable `Log` by setting `enabled` to `false`:
```swift
Log.enabled = false
```
- Define a minimum level of severity to only print the messages with a greater or equal severity:
```swift
Log.minLevel = .warning
```
> The severity levels are `trace`, `debug`, `info`, `warning`, and `error`.
#### Customization
- Create your own `Logger` by changing its `Theme` and/or `Formatter`.
A suggested way of doing it is by extending `Formatters` and `Themes`:
```swift
extension Formatters {
static let detailed = Formatter("[%@] %@.%@:%@ %@: %@", [
.date("yyyy-MM-dd HH:mm:ss.SSS"),
.file(fullPath: false, fileExtension: false),
.function,
.line,
.level,
.message
])
}
extension Themes {
static let tomorrowNight = Theme(
trace: "#C5C8C6",
debug: "#81A2BE",
info: "#B5BD68",
warning: "#F0C674",
error: "#CC6666"
)
}
```
```swift
let Log = Logger(formatter: .detailed, theme: .tomorrowNight)
```
> See the built-in [formatters](https://github.com/delba/Log/blob/master/Source/Extensions/Formatters.swift) and [themes](https://github.com/delba/Log/blob/master/Source/Extensions/Themes.swift) for more examples.
**Tip:** `Log.format` and `Log.colors` can be useful to visually debug your logger.
Nothing prevents you from creating as many loggers as you want!
```swift
let Basic = Logger(formatter: .default, theme: nil)
let Short = Logger(
formatter: Formatter("%@: %@", .level, .message),
theme: .tomorrowNightEighties,
minLevel: .info
)
```
- Turn off the colors by setting the theme to `nil`:
```swift
Log.theme = nil
```
#### Advanced
Include a custom `Block` component in your formatter to print its result in every log message:
```swift
struct User {
static func token() -> Int {
return NSUserDefaults.standardUserDefaults.integerForKey("token")
}
}
Log.formatter = Formatter("[%@] %@: %@", .block(User.token), .level, .message)
```
## Installation
### Carthage
[Carthage](https://github.com/Carthage/Carthage) is a decentralized dependency manager that automates the process of adding frameworks to your Cocoa application.
You can install Carthage with [Homebrew](http://brew.sh/) using the following command:
```bash
$ brew update
$ brew install carthage
```
To integrate Log into your Xcode project using Carthage, specify it in your `Cartfile`:
```ogdl
github "delba/Log"
```
### CocoaPods
[CocoaPods](http://cocoapods.org) is a dependency manager for Cocoa projects.
You can install it with the following command:
```bash
$ gem install cocoapods
```
To integrate Log into your Xcode project using CocoaPods, specify it in your `Podfile`:
```ruby
use_frameworks!
pod 'Log'
```
## License
Copyright (c) 2015-2016 Damien (http://delba.io)
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.