Skip to content

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

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

[UX] Improve console error output 🎨 #629

Closed
webknjaz opened this issue Nov 29, 2021 · 0 comments
Closed

[UX] Improve console error output 🎨 #629

webknjaz opened this issue Nov 29, 2021 · 0 comments
Labels
enhancement New feature or request

Comments

@webknjaz
Copy link
Member

webknjaz commented Nov 29, 2021

ISSUE TYPE
  • Feature Idea
SUMMARY

Monotonic stdout is sometimes hard to consume. If it contains errors, it may also be hard to make sense of them, find their bounds, and what they relate to. We can do better! I've seen what pip is currently trying to improve and I'd like us to follow the lead.
Here's an example of what they do pypa/pip#10421 (comment).

🖼️ pip's upcoming changes sneak peak Screenshot 2021-11-12 at 17 06 27

There are two things I like there:

  1. Visual separation and coloring.
  2. Human-readable error codes that can be searched for in the docs.
  3. The docs explain the reasoning and the solutions for those errors. The inspiration is coming from https://doc.rust-lang.org/error-index.html and https://eslint.org/docs/rules/.

P.S. We may want to consult with https://clig.dev while implementing this.

@webknjaz webknjaz added enhancement New feature or request new New issues and PRs to triaged labels Nov 29, 2021
@webknjaz webknjaz removed the new New issues and PRs to triaged label Jan 3, 2022
@ansible ansible locked and limited conversation to collaborators Feb 16, 2022
@cidrblock cidrblock converted this issue into discussion #963 Feb 16, 2022

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant