Make type error location "clickable" #2161
Conversation
Use the real filesystem path to the module where a type error was raised. This means replacing "." with path separator and appending the ".act" suffix. So foo.bar@123 becomes foo/bar.act@123 This makes it possible for VS Code to create a clickable link to the file. Well, almost, because VS Code does not recognize "@" as a file - location separator. Not sure if the diagnostic package can be tweaked to use ":" instead of "@"?
|
Sounds like an issue to be reported upstream https://hackage.haskell.org/package/diagnose Diagnose is inspired by Ariadne, a rust library to print pretty error messages. Ariadne seems to be using : to separate file name from location. Not sure why diagnose pick @. Seems like colon would be better. Perhaps a patch could be accepted upstream to just change or offer customizability. |
| modNameToErrorString :: A.ModName -> String | ||
| modNameToErrorString mn = joinPath (map nameToString names) ++ ".act" |
There was a problem hiding this comment.
| modNameToErrorString :: A.ModName -> String | |
| modNameToErrorString mn = joinPath (map nameToString names) ++ ".act" | |
| modNameToFilename :: A.ModName -> String | |
| modNameToFilename mn = joinPath (map nameToString names) ++ ".act" |
| handleTypeError opts errKind f src paths mn ex = do | ||
| printDiag opts $ mkErrorDiagnostic (modNameToString mn) src (typeReport ex (modNameToString mn) src) | ||
| printDiag opts $ mkErrorDiagnostic (modNameToErrorString mn) src (typeReport ex (modNameToErrorString mn) src) |
There was a problem hiding this comment.
| printDiag opts $ mkErrorDiagnostic (modNameToErrorString mn) src (typeReport ex (modNameToErrorString mn) src) | |
| printDiag opts $ mkErrorDiagnostic (modNameToFilename mn) src (typeReport ex (modNameToFilename mn) src) |
|
I think the change from the internal module path to filenames is valid regardless if it makes clickable links or not, so we can proceed with this particular PR. I made a suggestion to your code. We have golden tests for typeerrors and syntax errors that are changed because of this. You need to run The other piece is of course work in upstream. We could vendor the Diagnose library and make local changes if we want to move fast and/or test this out to see how it feels. A challenge might be that our error format includes multiple locations. One is picked as the primary point where we think the error is, but sometimes it is just hard to pin point the exact error, like it is often the non-alignment between location A and B. Is A or B then the error? I think we tend to point to the use / call site and consider the definition the correct one, but it's probably not 100%... so just saying, that's a challenge. In gcc style errors (from which the clickable link format comes from), stuff just gets rendered quite differently, so clickable links are easier there. |
Use the real filesystem path to the module where a type error was raised. This means replacing "." with path separator and appending the ".act" suffix. So foo.bar@123 becomes foo/bar.act@123
This makes it possible for VS Code to create a clickable link to the file. Well, almost, because VS Code does not recognize "@" as a file - location separator. Not sure if the diagnostic package can be tweaked to use ":" instead of "@"?