If you need to customize how TTY::Command outputs command execution details (like the command start, stdout, stderr, or exit status), you can subclass TTY::Command::Printers::Abstract.
To create a functional printer, you must implement the write(cmd, message) method, as the base class raises a NotImplemented error if it is called directly.
Lifecycle Hooks
The abstract printer provides several hooks that are called during the command lifecycle. You can override these to control how specific events are formatted:
print_command_start(cmd, *args): Called when the command begins. It uses cmd.to_command to get the command string.print_command_out_data(cmd, *args): Called when standard output is received.print_command_err_data(cmd, *args): Called when error output is received.print_command_exit(cmd, *args): Called when the command exits.
Initialization
When initializing your printer, you can pass an output IO object and an options hash. The options hash supports a :color key to enable or disable ANSI color support via Pastel.
@output: The IO object where data is written.@options: Configuration options.@out_data: A string buffer for standard output data.@err_data: A string buffer for error data.
class MyCustomPrinter < TTY::Command::Printers::Abstract
def write(cmd, message)
# Your custom logic to handle the command and message
@output.puts "[#{cmd}] #{message}"
end
end
