Skip to content

Commit c1c5fd7

Browse files
fhammerschmidtcristianoc
authored andcommitted
Document the process of finding the ReScript bin
1 parent c6c30b5 commit c1c5fd7

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,10 @@ You'll find all ReScript specific settings under the scope `rescript.settings`.
9999

100100
If there's no ReScript build running already in the opened project, the extension will prompt you and ask if you want to start a build automatically. You can turn off this automatic prompt via the setting `rescript.settings.askToStartBuild`.
101101

102+
#### How does it find my ReScript binary?
103+
104+
The extension will look for the existence of a `/node_modules/.bin/bsc` file and use its directory as the `binaryPath`. If it does not find it at the project root (which is where the nearest `bsconfig.json` resides), it goes up folders in the filesystem recursively until it either finds it (often the case in monorepos) or hits the top level. If it does not find it, the path can be overwritten with the setting `rescript.settings.binaryPath`.
105+
102106
### Hide generated files
103107

104108
You can configure VSCode to collapse the JavaScript files ReScript generates under its source ReScript file. This will "hide" the generated files in the VSCode file explorer, but still leaving them accessible by expanding the source ReScript file they belong to.

0 commit comments

Comments
 (0)