emacs-eaf / emacs-eaf/emacs-application-framework
Consistent log formating for the installer
- Dominant language
- Python
- Stars
- 3.5k
- Forks
- 245
- Avg merge
- 22h 20m
- Merged PRs (30d)
- 1
Description
**Is your feature request related to a problem? Please describe.**
During the installation process, while there's a format that's repeated (i.e [EAF] prepended to installer-related logs), it's not consistent throughout all eaf-related logs. Leading to places where we log eaf-related errors yet make no indication this error is related to eaf itself which is confusing (e.g the "Error:" pattern with a plain print is commonly repeated).
There's also no difference between errors/warn/info for users, either in terms of formatting and color.
**Describe the solution you'd like**
- A consistent structure for the eaf-installer' stdout messages (info,warn,success,error) including coloring, structure that differentiates them.
**Describe alternatives you've considered**
None.
**Additional context**
I'd love to take these on personally, if the maintainers are okay with these proposals. I'm thinking of the following changes
1. Add functions for error, warn, info, success with their respective format and colors and refactor existing print() statements with them.
Let me know what you think.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by locating the eaf-installer entry points and its existing print() statements for stdout messages. Review how installer-related logs are currently formatted, then define the requested info, warn, success, and error structure and colors. Done means the installer’s EAF-related messages use the consistent formats and distinguish these four categories.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100