Code Monkey home page Code Monkey logo

printer's Introduction

Printer – A fancy way to print logs.

You can print following types of logs with Printer.

  • ✅ Success
  • ❌ Error
  • 🚧 Warning
  • 📣 Information
  • 🚨 Alert

With each of the type, it will print a particular emoji and titles which will help you to easily identify what's exactly the log is. Moreover, it will looks cool too.

Let's see what you can do with Printer.

Printer has a singleton, you should always use it with it's singleton.

Printer.log.show(id: "001", details: "This is a Success message.", logType: .success)

See the output. Isn't it cool?

Printer ➞ [✅ Success] [⌚04-27-2017 10:39:26] [🆔 101] ➞ ✹✹This is a Success message.✹✹

So here are other options you can do with Printer.

Printer.log.show(id: "002", details: "This is a Error message.", logType: .error)
Printer.log.show(id: "003", details: "This is an Information message.", logType: .information)
Printer.log.show(id: "004", details: "This is a Warning message.", logType: .warning)    
Printer.log.show(id: "005", details: "This is an Alert message.", logType: .alert)

Output:

Printer ➞ [❌ Error] [⌚04-27-2017 10:41:39] [🆔 102] ➞ ✹✹This is a Error message.✹✹
Printer ➞ [🚧 Warning] [⌚04-27-2017 10:41:39] [🆔 103] ➞ ✹✹This is a Warning message.✹✹
Printer ➞ [📣 Information] [⌚04-27-2017 10:41:39] [🆔 104] ➞ ✹✹This is an Information message.✹✹
Printer ➞ [🚨 Alert] [⌚04-27-2017 10:41:39] [🆔 105] ➞ ✹✹This is an Alert message.✹✹

Different ways to print logs.

Don't want to specify the logType everytime? No problem, we have function for that too.

Printer.log.success(id: "101", details: "This is a Success message. No need to specify logType.")
Printer.log.error(id: "102", details: "This is a Error message. No need to specify logType.")
Printer.log.warning(id: "103", details: "This is a Warning message. No need to specify logType.")
Printer.log.information(id: "104", details: "This is a Information message. No need to specify logType.")
Printer.log.alert(id: "105", details: "This is a Alert message. No need to specify logType.")

Don't want to specify IDs? We have taken care about that too.

Printer.log.success(details: "This is a Success message without ID.")
Printer.log.error(details: "This is a Error message without ID.")
Printer.log.warning(details: "This is a Warning message without ID.")
Printer.log.information(details: "This is a Information message without ID.")
Printer.log.alert(details: "This is a Alert message without ID.")

We have overrided the 'show' function.

Printer.log.show(details: "This is a Success message.", logType: .success)
Printer.log.show(details: "This is an Alert message.", logType: .alert)

plainLog

Don't like this the fancy logs? No worries, we have a plain log option.

DEFAULT: false

Printer.log.plainLog = true

Exmaple when plainLog is set to true.

Printer ➞ [04-27-2017 10:50:30] ID ➞ 001 Details ➞ This is a Success message.
Printer ➞ [04-27-2017 10:50:30] ID ➞ 002 Details ➞ This is a Error message.
Printer ➞ [04-27-2017 10:50:30] ID ➞ 003 Details ➞ This is an Information message.
Printer ➞ [04-27-2017 10:50:30] ID ➞ 004 Details ➞ This is a Warning message.
Printer ➞ [04-27-2017 10:50:30] ID ➞ 005 Details ➞ This is an Alert message.

IMPORTANT: Any properties you're setting should be set in advance or before printing any logs to get the exact effect.

SUGGESTION: You can always set all the properties to customize the Printer in AppDelegate.swift file,

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
        // Override point for customization after application launch.

        //set the properties and call the specific function as per the need.

        Printer.log.plainLog = true
        Printer.log.addLineAfterEachPrint = true
        Printer.log.capitalizeTitles = true
        Printer.log.capitalizeDetails = true
        Printer.log.printOnlyIfDebugMode = true

        Printer.log.hideTitles()
        Printer.log.hideEmojis()

        return true
    }

This will set the properties globally and will be available for the entire app life cycle.

Customize Printer

You can add a line after each logs.

DEFAULT: false IMPORTANT: Should be call in advance.

Printer.log.addLineAfterEachPrint = true

Example when addLineAfterEachPrint is set to true.

