https://github.com/space-code/log
Log is a lightweight logging framework written in Swift.
https://github.com/space-code/log
logger logging swift
Last synced: 12 months ago
JSON representation
Log is a lightweight logging framework written in Swift.
- Host: GitHub
- URL: https://github.com/space-code/log
- Owner: space-code
- License: mit
- Created: 2023-10-17T06:06:41.000Z (over 2 years ago)
- Default Branch: dev
- Last Pushed: 2024-12-25T15:12:22.000Z (about 1 year ago)
- Last Synced: 2025-02-11T07:35:51.795Z (about 1 year ago)
- Topics: logger, logging, swift
- Language: Swift
- Homepage:
- Size: 330 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
log
## Description
`Log` is a lightweight logging framework written in Swift.
- [Usage](#usage)
- [Requirements](#requirements)
- [Installation](#installation)
- [Communication](#communication)
- [Contributing](#contributing)
- [Author](#author)
- [License](#license)
## Usage
### Create a logger instance
First, you need to create an instance of `IPrinter` that prints messages to a specific output, such as XCode's console or the `Console` app.
The `log` package provides predefined printers for printing messages in the XCode console (`ConsolePrinter`) and the system console (`OSPrinter`). You can also create your own printer. To do this, your object must conform to `IPrinterStrategy` and implement the necessary methods.
```swift
import Log
let osPrinter = OSPrinter()
let consolePrinter = ConsolePrinter()
```
Second, create a `Logger` instance and pass these printers as initialization parameters while defining a log level. The log level determines the level of log messages to print. If the log level is set to a specific level, all messages with different log levels will be ignored. To print all messages, use `.all`.
```swift
let log = Logger(
printers: [osPrinter, consolePrinter],
logLevel: .all
)
log.error(message: "test message")
```
### Formatting a message
Each instance of `IPrinter` has an array of formatters that are responsible for formatting input messages. The `log` package provides predefined prefix and timestamp formatters. To use these, you need to pass them to an initializer of a printer.
```swift
let osPrinter = OSPrinter(formatters: [PrefixFormatter(name: "your prefix here")])
...
log.fault(message: "message") // "🚨🚨🚨 [your prefix here] => message"
```
Here is a list of predefined formatters:
| **Formatters** | **Description** |
|----------------------------|-------------------------------------------------------------------------------------|
| **PrefixLogFormatter** | Add a specified prefix to a printed message |
| **TimestampLogFormatter** | Add a timestamp before a printed message based on a date format |
### Custom formatters
If you want to create a custom message formatter, your object must conform to the `ILogFormatter` protocol and implement the necessary methods.
```swift
struct MyCustomMessageFormatter: ILogFormatter {
func format(message: String, with logLevel: LogLevel) -> String {
// your implementation here
}
}
```
## Requirements
- iOS 13.0+ / macOS 10.15+ / tvOS 13.0+ / watchOS 7.0+ / visionOS 1.0+
- Xcode 14.0
- Swift 5.7
## Installation
### Swift Package Manager
The [Swift Package Manager](https://swift.org/package-manager/) is a tool for automating the distribution of Swift code and is integrated into the `swift` compiler. It is in early development, but `log` does support its use on supported platforms.
Once you have your Swift package set up, adding `log` as a dependency is as easy as adding it to the `dependencies` value of your `Package.swift`.
```swift
dependencies: [
.package(url: "https://github.com/space-code/log.git", .upToNextMajor(from: "1.2.0"))
]
```
## Communication
- If you **found a bug**, open an issue.
- If you **have a feature request**, open an issue.
- If you **want to contribute**, submit a pull request.
## Contributing
Bootstrapping development environment
```
make bootstrap
```
Please feel free to help out with this project! If you see something that could be made better or want a new feature, open up an issue or send a Pull Request!
## Author
Nikita Vasilev, nv3212@gmail.com
## License
log is available under the MIT license. See the LICENSE file for more info.