When I’m generating output from a script or process I typically use a standard set of prefixes to aid in displaying information about whats occuring.
Prefixes#
These prefixes take the format of a single letter or meaningful symbol contained within square brackets
While Emoji can be used its recommended to be avoided for compatability and simplicity.
The following are the currently used prefixes
[i]#
These are for infomational events. They may indicate the start or end of something.
Example:
[i] Running Script X
[w]#
These are to mark events that generate warnings to indicate when things aren’t quite right
Example:
[w] File Missing
[!] or [c]#
This is to mark critical events like when things go bad or are about to perform a critical task
Example:
[!] Storage Full
[D]#
This is to highlight any debug information that we have asked to see in our output.
Example:
[D] "foo: X=false"