jiayangmiao / nayau Goto Github PK

#Nayau A production/debug logger for you Swift Project

• iOS 9.0
• Xcode 7.1+

Embedded frameworks require a minimum deployment target of iOS 8 or OS X Mavericks (10.9).

github "elo7/nayau" "master"

And add the path to the framework under “Input Files”, e.g.:

$(SRCROOT)/Carthage/Build/iOS/nayau.framework

First of all, you shall setup your debug/release flags, it's quite simple. "Set it in the Swift Compiler - Custom Flags section, 'Other Swift Flags' line. Just Add -D DEBUG. If you are having problems with that, look that Stack Overflow question.

And paste that code block in your setup area, it's the simple way that we found to know if your applications is in debug or release mode.

func isDebug() -> Bool {
    #if DEBUG
        return true
    #else
        return false
    #endif
}

Finally you can setup your Nayau:

import nayau

Nayau.setup(debugBuild: YourClass().isDebug())

Nayau.debug("A debug message")
#=> A debug message 

Nayay.debug("A error message in debug mode", logType: LogType.Error)
#=> [Error] : A error message in debug mode

Nayau.production("A production message")
#=> A production message 

Nayau.production("A error message in production mode", logType: LogType.Error) {
#=> [Error] : A error message in production mode

If you want to see file that logging information, just enable that in the Nayau setup method:

import nayau

Nayau.setup(enableFileName: true, debugBuild: YourClass().isDebug())

Nayau.debug("A debug message")
#=> A debug message FileInformation: File: yourPath/YourFile.swift Line Number: 61 Function: xablau()

Nayau.production("A production message")
#=> A production message FileInformation: File: yourPath/YourFile.swift Line Number: 61 Function: xablau()

If you want to compute something heavy to process, you can use Nayau with trailing closure, and that heavy compute will execute just in debug:

Nayau.debug {
    let xablau = [ "this" , "message" , "concat" , "is" , "just" , "necessary" , "in" , "debug" , "mode" ]

    return xablau.map {
        $0.uppercaseString
    }
}

Sometimes, we (developers) need to debug our developing applications, with that in mind, we built a simple tool that can help you with your debug/production log. When you need to print some information/data just for test/follow flow of your application, use debug instance method from Nayau, when you need to print something in released apps, use production instance method from Nayau. Quite simple :)

• If you found a bug, open an issue.
• If you have a feature request, open an issue.
• If you want to contribute, submit a pull request

Nayau is released under the MIT license. See LICENSE for details.