Abhisek DattaandGitHub
8cba52201c
* feat: Add config support for UI verbosity level * docs: Add verbosity info in UI doc
1.2 KiB
User Interface
PMG is an interactive tool. We support multiple interactivity modes such as silent, verbose etc. to meet different developer experience needs. As such, we need to standardize the UI, UX and interactive messaging guidance for developers.
The verbosity level can be set per-invocation using --silent or --verbose CLI flags, or persisted via the verbosity option in the configuration file.
Messaging
Two types of messages to users are supported:
- UI messages
- Logs
UI messages
UI messages are displayed in the user interface, currently in the terminal. Following types of messages are supported:
- Status updates - Meant for showing the stage or status of the workflow.
- Error messages - Meant for showing fatal error messages
| Type | Mode | Show? |
|---|---|---|
| Status | Silent | No |
| Status | Verbose | Yes |
| Error | Silent | Yes |
| Error | Verbose | Yes |
Logs
Logs are by default for inspection and debugging purposes. They are not shown by default but can be configured through verbosity levels or logging to files. Consider logs as something meant for use only when there is an unexpected behavior.