Skip to content

Commit 82f1d76

Browse files
committed
Update README to explain the file watcher issue
1 parent 01db797 commit 82f1d76

File tree

1 file changed

+22
-2
lines changed

1 file changed

+22
-2
lines changed

README.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,32 @@
11
# rescript-zed
22

3-
ReScript support for [Zed](zed.dev) editor.
3+
ReScript support for [Zed](https://zed.dev) editor.
44

55
This extension plugs in the following projects:
66

77
- [tree-sitter-rescript](https://github.com/rescript-lang/tree-sitter-rescript) parser
88
- [@rescript/language-server](https://github.com/rescript-lang/rescript-vscode) LSP
99

10+
## IMPORTANT
11+
12+
Starting from ReScript language server v1.64.0, the internal file watcher (chokidar) was removed ([PR #1096](https://github.com/rescript-lang/rescript-vscode/pull/1096)). The LSP server now expects the editor to watch for file changes and notify the server via the standard LSP `workspace/didChangeWatchedFiles` mechanism.
13+
14+
**Recommended workaround** Since this is not currently implemented in this extension it is recommended to pin rescript-language-server to 1.62.0, which is the last version that includes the built-in chokidar file watcher:
15+
16+
```json
17+
{
18+
"lsp": {
19+
"rescript-language-server": {
20+
"settings": {
21+
"version": "1.62.0"
22+
}
23+
}
24+
}
25+
}
26+
```
27+
28+
We're tracking this issue in [#12](https://github.com/humaans/rescript-zed/issues/12).
29+
1030
## Settings
1131

1232
```json
@@ -31,7 +51,7 @@ With `version` you can point to a specific npm version of the [@rescript/languag
3151

3252
## Developing
3353

34-
Zed and it's support for extensions is being actively developed. The current workflow that can be used to build this extension locally and install it into Zed is:
54+
Zed and its support for extensions is being actively developed. The current workflow that can be used to build this extension locally and install it into Zed is:
3555

3656
Clone zed and build the `zed-extension` cli:
3757

0 commit comments

Comments
 (0)