Skip to content

forkercat/OhMyLog

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

14 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

OhMyLog: Simple Logging Package in Swift πŸ“‹

macOS Linux Windows license

platform-compatibility swift-version-compatibility

OhMyLog is a simple logging package for Swift. It supports the following features:

  • Six logging levels: TRACE 🟀, DEBUG 🟒, INFO βšͺ️, WARN 🟑, ERROR πŸ”΄, FATAL 🚨
  • Display log context including filename and line number
  • Show time
  • Output string or any object directly similar to print()
  • Toogle display of level icons and context information

πŸ”§ Install

You package file would be like:

let package = Package(
    name: "YourPackageName",
    
    dependencies: [
        .package(url: "https://github.com/forkercat/OhMyLog.git", .branch("main")),
    ],
    
    targets: [
        // For Swift 5.5, use .executableTarget
        .target(
            name: "YourPackageName",
            dependencies: [
                .product(name: "OhMyLog", package: "OhMyLog")
            ]),
    ]
)

πŸ˜† Usage

Option 1️⃣: Use Logger object

import OhMyLog

var logger = Logger(name: "Example-1", level: .info)
logger.logLevel = .trace
logger.showLevelIcon = true

let list = ["Oh", "My", "Log"]

logger.trace("Hello, World! \(list)")
logger.debug("Hello, World! \(list)")
logger.info("Hello, World! \(list)")
logger.warn("Hello, World! \(list)")
logger.error("Hello, World! \(list)")
logger.fatal("Hello, World! \(list)")

// Output
🟀 [06:52:31.672] TRACE Example-1: Hello, World! ["Oh", "My", "Log"]
🟒 [06:52:31.672] DEBUG Example-1: Hello, World! ["Oh", "My", "Log"]
βšͺ️ [06:52:31.673] INFO Example-1: Hello, World! ["Oh", "My", "Log"]
🟑 [06:52:31.673] WARN Example-1: Hello, World! ["Oh", "My", "Log"]
πŸ”΄ [06:52:31.673] ERROR Example-1: Hello, World! ["Oh", "My", "Log"]
🚨 [06:52:31.673] FATAL Example-1: Hello, World! ["Oh", "My", "Log"]

Option 2️⃣: Use Log namespace

import OhMyLog

Log.registerLogger(name: "Example-2", level: .info)
Log.setLevel(level: .info)
Log.info("Hello, World! \(list)")
Log.logLevel = .trace
Log.showLevelIcon(enabled: false)

let list = ["Oh", "My", "Log"]
Log.info("\(list)")
Log.warn(list)

// Output
[INFO] [06:52:31.673] Example-2 main.swift:26 - Hello, World! ["Oh", "My", "Log"]
[WARN] [06:52:31.674] Example-2 main.swift:26 - Hello, World! ["Oh", "My", "Log"]

Option 3️⃣: Without import

Create a swift source file in your project with two lines.

import OhMyLog

typealias Log = OhMyLog.Log

Now you are able to log without import OhMyLog.

Log.registerLogger(name: "Example-3", level: .info)
Log.setLevel(level: .info)

let six = 666

Log.trace(030)
Log.info(six)

// Output
🟀 [06:52:31.673] TRACE Example-3: 30
βšͺ️ [06:52:31.673] INFO Example-3: 666

πŸ™ Reference

About

Simple Logging Package in Swift πŸ“‹

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages