Adds emacs lsp docs. #46
Conversation
|
|
||
| `LSP` has two components, the client and the server. | ||
|
|
||
| ### Setting up LSP Server |
There was a problem hiding this comment.
Silver language server specific stuff that isn't specific to the emacs plugin should probably be a separate page that is linked here. Which I was intending to write at some point, but the steps for building the language server are a good start.
There was a problem hiding this comment.
I can move this to another page
| Then, go to `silver/language-server/` and run `./build.sh` to build the language server. When it finishes | ||
| you should have a jar `/silver/language-server/launcher/target/launcher.jar`. | ||
|
|
||
| After that, make a script `silver-language-server`, put it in your `$PATH` somehow (I put it in `~/bin/`, where the other silver scripts are linked to), and put the following contents into it: |
There was a problem hiding this comment.
See our discussion on slack. If we do need this script it's probably okay to check it in to the Silver repo rather than telling people to create it. But having the JVM flags hardcoded here seems wrong.
There was a problem hiding this comment.
Reminds me, (I realize I asked about this earlier, but I forgot) can the jvm flags passed to start the language server jar just be the same as the jvm flags passed in as config options? Is there any advantage to setting different options for the lsp jar itself?
There was a problem hiding this comment.
The "Jvm Args" config option in the VS code extension is just the flags it uses when starting the server jar - this setting is never queried by the server itself. I am suggesting doing something similar for emacs.
| methods outlined here, one for vanilla emacs users, and one for users of [Doom Emacs](https://github.com/doomemacs/doomemacs/). | ||
|
|
||
|
|
||
| #### Vanilla Emacs |
There was a problem hiding this comment.
Probably better to check these in somewhere under support/emacs and link to them here rather than having people copy/paste from here.
|
|
||
| ```elisp | ||
| ;; Assumes silver-mode is somewhere in your load-path | ||
| (require 'silver-mode) |
There was a problem hiding this comment.
Why does this depend on silver-mode? That only provides somewhat outdated regex-based syntax highlighting which is mostly obsoleted by the language server?
I guess it maybe is better than nothing as a fall-back when the server is starting or the file has a syntax error.
There was a problem hiding this comment.
Yea, I figured maybe it's helpful to still have some syntax highlighting if you have a syntax error.
We could drop the silver-mode stuff, but it does help to have a function like silver-mode so we fit the pattern for language plugins in emacs of having a language-name-mode function to start the language specific behavior and language-name-mode-hook to add additional functionality on startup.
Adds documentation for setting up emacs and lsp for silver development.