git.iko.soy/helix
on master help sign in
Improve documentation on Language Server installation (#2037)
78b1600Michael Davis
README.md+4
compare with master
unifiedsplit
@@ -55,6 +55,10 @@ that sets the variable to the install dir.
55> NOTE: running via cargo also doesn't require setting explicit `HELIX_RUNTIME` path, it will automatically
55> NOTE: running via cargo also doesn't require setting explicit `HELIX_RUNTIME` path, it will automatically
56> detect the `runtime` directory in the project root.
56> detect the `runtime` directory in the project root.
57
57
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+
58[![Packaging status](https://repology.org/badge/vertical-allrepos/helix.svg)](https://repology.org/project/helix/versions)
62[![Packaging status](https://repology.org/badge/vertical-allrepos/helix.svg)](https://repology.org/project/helix/versions)
59
63
60## MacOS
64## MacOS
book/src/guides/adding_languages.md+7−1
@@ -16,6 +16,7 @@ injection-regex = "^mylang$"
16file-types = ["mylang", "myl"]
16file-types = ["mylang", "myl"]
17comment-token = "#"
17comment-token = "#"
18indent = { tab-width = 2, unit = " " }
18indent = { tab-width = 2, unit = " " }
19+language-server = { command = "mylang-lsp", args = ["--stdio"] }
19```
20```
20
21
21These are the available keys and descriptions for the file.
22These are the available keys and descriptions for the file.
@@ -32,9 +33,14 @@ These are the available keys and descriptions for the file.
32| `diagnostic-severity` | Minimal severity of diagnostic for it to be displayed. (Allowed values: `Error`, `Warning`, `Info`, `Hint`) |
33| `diagnostic-severity` | Minimal severity of diagnostic for it to be displayed. (Allowed values: `Error`, `Warning`, `Info`, `Hint`) |
33| `comment-token` | The token to use as a comment-token |
34| `comment-token` | The token to use as a comment-token |
34| `indent` | The indent to use. Has sub keys `tab-width` and `unit` |
35| `indent` | The indent to use. Has sub keys `tab-width` and `unit` |
36+| `language-server` | The Language Server to run. Has sub keys `command` and `args` |
35−| `config` | Language server configuration |
37+| `config` | Language Server configuration |
36| `grammar` | The tree-sitter grammar to use (defaults to the value of `name`) |
38| `grammar` | The tree-sitter grammar to use (defaults to the value of `name`) |
37
39
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+
38## Grammar configuration
44## Grammar configuration
39
45
40If a tree-sitter grammar is available for the language, add a new `grammar`
46If a tree-sitter grammar is available for the language, add a new `grammar`