Disable inlay hints under ghost location #1290
Conversation
|
Somehow this drops all the inlay hints in all of our tests. Those shouldn't be ghost locs. |
ocaml-lsp-server/src/inlay_hints.ml
Outdated
| @@ -56,6 +56,8 @@ let hint_binding_iter ?(hint_let_bindings = false) | |||
| | Texp_match (expr, cases, _) -> | |||
| iter.expr iter expr; | |||
| List.iter cases ~f:(case hint_pattern_variables iter) | |||
| (* Stop iterating when we see a ghost location to avoid annotating generated code *) | |||
| | _ when e.exp_loc.loc_ghost -> () | |||
There was a problem hiding this comment.
Shouldn't the case be above the Tstr_match and continue iteration with the default iterator?
There was a problem hiding this comment.
What makes you say that? Continuing with the default iterator will create inlay hints on the generated code.
There was a problem hiding this comment.
You're right!
Wouldn't it be possible for this to break the test suite because it's expressed in ‘expected’ tests, which de facto gives them a ghost location?
There was a problem hiding this comment.
That seems to be what's happening. When I build within Jane Street, the tests work fine (presumably because the document is created with non-ghost locations), but building with external libraries causes this issue where the test document has ghost locations. I'm trying to track down the source of the difference.
|
Okay, I disabled this fix in the tests. LGTM |
Pull Request Test Coverage Report for Build 4284Warning: This coverage report may be inaccurate.This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.
Details
💛 - Coveralls |
Inlay hints are both noisy and useless when applied to generated code. Examples include lots of unnecessary hints on the fields of a record definition that derives things like
sexporfields, or confusing annotations on format strings using!.All the generated code exists under typedtree nodes with ghost locations. This PR changes the inlay hint logic to stop iterating over the typedtree when it sees an expression or a structure item with a ghost location.