Logging

Description

Logging is a Swift Macro library for handling logging.

Requirements

• iOS: 15.0 or later.
• macOS: 12.0 or later.
• tvOS: 15.0 or later.
• watchOS: 8.0 or later.

Installation

You can install Logging using the Swift Package Manager.

1. In Xcode, select "File" > "Add Package Dependencies".
2. Copy & paste the following into the "Search or Enter Package URL" search bar.

https://github.com/JamesSedlacek/Logging.git

4. Xcode will fetch the repository & the "Logging" library will be added to your project.

Logging Macro Example Usage

1. Add import Logging to the top of any Swift file
2. Add @Logging to any struct, class, or actor
3. Use logger to log anything

import Logging

@Logging
struct SomeObject {
    let someProperty: String

    func someMethod() {
        logger.log("Hello, world!")
    }
}

// Expanded Macro
struct SomeObject {
    let someProperty: String

    func someMethod() {
        logger.log("Hello, world!")
    }

    private let logger = Logger(subsystem: Bundle.main.bundleIdentifier ?? "Default Subsystem",
                                category: String(describing: Self.self))
}

LazyLogging Macro Example Usage

1. Add import Logging to the top of any Swift file
2. Add @LazyLogging to any struct, class, or actor
3. Use logger to log anything

import Logging

@LazyLogging
struct SomeObject {
    let someProperty: String

    func someMethod() {
        logger.log("Hello, world!")
    }
}

// Expanded Macro
struct SomeObject {
    let someProperty: String

    func someMethod() {
        logger.log("Hello, world!")
    }

    lazy private var logger: Logger = {
        return Logger(subsystem: Bundle.main.bundleIdentifier ?? "Default Subsystem",
                      category: String(describing: Self.self))
    }()
}

ObservableLogging Macro Example Usage

1. Add import Logging to the top of any Swift file
2. Add @ObservableLogging to any struct, class, or actor
3. Use logger to log anything

import Logging

@Observable
@ObservableLogging
final class SomeObject {
    let someProperty: String

    func someMethod() {
        logger.log("Hello, world!")
    }
}

// Expanded Macro
@Observable
final class SomeObject {
    let someProperty: String

    func someMethod() {
        logger.log("Hello, world!")
    }

    @ObservationIgnored
    lazy private var logger: Logger = {
        return Logger(subsystem: Bundle.main.bundleIdentifier ?? "Default Subsystem",
                      category: String(describing: Self.self))
    }()
}

Author

James Sedlacek, find me on X/Twitter or LinkedIn

License

Logging is available under the MIT license.

Copyright (c) 2023 James Sedlacek

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.