Consider switching from codespan-reporting to annotate-snippets about rslint HOT 6 CLOSED

i would rather stick with primary/secondary and then just add info, i dont think theres a difference between info, note, and help

from rslint.

Can you name more benefits that make annotate-snippets better than codespan (except multiline-suggestions)?

Edit: I looked a bit through annotate-snippets documentation and it looks like it can display much more stuff but it definitely requires a better API to use it in RSLint.

from rslint.

I came up with a simple API design that is similair to codespan-reporting but adjusted to work with annotate-snippets

// not sure if we want to change the name to `Snippet` or stay with `Diagnostic`
Snippet::new(file_id)
    .title(Annotation::note("SyntaxError", "expected `,`, found `;`"))
    .annotate(AnnotatioType::Error, span, "")
    .annotate_help(span, "remove this `;`")
    .footer(Footer::help("remove this `;`"))

To display the errors we could take a similar approach as codespan-reporting and have an extra method (emit)
that will take a impl Files and Vec<Snippet> and will display them.

from rslint.

I would rather not keep the Snippet name, i dont really like it, i think diagnostic is better and most of rslint uses the word diagnostic. Moreover, id like to keep the diagnostic builder interface for the most part, also, id like to take some ideas from rustc_errors. I think this would be better:

Diagnostic::new(file_id, "some-code", "some error name here")
  .primary(span, "oh no")
  .secondary(span, "oh wow")
  .suggestion(Applicability::Always, "isNaN(foo)")

I think for the struct we can take some ideas from rustc_errors, notes are sub-diagnostics, suggestions are a vector of suggestions, etc. suggestions would use a diff to label any insertions, and we can also have other kinds of sub-diagnostics. Annotate-snippets' IR makes it easy for us to define our own diagnostic features

from rslint.

So you don't want to use the different annotation types for the labels / annotations that can be used in annotate-snippets?
I think they can be quite useful.

from rslint.

I will officially work on this now

from rslint.