LogMoji 1.0.0

LogMoji 1.0.0

Alec Dilanchian 维护。



LogMoji 1.0.0

LogMoji

CI Status Version License Platform

LogMoji log statements being displayed

介绍

LogMoji 帮助您用具有意义、自定义的符号来解析所有冗长的日志语句!这个简单的记录器可以将记录输出到控制台、指定的文件路径或两者同时。它还支持您设置尽可能多的自定义状态。使用 LogMoji,使您的日志语句更容易阅读。

入门

安装

LogMoji 通过 CocoaPods 提供。要安装它,只需将以下行添加到 Podfile 中:

pod 'LogMoji'

用法

LogMoji 使您能够快速轻松地开始使用!对于基本用法,请您按照以下步骤操作:

import LogMoji

// Define your custom log states
LogMoji.logger.setStates([
    "success": "",
    "warning": "⚠️",
    "critical": "🚨"
])

// Decide where to log & whether to show a timestamp
LogMoji.logger.logToConsole(true)
LogMoji.logger.setFilePath("Path/To/File.txt")
LogMoji.logger.showTimeStamp(false)

// Start Logging!
LogMoji.logger.logWith(state: "success", message: "I am a successful LogMoji message!")
LogMoji.logger.logWith(state: "warning", message: "I am a warning LogMoji message!")
LogMoji.logger.logWith(state: "critical", message: "I am a CRITICAL LogMoji message!")

setStates(Dictionary)

此方法可以将任何您希望添加到应用的州。传入一个ID,并将其与您选择的表情符号关联!

logWith(state: String, message: String)

这是在LogMoji中实际记录任何信息的主要方法。在使用此方法前,请确保已设置您的状态和设置。

logToConsole(_ value: Bool)

决定是否将状态记录到控制台。
默认为true

setFilePath(_ path: String?)

设置您希望输出日志的文件路径!此功能已与绝对路径进行了测试。
默认为nil

showTimeStamp(_ value: Bool)

决定是否将时间戳添加到日志前。
默认为true

defaultState

如果找不到州,日志语句将默认显示为defualtState表情符号。如果需要,可以更改此设置。
默认为

changeDefaultState(emoji: String)

设置默认表情状态,以供在找不到指定状态时使用。

示例项目

要运行示例项目,首先克隆仓库,然后从示例目录执行 pod install。这个简单应用程序向您展示了 LogMoji 的非常基本的概念。

作者

Alec Dilanchian
Twitter
Twitch
Email

许可证

LogMoji 以 MIT 许可证可用。有关更多信息,请参阅 LICENSE 文件。