🗂️ WrkstrmLog

CI 系统 状态
Swift Package Index
GitHub Action 状态 Lint Status Test Status

WrkstrmLog 是一个多功能且灵活的日志框架,旨在为包括 Linux、Xcode 和 macOS 终端在内的不同环境提供一致的日志记录。它可以适应各种上下文,确保日志消息以一致的格式显示,而无需考虑平台。

🔑 主要特性

兼容性

📦 安装

要将 WrkstrmLog 集成到您的项目中,请按照以下步骤操作

🛠 Swift Package Manager

在您的 Package.swift 文件中添加 WrkstrmLog 作为依赖项

dependencies: [
    .package(url: "https://github.com/wrkstrm/WrkstrmLog.git", .upToNextMajor(from: "0.0.0"))
]

在您的目标依赖项中包含 WrkstrmLog

targets: [
    .target(name: "YourTarget", dependencies: ["WrkstrmLog"]),
]

📚 用法

导入 WrkstrmLog 并轻松开始日志记录

  1. 📥 导入库:

    import WrkstrmLog
  2. 🔨 初始化 Logger:使用您的系统和类别创建一个 logger 实例

    let logger = Log(system: "YourSystem", category: "YourCategory")
  3. 📝 记录消息:使用各种日志记录方法,如 verboseinfoerrorguard

    logger.verbose("Verbose message")
    logger.info("Info message")
    logger.error("Error message")
    Log.guard("Critical error")

🎨 自定义

WrkstrmLog 提供高度的自定义功能。扩展或修改它以适应您项目的需求,并将示例格式化程序用作自定义实现的基础。

🤝 贡献

🌟 贡献使开源社区成为学习、启发和创造的绝佳场所。 您所做的任何贡献都非常感谢

  1. Fork 本项目
  2. 创建您的特性分支 (git checkout -b feature/AmazingFeature)
  3. 提交您的更改 (git commit -m 'Add some AmazingFeature')
  4. 推送到分支 (git push origin feature/AmazingFeature)
  5. 打开 Pull Request

📜 许可证

📄 根据 MIT 许可证分发。有关更多信息,请参阅 LICENSE

📬 联系方式

🔗 项目链接:https://github.com/wrkstrm/WrkstrmLog

💖 致谢


📝 WrkstrmLog:统一 Swift 日志记录的交响曲 🎼

1. 🎭 挑战:驯服狂野的日志

有没有觉得您的日志在不同平台之间说着不同的语言?您并不孤单! 😅

Swift 开发者面临着一个共同的难题

#if DEBUG
print("Debug: Entering function") // 👀 Only in debug? What about production?
#endif

// ... 🏗️ Your awesome code here ...

if let error = performOperation() {
  print("Error occurred: \(error)") // 😱 Errors in production, but where?
}

这种方法就像试图指挥一个乐队,但音乐家们演奏的是不同的乐谱! 🎻🎺🥁

2. 🚀 隆重推出 WrkstrmLog:Swift 日志记录的大师

WrkstrmLog 作为指挥家介入,为您的日志混乱带来和谐。 这就像为您的日志配备了一个通用翻译器! 🌐🗣️

import WrkstrmLog

let log = Log(system: "com.myapp", category: "networking")

func someFunction() {
  log.debug("🎬 Action! Entering someFunction")
  
  // 🏗️ Your symphony of code here
  
  if let error = performOperation() {
    log.error("🚨 Plot twist! Operation failed: \(error)")
  }
  
  log.debug("🎭 Scene end. Exiting someFunction")
}

3. 💎 核心特性和优势

4. 🏁 快速入门

📦 安装

将此行添加到您的 Package.swift,让魔法开始

dependencies: [
    .package(url: "https://github.com/wrkstrm/WrkstrmLog.git", .upToNextMajor(from: "1.0.0"))
]

🔰 基本用法

import WrkstrmLog

let log = Log.shared
log.info("🎉 App launched! Time to rock and roll!")

5. 🎓 高级用法和最佳实践

WrkstrmLog 就像日志记录的瑞士军刀。 以下是其强大功能的一瞥

环境 WrkstrmLog 魔法 默认 Swift(乏味)日志记录
Xcode 🔍 使用 .os 样式。调试控制台成为您的水晶球。 控制台中的基本 print()os.Logger
macOS 终端 🖨️ .print 样式。日志直接弹出到 stdout 中。 print() 可以工作,os.Logger 玩起了捉迷藏。
Linux 🐧 .swift 样式。像老板一样弥合差距。 仅限 print()os.Logger 消失得无影无踪。

6. ⚡ 性能考量

我们为 WrkstrmLog 进行了涡轮增压

7. 🔮 结论和后续步骤

WrkstrmLog 不仅仅是一个日志记录器; 它是您通往日志记录涅槃的门票。 🧘‍♂️ 告别特定于平台的头痛,迎接日志记录的幸福!

请继续关注我们的下一集:“WrkstrmLog Advanced:将您的日志变成超级英雄!” 🦸‍♂️📚


有关更多令人兴奋的细节,请访问我们的 GitHub 仓库 或深入研究我们的 文档。 祝您日志记录愉快! 🎉🔧