Expand explanation of how to configure HLS #497
Conversation
This topic tends to confuse people, which is unsurprising since there are several parts which can in principle be configured separately. I've tried to explain this a bit better. I also tried to give some brief documentation on the language server settings that we provide. In the process I found that a few of them seem to be currently unused, so I'm not sure what to say about them.
| variable to the file in which you want to keep your LSP settings | ||
| Most clients (editors) already have an opinion about how settings should be configured! | ||
| For example, in VS Code you use the graphical Settings tab or `settings.json`, whereas in Emacs you use customization variables. | ||
| In the [editor configuration section](#configuring-your-editor) we give some pointers for popular editors, but you should consult the documentation for your specific editor if you have trouble. |
There was a problem hiding this comment.
The "pointers" are missing, I think, so the first part of the sentence is a bit confusing.
There was a problem hiding this comment.
Hm yes, it's not very explicit, let's fix that.
There was a problem hiding this comment.
I added some more pointers where I know them!
There was a problem hiding this comment.
Ah, sorry! My original comment was kind of dumb in retrospect, I hadn't noticed the markdown formatting!
In any case, thanks for adding more stuff, I would "resolve" this if I was more adequate at github!
README.md
Outdated
|
|
||
| Adding support for new editors is fairly easy if the editor already has good support for generic LSP-based extensions. | ||
| In that case, there will likely be an editor-specific support system for this (like `lsp-mode` for Emacs). | ||
| This will typically include instructions for creating a new language server client. |
There was a problem hiding this comment.
I don't think this is true. You're not creating a new lsp client - that would mean the entire idea lsp is based on is obsolete.
And some editors (e.g. (n)vim, kakoune, sublime (as far as I can tell)) directly use their lsp clients without Haskell specific "wrappers" - you only need to do configuration.
There was a problem hiding this comment.
Okay, I'll make this less prescriptive.
This topic tends to confuse people, which is unsurprising since there
are several parts which can in principle be configured separately. I've
tried to explain this a bit better.
I also tried to give some brief documentation on the language server
settings that we provide. In the process I found that a few of them seem
to be currently unused, so I'm not sure what to say about them.