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

Error messages hard to read #91

Closed
akaroml opened this issue Nov 19, 2018 · 4 comments
Closed

Error messages hard to read #91

akaroml opened this issue Nov 19, 2018 · 4 comments
Labels
enhancement New feature or request validation
Milestone

Comments

@akaroml
Copy link

akaroml commented Nov 19, 2018

When editing pom.xml file with an error, the error message showed by XML extension is very hard to read.
screen shot 2018-11-19 at 10 12 24 am
It's too long
It has too much information and unnecessary details
It does not provide clear action items

Please consider improve the message by:

  1. Remove all the namespaces before the actual element names: e.g. {"http://maven.apache.org/POM/4.0.0":name2} -> name2
  2. Incorporate proper formatting/coloring to improve readability
  3. Check similarity of the node name and rank the most possible one on top

Sample:

[XML] Invalid content was found starting with element 'name2'.
Possible values:
-> name
description
packaging
url
...

@fbricon fbricon added enhancement New feature or request validation labels Nov 19, 2018
@fbricon
Copy link
Collaborator

fbricon commented Nov 19, 2018

See upstream issue: eclipse/lemminx#181

@fbricon fbricon added this to the 0.4.0 milestone Dec 5, 2018
@fbricon
Copy link
Collaborator

fbricon commented Feb 26, 2019

So here's how it looks after overriding the error messages in eclipse/lemminx#297:
Before:
screen shot 2019-02-26 at 12 18 02 pm

After
screen shot 2019-02-26 at 12 22 06 pm

I'm a bit concerned by the way vscode shows the error message in the problems view.

@fbricon
Copy link
Collaborator

fbricon commented Feb 26, 2019

I've opened microsoft/vscode#69473 about the diagnostic rendering

@fbricon
Copy link
Collaborator

fbricon commented Mar 6, 2019

Copying the upstream comment here about the changes:

Before:

screen shot 2019-02-25 at 12 34 22 pm

After:

selection_016


Before:

screen shot 2019-02-25 at 12 22 16 pm

After:

selection_019


Before:
screen shot 2019-02-25 at 12 08 45 pm

After: (Uses single quotes now)

selection_021


Before:

screen shot 2019-02-25 at 12 24 39 pm

After:

selection_022


Before:

screen shot 2019-02-25 at 12 36 37 pm

After:

selection_024


Before:

screen shot 2019-02-25 at 12 17 24 pm

After:

selection_026

@fbricon fbricon closed this as completed Mar 6, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request validation
Projects
None yet
Development

No branches or pull requests

2 participants