Expand description
UI rendering helpers for consistent output formatting.
The ui module provides functions for formatting error messages and other user-facing output in a consistent and visually appealing way. It is used throughout the CLI application to ensure that all messages are presented in a clear and user-friendly manner.
Functionsยง
- dim
- Prints a user-facing message in a dimmed or less prominent style.
- error
- Prints a user-facing message for an error or failure.
- error_
prefix - Prints a user-facing message for an error, with a prefix indicating the error type.
- format_
context_ error - Formats an error message with additional context for display to the user, including a colored prefix based on the error kind. This is useful for providing more information about the error, such as where it occurred or what operation was being attempted when the error happened.
- format_
error - Formats an error message for display to the user, including a colored prefix based on the error kind.
- heading
- Prints a user-facing heading or section title.
- id
- Prints a user-facing label for an ID or unique identifier.
- info
- Prints a user-facing message for informational purposes.
- key
- Prints a user-facing label for a key or identifier.
- path
- Prints a user-facing label for a file path or location.
- status_
bad - Prints a user-facing message for an error status.
- status_
ok - Prints a user-facing message for a successful status.
- status_
warn - Prints a user-facing message for a warning status.
- success
- Prints a user-facing message for a successful operation.
- warning
- Prints a user-facing message for a warning or recoverable issue.