Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add predictable error output formatting and color support #102

Open
rwxrob opened this issue Nov 8, 2022 · 0 comments
Open

Add predictable error output formatting and color support #102

rwxrob opened this issue Nov 8, 2022 · 0 comments

Comments

@rwxrob
Copy link
Owner

rwxrob commented Nov 8, 2022

The look and feel of bonzai commands should be consistent and clean, just like with the help documentation, but with stronger opinions about what they should look like so that bad error messages are discouraged in the Bonzai ecosystem. Error text can therefore be handled consistently.

  • Assume error type or location before : (color strongly)
  • Assume anything after : is key text of error (color legibly)
  • Assert blank new line and add if not
  • Assume everything else is boring, verbose explanation (muted color, but legible)

Use only standard terminal colors so that they change with terminal themes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant