Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
Sometimes you just want to print a message that tells you a line of code was executed. Inspired by a tweet from Paige Sun: https://twitter.com/_PaigeSun/status/1161132108875796480
/// Log the current filename and function, with an optional extra message. Call this with no arguments to simply print the current file and function. Log messages will include an Emoji selected from a list in the function, based on the hash of the filename, to make it easier to see which file a message comes from.
/// - Parameter message: Optional message to include
/// - file: Don't use; Swift will fill in the file name
/// - function: Don't use, Swift will fill in the function name
/// - line: Don't use, Swift will fill in the line number
func logMilestone(_ message: String? = nil, file: String = #file, function: String = #function, line: Int = #line) -> Void {
#if DEBUG
// Feel free to change the list of Emojis, but don't make it shorter, because a longer list is better.
let logEmojis = ["πŸ˜€","😎","😱","😈","πŸ‘Ί","πŸ‘½","πŸ‘Ύ","πŸ€–","πŸŽƒ","πŸ‘","πŸ‘","🧠","πŸŽ’","🧀","🐢","🐱","🐭","🐹","🦊","🐻","🐨","🐡","πŸ¦„","πŸ¦‹","🌈","πŸ”₯","πŸ’₯","⭐️","πŸ‰","πŸ₯","🌽","πŸ”","🍿","🎹","🎁","❀️","🧑","πŸ’›","πŸ’š","πŸ’™","πŸ’œ","πŸ””"]
let logEmoji = logEmojis[abs(file.hashValue % logEmojis.count)]
if let message = message {
print("Milestone: \(logEmoji) \((file as NSString).lastPathComponent):\(line) \(function): \(message)")
} else {
print("Milestone: \(logEmoji) \((file as NSString).lastPathComponent):\(line) \(function)")
}
#endif
}
/// Convenience to log an error using `logMilestone`-style logging with file location and an Emoji
/// - Parameters:
/// - error: Any `Error`
/// - file: Don't use; Swift will fill in the file name
/// - function: Don't use, Swift will fill in the function name
/// - line: Don't use, Swift will fill in the line number
func logMilestone(_ error: Error, file: String = #file, function: String = #function, line: Int = #line) -> Void {
logMilestone(error.localizedDescription, file: file, function: function, line: line)
}
@atomicbird

This comment has been minimized.

Copy link
Owner Author

atomicbird commented Jan 17, 2020

I wrote a blog post about this at https://atomicbird.com/blog/emoji-logging/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.