Skip to content

[Tooling] CLI: make sure outputs to the user are not log package calls #200

@deblasis

Description

@deblasis

Objective

Make sure that the CLI outputs to the user in the best way possible.

Currently, we are not logging anything inside the CLI, we might in the future, at that point we'll have to distinguish between that's UX and logging but that's another story for another day. KISS for now I'd say.

Origin Document

A discussion around the use of log vs fmt package functions when printing stuff to StdOut/StdErr

Explanation of the problem here

Tiny action Item here. Creating the issue just to log this and to finally push #177 out without additional scope creep.

Goals

  • Replace log package calls to fmt where appropriate in the context of the CLI.

Deliverable

  • Updated CLI with direct output to StdOut/StdErr and no log

Non-goals / Non-deliverables

  • ...

General issue deliverables

  • Update the appropriate CHANGELOG
  • Update any relevant READMEs (local and/or global)
  • Update any relevant global documentation & references
  • If applicable, update the source code tree explanation
  • If applicable, add or update a state, sequence or flowchart diagram using mermaid

[Optional] Testing Methodology

  • Task specific tests: make ...
  • All tests: make test_all
  • LocalNet: verify a LocalNet is still functioning correctly by following the instructions at docs/development/README.md

Creator: @deblasis
Co-Owners: ??

Metadata

Metadata

Assignees

No one assigned

    Labels

    code healthNice to have code improvementtelemetryeverything related to collection telemetrytoolingtooling to support development, testing et altriageIt requires some decision-making at team level (it can't be worked on as it stands)

    Type

    No type

    Projects

    Status

    Done

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions