LSP selects the "wrong" location to display error message

[denismerigoux]

Suppose the following error message in CLI :

┌─[ERROR]─
│
│  Field montant_après_CRDS does not belong to structure Commun.Droit
│
├─➤ src/hierarchisation.catala_fr:94.11-94.69:
│    │
│ 94 │           droit_final_af_majorées - prestation_af.montant_avant_crds
│    │           ‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾
├─ Brique 5 : hiérarchisation des prestations
│  └─ Règles à implémenter
│
│ Declaration of structure Commun.Droit
├─➤ src/commun.catala_fr:56.23-56.28:
│    │
│ 56 │ déclaration structure Droit:
│    │                       ‾‾‾‾‾
└─

When displayed with the LSP and VSCode extension, this error messages highlights Droit and the structure declaration instead of the place where the struct field access is. This bad choice of location for the LSP concern other error messages that display more than one code location.

[denismerigoux]

@vincent-botbol upping the priority of fixing this, it caused some confusion for @guillaumeFerard and I last Friday when debugging his code :)

[vincent-botbol]

This one instance is strange, I got a consistent message on the catala's test file.

However, you're definitely right, in some instances, it would be useful to have multiple locations in some cases. We'll need to find a solution in the long term. For the short term, we can manually prioritize these locations.