Support passing a swift-log Logger instance

[pepicrft]

We need to start differentiating between "logging" for which we'll use swift-log's interface, and "UI", which in the context of a CLI is the text that's part of the product experience and that's oriented towards communicating progress/actions to the developer that ran a command.

Noora components fall in the "UI" group, but I think it'd be beneficial to also log what the components do so that the logs can be used later on for debugging purposes.

[VaishaliDesai]

Hello, I would like to take this up. New to the repository so might need some guidance here :)

[pepicrft]

Hi @VaishaliDesai 👋🏼
Sure, that'd be amazing. The plan here is to support passing an instance of Logger, to each function in the Noorable protocol. For example:

func singleChoicePrompt<T: CaseIterable & CustomStringConvertible & Equatable>(
        title: TerminalText?,
        question: TerminalText,
        description: TerminalText?,
        collapseOnSelection: Bool
        logger: Logger
    ) -> T

And then use it in implementing each component to leave a trace of what happened. For example, in the above case it can be:

logger.info("Prompted the user to select an option for the question '\(question)'")
...
logger.info("Option '\(option)' selected for the question '\(question)'")

That way, consumers of this package can pass a Logger instance and provide a nice debugging experience to their users.

Let me know if you have any questions ;)

[VaishaliDesai]

Amazing, makes sense, thanks a lot. I’ll work on it :)

[fortmarek]

nit: I'd consider for the logger not to be required.