Reading log output

One of oneRepo’s main tenets is to have clear and understandable log output. Other task runners and tooling tend to either give you too much or too little output with cryptic and confusing patterns. You may often be presented with interleaved output from parallel tasks, making it difficult to trace what has happened and in what order.

Key details

Section titled Key details

• All logs are written to stderr. Only output information specifically meant as the return output from a command will be written to stdout. This ensures that capturing and redirecting appropriate output is easy and consistent across all commands.
• If the current environment implements TTY:
  • Output will be buffered
  • An animated spinner will indicate progress
  • Parallel asynchronous steps will be visible
  • Log type prefixes will be colorized

Prefixes

Section titled Prefixes

Type prefixes

 INFO General information that should always be shared
 ERR  Error output. The command will exit with a non-zero exit code.
 WRN  Worth calling out, but things will continue without a problem
 LOG  Slightly more verbose information when it's helpful
 DBG  Included when you really want to know what's goin on

Most commands will group and categorize work within LogSteps. These groupings aid in finding information quickly and determining where work is happening.

When steps succeed, they will end with a check mark and the amount of time that the entire step took to run:

Log types within a step

 ┌ Example success step
 │ INFO General information that should always be shared
 │ WRN  Worth calling out, but things will continue without a problem
 │ LOG  Slightly more verbose information when it's helpful
 └ ✔ 0ms
 ┌ Example step with an error
 │ INFO General information that should always be shared
 │ ERR  Some error output information
 │ ERR  that may be on multiple lines
 │ LOG  Slightly more verbose information when it's helpful
 └ ✘ 0ms

Command completion

Section titled Command completion

When a command completes, a message will be shown, including whether or not it had errors and how long the entire command took to run:

Completed successfully

 ■ ✔ Completed 5ms

This command finished cleanly with exit code 0.

Completed, but failed

 ■ ✘ Completed with errors 5ms

This command did not exit cleanly and provide a non-zero exit code.

Controlling verbosity

Section titled Controlling verbosity

All commands through the one CLI accept the verbosity flag to control how much or how little information will be printed to stderr. Control this output using either --silent, or by increasing the number of v characters with -v:

Value	What	Description
--silent	Silent	No output will written.
-v (default)	Error & Info	Error and general info output will be provided.
-vv	Warnings	Warnings and all preceding verbosity levels.
-vvv	Log	Logs and all preceding verbosity levels.
-vvvv	Debug	All preceding verbosity as well as extra debug information.
-vvvvv	Timing	All verbosity levels as well as performance timing entries.