git.iko.soy/helix
on master help sign in
Improve documentation on Language Server installation (#2037)
commit78b16009433041059597cc6ccea28c17254483b7 authorMichael Davis <mcarsondavis@gmail.com> dateSat 9 Apr 2022, 01:47 (5 years ago) parent0b410b0
2 files changed+11−1
compare with master
unifiedsplit
README.md+4 book/src/guides/adding_languages.md+7−1
README.md+4
@@ -55,6 +55,10 @@ that sets the variable to the install dir.
5555> NOTE: running via cargo also doesn't require setting explicit `HELIX_RUNTIME` path, it will automatically
5656> detect the `runtime` directory in the project root.
5757
58+In order to use LSP features like auto-complete, you will need to
59+[install the appropriate Language Server](https://github.com/helix-editor/helix/wiki/How-to-install-the-default-language-servers)
60+for a language.
61+
5862[![Packaging status](https://repology.org/badge/vertical-allrepos/helix.svg)](https://repology.org/project/helix/versions)
5963
6064## MacOS
book/src/guides/adding_languages.md+7−1
@@ -16,6 +16,7 @@ injection-regex = "^mylang$"
1616file-types = ["mylang", "myl"]
1717comment-token = "#"
1818indent = { tab-width = 2, unit = " " }
19+language-server = { command = "mylang-lsp", args = ["--stdio"] }
1920```
2021
2122These are the available keys and descriptions for the file.
@@ -32,9 +33,14 @@ These are the available keys and descriptions for the file.
3233| `diagnostic-severity` | Minimal severity of diagnostic for it to be displayed. (Allowed values: `Error`, `Warning`, `Info`, `Hint`) |
3334| `comment-token` | The token to use as a comment-token |
3435| `indent` | The indent to use. Has sub keys `tab-width` and `unit` |
35−| `config` | Language server configuration |
36+| `language-server` | The Language Server to run. Has sub keys `command` and `args` |
37+| `config` | Language Server configuration |
3638| `grammar` | The tree-sitter grammar to use (defaults to the value of `name`) |
3739
40+When adding a Language Server configuration, be sure to update the
41+[Language Server Wiki](https://github.com/helix-editor/helix/wiki/How-to-install-the-default-language-servers)
42+with installation notes.
43+
3844## Grammar configuration
3945
4046If a tree-sitter grammar is available for the language, add a new `grammar`