Skip to content

Commit d468855

Browse files
committed
Clarify lang-server support
1 parent 7033bdf commit d468855

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

CONTRIBUTING.md

-4
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,6 @@
22

33
Thanks for your interest. Below is an informal spec of how the plugin's server communicates with the actual compiler. If you're a ReScript editor plugin implementor, you should probably read this to understand the various important nuances and copy it.
44

5-
## Other Editors With Language-Server Support
6-
7-
This repo happens to also contain a language-server usable by other editors. If you'd like to use this language-server with e.g. Atom, for now, you have to clone the repo and run `npm run compile`. The language server will be at `server/out/server.js`. Wire that into your editor.
8-
95
## Repo Structure
106

117
```

README.md

+7-3
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,11 @@ The plugin activates on `.res` and `.resi` files. If you've already got Reason-L
4848
- `try`, `for`, etc.
4949
- Folding, and [custom folding](https://code.visualstudio.com/docs/editor/codebasics#_folding) through `//#region` and `//#endregion`.
5050

51-
### Upcoming Features
51+
## Use with Other Editors
5252

53-
- Formatting of temporary files
54-
- Formatting of files outside of a ReScript project root
53+
This repo also contains a language server that can power other editors. **However, the language server in this project is a pure implementation detail. We don't guarantee its stability for other editors' consumption** apart from Vim and Sublime Text.
54+
55+
Still, if you'd like to use this language-server with other editors:
56+
- Get the release binaries from the Github Releases page.
57+
- Unzip the `.vsix` and get the `server` folder. That's the only folder you need.
58+
- The language server will be at `server/out/server.js`. Call it through node, and optionally pass `--stdio` if your editor doesn't support the default JSONRPC.

0 commit comments

Comments
 (0)