Skip to content

Commit 003c576

Browse files
committed
Improve contributing.md
1 parent 01a8ef7 commit 003c576

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,15 @@ This repo happens to also contain a language-server usable by other editors. If
1111
```
1212
.
1313
├── client // Language Client
14-
── src
15-
└── extension.ts // Language Client entry point
14+
── src
15+
└── extension.ts // Language Client entry point
1616
├── package.json // The extension manifest.
1717
└── server // Language Server
18-
└── src
19-
└── server.ts // Language Server entry point
18+
├── src
19+
│ └── server.ts // Language Server entry point
20+
├── win32
21+
├── linux
22+
└── darwin // these 3 folders contain rescript-editor-support.exe
2023
```
2124

2225
## Run the Project
@@ -52,12 +55,16 @@ For more grammar inspirations, check:
5255

5356
Snippets are also synced from https://github.com/rescript-lang/rescript-sublime. VSCode snippets docs [here](https://code.visualstudio.com/api/references/contribution-points#contributes.snippets).
5457

55-
## Editor Diagnostics
58+
### Autocomplete, Jump To Definition, Type Hint, Etc.
5659

57-
They should be synced in from `lib/bs/.compiler.log` build. Don't take them from other places.
60+
These are taken care of by the binary at [rescript-editor-support](https://github.com/rescript-lang/rescript-editor-support). We just invoke it in `RescriptEditorSupport.ts`.
5861

5962
## Rough Description Of How The Plugin Works
6063

64+
### Editor Diagnostics
65+
66+
They should be synced in from `lib/bs/.compiler.log` build. Don't take them from other places.
67+
6168
### `.compiler.log`
6269

6370
The build output is streamed into `lib/bs/.compiler.log`. Here are its various states, numbered here:

0 commit comments

Comments
 (0)