Printer ➞ [✅ Success] [⌚04-27-2017 10:53:28] [🆔 001] ➞ ✹✹This is a Success message.✹✹
________________________________________________________________________________________
Printer ➞ [❌ Error] [⌚04-27-2017 10:53:28] [🆔 002] ➞ ✹✹This is a Error message.✹✹
________________________________________________________________________________________
Printer ➞ [📣 Information] [⌚04-27-2017 10:53:28] [🆔 003] ➞ ✹✹This is an Information message.✹✹
________________________________________________________________________________________
Printer ➞ [🚧 Warning] [⌚04-27-2017 10:53:28] [🆔 004] ➞ ✹✹This is a Warning message.✹✹
________________________________________________________________________________________
Printer ➞ [🚨 Alert] [⌚04-27-2017 10:53:28] [🆔 005] ➞ ✹✹This is an Alert message.✹✹
________________________________________________________________________________________

Capitalize Titles & Details

You can even capitalized the title and details of logs.

DEFAULT: false IMPORTANT: Should be call in advance.

Printer.log.capitalizeTitles = true

DEFAULT: false IMPORTANT: Should be call in advance.

Printer.log.capitalizeDetails = true

Example when capitalizeTitles and capitalizeDetails are set to true.

Printer ➞ [✅ SUCCESS] [⌚04-27-2017 11:09:37] [🆔 001] ➞ ✹✹THIS IS A SUCCESS MESSAGE.✹✹

Don't want to show Emojis?

IMPORTANT: Should be call in advance.

Printer.log.hideEmojis()

Example when hideEmojis() call.

Printer ➞ [Success] [04-27-2017 11:08:45] [001] ➞ ✹✹This is a Success message.✹✹
Printer ➞ [Error] [04-27-2017 11:08:45] [002] ➞ ✹✹This is a Error message.✹✹
Printer ➞ [Information] [04-27-2017 11:08:45] [003] ➞ ✹✹This is an Information message.✹✹
Printer ➞ [Warning] [04-27-2017 11:08:45] [004] ➞ ✹✹This is a Warning message.✹✹
Printer ➞ [Alert] [04-27-2017 11:08:45] [005] ➞ ✹✹This is an Alert message.✹✹

Don't want to show Titles?

IMPORTANT: Should be call in advance.

Printer.log.hideTitles()

Customize Emojis

Don't like the Emojis which is available? Want to set your own? You can do this.

IMPORTANT: Should be call in advance.

Printer.log.successEmojiSymbole = "🎃"

Oter properties for Emojis customization.

IMPORTANT: Should be call in advance.

Printer.log.errorEmojiSymbole = "<SetNew>"    
Printer.log.warningEmojiSymbole = "<SetNew>"    
Printer.log.infoEmojiSymbole = "<SetNew>"    
Printer.log.alertEmojiSymbole = "<SetNew>"

Customize Titles

Don't like the Titles which is available? Want to set your own? Want to set the localize titles? You can do this.

IMPORTANT: Should be call in advance.

Printer.log.successLogTitle = "Hurray!!"

Other properties for Titles customization.

IMPORTANT: Should be call in advance.

Printer.log.errorLogTitle = "<SetNew>"    
Printer.log.warningLogTitle = "<SetNew>"    
Printer.log.infoLogTitle = "<SetNew>"    
Printer.log.alertLogTitle = "<SetNew>"

Customize Symboles

Don't like the Symboles which is available? Want to set your own? You can do this.

IMPORTANT: Should be call in advance.

Printer.log.arrowSymbole = "⇨"

Oter properties for Symbole customization.

IMPORTANT: Should be call in advance.

Printer.log.starSymbole = "<SetNew>"

Don't like the date format in logs? You can change it too.

DEFAULT: MM-dd-yyyy HH:mm:ss IMPORTANT: Should be call in advance.

Printer.log.logDateFormat = "hh:mm:ss a"

Example when logDateFormat is set to a different format.

Printer ➞ [✅ Success] [⌚11:12:23 AM] [🆔 001] ➞ ✹✹This is a Success message.✹✹

Filter Logs

Show specific logs with filter.

Printer.log.filterLogs = [.success, .alert]

This should only print logs of the specified types. I.e. Succes and Alert. All other logs will be ignored.

Disable Logs

To disable all the logs.

DEFAULT: false IMPORTANT: You can set this anywhere and it should not print logs from where it sets.

Printer.log.disable = true

Ready to ship your app?

Don't want to print the logs in RELEASE mode?

DEFAULT: true IMPORTANT: Should be call in advance.

Printer.log.printOnlyIfDebugMode = false

Credits

Hemang Shah  

Licence

The MIT License (MIT)

Read the LICENSE file for details.

printer's People

Watchers

avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.