Skip to content

Commit d6f9525

Browse files
authored
update docs (#245)
1 parent db2c84d commit d6f9525

File tree

1 file changed

+26
-1
lines changed

1 file changed

+26
-1
lines changed

README.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,12 @@ nimble build
8080
- `nim.autoRestart` - auto restart once in case of `nimsuggest` crash. Note that
8181
the server won't restart if there weren't any successful calls after the last
8282
restart.
83+
- `nim.workingDirectoryMapping` - configure the working directory for specific projects.
84+
- `nim.checkOnSave` - check the file on save.
85+
- `nim.logNimsuggest` - enable logging for `nimsuggest`.
86+
- `nim.inlayHints` - configure inlay hints.
87+
- `nim.notificationVerbosity` - configure the verbosity of notifications. Can be set to `"none"`, `"error"`, `"warning"`, or `"info"`.
88+
- `nim.formatOnSave` - format the file on save.
8389

8490
``` json
8591
{
@@ -99,14 +105,25 @@ nimble build
99105

100106
`nimlangserver` supports the following LSP features:
101107

108+
- Initialize
102109
- Completions
103110
- Hover
104111
- Goto definition
112+
- Goto declaration
113+
- Goto type definition
105114
- Document symbols
106115
- Find references
107-
- Workspace symbols
116+
- Code actions
117+
- Prepare rename
108118
- Rename symbols
109119
- Inlay hints
120+
- Signature help
121+
- Document formatting
122+
- Execute command
123+
- Workspace symbols
124+
- Document highlight
125+
- Shutdown
126+
- Exit
110127

111128
You can install `nimlangserver` using the instructions for your text editor below:
112129

@@ -185,6 +202,14 @@ Install the `vscode-nim` extension from [here](https://github.com/nim-lang/vscod
185202
(add-hook 'nim-mode-hook #'lsp)
186203
```
187204

205+
## Transport
206+
207+
`nimlangserver` supports two transport modes:
208+
- stdio
209+
- socket
210+
211+
To use socket mode, start `nimlangserver` with the `--socket` flag. You can set the port using the `--port` flag. If you don't specify the port, `nimlangserver` will automatically find an open port and print it in the console.
212+
188213
## Related Projects
189214

190215
- [nimlsp](https://github.com/PMunch/nimlsp)

0 commit comments

Comments
 (0)