question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Usability: error feedback easy to miss

See original GitHub issue

When an error occurs during prettification, it can look like Prettier is just failing silently, with no apparent cause.

For example, say I have the following JavaScript file:

export { foo };

export function foo() {
  console.log(       1,    2,          3);;
}

When I run the “Format Document” command, I’m expecting the file to be reformatted. However, since there is a syntax error that I didn’t notice (foo is exported twice), prettification fails. To me, it looks like nothing is happening at all; the file is simply not being formatted.

After some sleuthing, I discovered that there is a clickable “Prettier” entry in the status bar, and that it changes to “X” when an error occurs:

status bar

It was not obvious to me that I should look for an error indicator in the status bar. For the longest time, I assumed that “Format Document” would simply silently stop working at random times, and I wasn’t sure why.

Perhaps usability could be improved by providing a clearer error notification.

Issue Analytics

  • State:closed
  • Created 6 years ago
  • Reactions:1
  • Comments:10 (5 by maintainers)

github_iconTop GitHub Comments

1reaction
CiGitcommented, Jun 4, 2018

Back with notifications !

1reaction
RobinMalfaitcommented, May 1, 2018

@joliss, @atombender It’s done, #434 🙏

Read more comments on GitHub >

github_iconTop Results From Across the Web

How to Report Errors in Forms: 10 Design Guidelines
Help users recover from errors by clearly identifying the problems and allowing users to access and correct erroneous fields easily.
Read more >
Error prevention in UX design: How Facebook and Gmail get it ...
These simple guidelines can help enable lower rates of user errors, and ultimately improve usability. When you design conscientiously like this, you can...
Read more >
Are You Giving Your Users Positive Feedback?
This is easy to miss, even if the user's attention is in the right place. When a user's interaction triggers a subtle page...
Read more >
37 usability guidelines for help, feedback and error tolerance
The FAQ or on-line help provides step-by-step instructions to help users carry out the most important tasks. It is easy to get help...
Read more >
What Does Usability Mean: Looking Beyond 'Ease of Use'
Usability relies on user-feedback through evaluation rather than simply trusting ... The 5 Es – efficient, effective, engaging, error tolerant and easy to ......
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found