feat(ios): add useLog config #1431

[stewones]

@mlynch
@jcesarmobile

[stewones]

this PR provides a way to disable native logs #1431. you can control it on your capacitor.config.json

{
  "useLog": false
}

Update

• changed config option to production, so we can use that for more than one purpose (just like angular team do)

{
  "production": true
}

• abstraction of log things into its own class

usage

CAPLog.add(message: "Hey! I'm a log")

[stewones]

I can add android version, just let me know if the api fits good.

[jcesarmobile]

I think this print should be a drop in replacement for regular print, so should look like

 public static func print(_ items: Any..., separator: String = " ", terminator: String = "\n") {
        if (self.useLog() as? Bool != false) {
            Swift.print(items, separator, terminator)
        }
    }

No need to have the @objc as print is Swift only (same for the other methods and class)

Not sure if we need this new CAPLog class, or if we can just put it inside the CAPBridge class, as it has a modulePrint function already, or move that one to the new CAPLog class.

Another thing, CAPConfig is no longer a singleton, so code should be changed.
First a static config should be declared
public static let config = CAPConfig()

And change the usage to
let isProduction = config.getValue("production") as? Bool

But I not sure about the production name of the preference, in my experience, people tend to think they are building a production app just by setting that value to true, so I would stick with showLogs, or hideLogs, or useLogs

Or maybe just don't make it configurable and hide all the logs when a release build is done with the DEBUG macro

#if DEBUG
  print(...)
#endif

@mlynch thoughts?

[stewones]

drop in replacement looks awesome. thanks for the ideas.

from my work experience macros won't work. what if I wanted to check capacitor logs with my app in production mode.

[jcesarmobile]

As Max said we shouldn't show them by default, I suppose he means in production.
So it should check both isDevMode method from CAPBridge and the configuration option in the capacitor.config.json to always show them in dev mode, but in production only if enabled with the preference.