Skip to content

Commit 3068332

Browse files
authored
Update README.md
1 parent 2aa1b0f commit 3068332

File tree

1 file changed

+16
-15
lines changed

1 file changed

+16
-15
lines changed

README.md

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -71,21 +71,7 @@ nimble build
7171

7272
## Configuration Options
7373

74-
- `nim.projectMapping` - configure how `nimsuggest` should be started. Here it is sample configuration for `VScode`. We don't want `nimlangserver` to start `nimsuggest` for each file and this configuration will allow configuring pair `projectFile`/`fileRegex` so when one of the regexp in the list matches current file
75-
then `nimls` will use `root` to start `nimsuggest`. In case there are no matches `nimlangserver` will try to guess the most suitable project root.
76-
- `nim.timeout` - the request timeout in ms after which `nimlangserver` will restart the language server. If not specified the default is 2 minutes.
77-
- `nim.nimsuggestPath` - the path to the `nimsuggest`. The default is `"nimsuggest"`.
78-
- `nim.autoCheckFile` - check the file on the fly
79-
- `nim.autoCheckProject` - check the project after saving the file
80-
- `nim.autoRestart` - auto restart once in case of `nimsuggest` crash. Note that
81-
the server won't restart if there weren't any successful calls after the last
82-
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.
74+
- `nim.projectMapping` - configure how `nimsuggest` should be started. Here it is sample configuration for `VScode`. We don't want `nimlangserver` to start `nimsuggest` for each file and this configuration will allow configuring pair `projectFile`/`fileRegex` so when one of the regexp in the list matches current file then `nimls` will use `root` to start `nimsuggest`. In case there are no matches `nimlangserver` will try to guess the most suitable project root.
8975

9076
``` json
9177
{
@@ -100,6 +86,21 @@ nimble build
10086
}]
10187
}
10288
```
89+
Note when in a nimble project, `nimble` will drive the entry points for `nimsuggest`.
90+
91+
- `nim.timeout` - the request timeout in ms after which `nimlangserver` will restart the language server. If not specified the default is 2 minutes.
92+
- `nim.nimsuggestPath` - the path to the `nimsuggest`. The default is `"nimsuggest"`.
93+
- `nim.autoCheckFile` - check the file on the fly
94+
- `nim.autoCheckProject` - check the project after saving the file
95+
- `nim.autoRestart` - auto restart once in case of `nimsuggest` crash. Note that
96+
the server won't restart if there weren't any successful calls after the last
97+
restart.
98+
- `nim.workingDirectoryMapping` - configure the working directory for specific projects.
99+
- `nim.checkOnSave` - check the file on save.
100+
- `nim.logNimsuggest` - enable logging for `nimsuggest`.
101+
- `nim.inlayHints` - configure inlay hints.
102+
- `nim.notificationVerbosity` - configure the verbosity of notifications. Can be set to `"none"`, `"error"`, `"warning"`, or `"info"`.
103+
- `nim.formatOnSave` - format the file on save.
103104

104105
## Features
105106

0 commit comments

Comments
 (0)